Class CpeCheckpointImpl
java.lang.Object
org.apache.uima.resource.metadata.impl.MetaDataObject_impl
org.apache.uima.collection.impl.metadata.cpe.CpeCheckpointImpl
- All Implemented Interfaces:
Serializable
,Cloneable
,CpeCheckpoint
,MetaDataObject
,XMLizable
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
MetaDataObject_impl.MetaDataAttr, MetaDataObject_impl.SerialContext, MetaDataObject_impl.Serializer
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
private String
private static final long
private String
private static final XmlizationInfo
Fields inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
serialContext
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
buildFromXMLElement
(Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions) Overridden to read Checkpoint attributes.private int
convert2Number
(Object anObject) int
getBatch()
int
getFile()
Returns file where checkpoint information is storedint
Returns frequency of checkpoints.getTime()
protected AttributesImpl
Overridden to handle Checkpoint attributes.protected XmlizationInfo
To be implemented by subclasses to return information describing how to represent this object in XML.boolean
Returns true if frequency of checkpoints is time-basedvoid
setBatch
(int i) void
setBatchSize
(int aBatchSize) void
void
setFilePath
(String aCheckpointFilePath) Sets the file where checkpoint information will be storedvoid
setFrequency
(int aFrequency, boolean aTimeBased) Sets frequency of checkpoints.void
Methods inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
buildFromXMLElement, clone, equals, getAdditionalAttributes, getAttributeClass, getAttributeValue, getInfoset, getMatchingNode, getPropertyDescriptors, getPropertyXmlInfo, getRelativePathBase, getSerialContext, getSourceUrl, getSourceUrlString, getWrapperClass, hashCode, isModifiable, listAttributes, readArrayPropertyValueFromXMLElement, readMapPropertyFromXml, readPropertyValueFromXMLElement, readUnknownPropertyValueFromXMLElement, setAttributeValue, setInfoset, setSourceUrl, setSourceUrlIfNull, toString, toXML, toXML, toXML, toXML, valueIsNullOrEmptyArray, writeArrayPropertyAsElement, writeMapPropertyToXml, writePropertyAsElement
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.apache.uima.resource.metadata.MetaDataObject
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrl
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
file
-
time
-
batch
private int batch -
XMLIZATION_INFO
-
-
Constructor Details
-
CpeCheckpointImpl
public CpeCheckpointImpl()
-
-
Method Details
-
setFilePath
Description copied from interface:CpeCheckpoint
Sets the file where checkpoint information will be stored- Specified by:
setFilePath
in interfaceCpeCheckpoint
- Parameters:
aCheckpointFilePath
- - checkpoint file path- Throws:
CpeDescriptorException
- tbd
-
getFilePath
Description copied from interface:CpeCheckpoint
Returns file where checkpoint information is stored- Specified by:
getFilePath
in interfaceCpeCheckpoint
- Returns:
- - checkpoint file path
-
setFrequency
public void setFrequency(int aFrequency, boolean aTimeBased) Description copied from interface:CpeCheckpoint
Sets frequency of checkpoints. Currently only time-based checkpointing is supported.- Specified by:
setFrequency
in interfaceCpeCheckpoint
- Parameters:
aFrequency
- - number of millis between checkpointsaTimeBased
- - true if checkpoint is based on time
-
convert2Number
-
getFrequency
public int getFrequency()Description copied from interface:CpeCheckpoint
Returns frequency of checkpoints.- Specified by:
getFrequency
in interfaceCpeCheckpoint
- Returns:
- - number of millis between checkpoints
-
isTimeBased
public boolean isTimeBased()Description copied from interface:CpeCheckpoint
Returns true if frequency of checkpoints is time-based- Specified by:
isTimeBased
in interfaceCpeCheckpoint
- Returns:
- true;
-
setBatchSize
public void setBatchSize(int aBatchSize) - Specified by:
setBatchSize
in interfaceCpeCheckpoint
- Parameters:
aBatchSize
- the size of the batch
-
getBatchSize
public int getBatchSize()- Specified by:
getBatchSize
in interfaceCpeCheckpoint
-
buildFromXMLElement
public void buildFromXMLElement(Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions) throws InvalidXMLException Overridden to read Checkpoint attributes.- Specified by:
buildFromXMLElement
in interfaceXMLizable
- Overrides:
buildFromXMLElement
in classMetaDataObject_impl
- Parameters:
aElement
- the XML element that represents this object.aParser
- a reference to the UIMAXMLParser
. TheXMLParser.buildObject(Element)
method can be used to construct sub-objects.aOptions
- option settings- Throws:
InvalidXMLException
- if the input XML element does not specify a valid object- See Also:
-
getXMLAttributes
Overridden to handle Checkpoint attributes.- Overrides:
getXMLAttributes
in classMetaDataObject_impl
- Returns:
- an object defining the attributes to be written to the XML
- See Also:
-
getXmlizationInfo
Description copied from class:MetaDataObject_impl
To be implemented by subclasses to return information describing how to represent this object in XML.- Specified by:
getXmlizationInfo
in classMetaDataObject_impl
- Returns:
- information defining this object's XML representation
-
getBatch
public int getBatch()- Returns:
- the batch size
-
getFile
- Returns:
- a file
-
getTime
- Returns:
- a time
-
setBatch
public void setBatch(int i) - Parameters:
i
-
-
setFile
- Parameters:
string
-
-
setTime
- Parameters:
i
-
-