Class CpeCheckpointImpl
- java.lang.Object
-
- org.apache.uima.resource.metadata.impl.MetaDataObject_impl
-
- org.apache.uima.collection.impl.metadata.cpe.CpeCheckpointImpl
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,CpeCheckpoint
,MetaDataObject
,XMLizable
public class CpeCheckpointImpl extends MetaDataObject_impl implements CpeCheckpoint
- See Also:
- Serialized Form
-
-
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
-
Fields inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
serialContext
-
-
Constructor Summary
Constructors Constructor Description CpeCheckpointImpl()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
buildFromXMLElement(org.w3c.dom.Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions)
Overridden to read Checkpoint attributes.int
getBatch()
int
getBatchSize()
java.lang.String
getFile()
java.lang.String
getFilePath()
Returns file where checkpoint information is storedint
getFrequency()
Returns frequency of checkpoints.java.lang.String
getTime()
protected org.xml.sax.helpers.AttributesImpl
getXMLAttributes()
Overridden to handle Checkpoint attributes.protected XmlizationInfo
getXmlizationInfo()
To be implemented by subclasses to return information describing how to represent this object in XML.boolean
isTimeBased()
Returns true if frequency of checkpoints is time-basedvoid
setBatch(int i)
void
setBatchSize(int aBatchSize)
void
setFile(java.lang.String string)
void
setFilePath(java.lang.String aCheckpointFilePath)
Sets the file where checkpoint information will be storedvoid
setFrequency(int aFrequency, boolean aTimeBased)
Sets frequency of checkpoints.void
setTime(java.lang.String i)
-
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, resolveSettings, 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
-
-
-
-
Method Detail
-
setFilePath
public void setFilePath(java.lang.String aCheckpointFilePath) throws CpeDescriptorException
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
public java.lang.String 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
-
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(org.w3c.dom.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:
MetaDataObject_impl.buildFromXMLElement(org.w3c.dom.Element, org.apache.uima.util.XMLParser, org.apache.uima.util.XMLParser.ParsingOptions)
-
getXMLAttributes
protected org.xml.sax.helpers.AttributesImpl 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:
MetaDataObject_impl.getXMLAttributes()
-
getXmlizationInfo
protected XmlizationInfo 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
public java.lang.String getFile()
- Returns:
- a file
-
getTime
public java.lang.String getTime()
- Returns:
- a time
-
setBatch
public void setBatch(int i)
- Parameters:
i
-
-
setFile
public void setFile(java.lang.String string)
- Parameters:
string
-
-
setTime
public void setTime(java.lang.String i)
- Parameters:
i
-
-
-