Interface CpeCheckpoint
- All Superinterfaces:
Cloneable,MetaDataObject,Serializable,XMLizable
An object that holds configuration that is part of the CPE descriptor. It provides the means of
configuring CPE checkpoint. The checkpoint contains a name of the file where the recovery
information will be stored and a frequency of checkpoints.
-
Method Summary
Modifier and TypeMethodDescriptionintReturns file where checkpoint information is storedintReturns frequency of checkpoints.booleanReturns true if frequency of checkpoints is time-basedvoidsetBatchSize(int aBatchSize) voidsetFilePath(String aCheckpointFilePath) Sets the file where checkpoint information will be storedvoidsetFrequency(int aFrequency, boolean aTimeBased) Sets frequency of checkpoints.Methods inherited from interface org.apache.uima.resource.metadata.MetaDataObject
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrlMethods inherited from interface org.apache.uima.util.XMLizable
buildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXML
-
Method Details
-
setFilePath
Sets the file where checkpoint information will be stored- Parameters:
aCheckpointFilePath- - checkpoint file path- Throws:
CpeDescriptorException- tbd
-
getFilePath
String getFilePath()Returns file where checkpoint information is stored- Returns:
- - checkpoint file path
-
setFrequency
void setFrequency(int aFrequency, boolean aTimeBased) Sets frequency of checkpoints. Currently only time-based checkpointing is supported.- Parameters:
aFrequency- - number of millis between checkpointsaTimeBased- - true if checkpoint is based on time
-
getFrequency
int getFrequency()Returns frequency of checkpoints.- Returns:
- - number of millis between checkpoints
-
isTimeBased
boolean isTimeBased()Returns true if frequency of checkpoints is time-based- Returns:
- true;
-
setBatchSize
void setBatchSize(int aBatchSize) - Parameters:
aBatchSize- the size of the batch
-
getBatchSize
int getBatchSize()
-