Class CpeCheckpointImpl

Method Details

• setFilePath

  public void setFilePath(String aCheckpointFilePath) throws CpeDescriptorException

  Description copied from interface: CpeCheckpoint

  Sets the file where checkpoint information will be stored

  Specified by:

  setFilePath in interface CpeCheckpoint

  Parameters:

  aCheckpointFilePath - - checkpoint file path

  Throws:

  CpeDescriptorException - tbd

• getFilePath

  public String getFilePath()

  Description copied from interface: CpeCheckpoint

  Returns file where checkpoint information is stored

  Specified by:

  getFilePath in interface CpeCheckpoint

  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 interface CpeCheckpoint

  Parameters:

  aFrequency - - number of millis between checkpoints

  aTimeBased - - true if checkpoint is based on time

• getFrequency

  public int getFrequency()

  Description copied from interface: CpeCheckpoint

  Returns frequency of checkpoints.

  Specified by:

  getFrequency in interface CpeCheckpoint

  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 interface CpeCheckpoint

  Returns:

  true;

• setBatchSize

  public void setBatchSize(int aBatchSize)

  Specified by:

  setBatchSize in interface CpeCheckpoint

  Parameters:

  aBatchSize - the size of the batch

• getBatchSize

  public int getBatchSize()

  Specified by:

  getBatchSize in interface CpeCheckpoint

• buildFromXMLElement

  public void buildFromXMLElement(Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions) throws InvalidXMLException

  Overridden to read Checkpoint attributes.

  Specified by:

  buildFromXMLElement in interface XMLizable

  Overrides:

  buildFromXMLElement in class MetaDataObject_impl

  Parameters:

  aElement - the XML element that represents this object.

  aParser - a reference to the UIMA XMLParser. The XMLParser.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 AttributesImpl getXMLAttributes()

  Overridden to handle Checkpoint attributes.

  Overrides:

  getXMLAttributes in class MetaDataObject_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 class MetaDataObject_impl

  Returns:

  information defining this object's XML representation

• getBatch

  public int getBatch()

  Returns:

  the batch size

• getFile

  public String getFile()

  Returns:

  a file

• getTime

  public String getTime()

  Returns:

  a time

• setBatch

  public void setBatch(int i)

  Parameters:

  i -

• setFile

  public void setFile(String string)

  Parameters:

  string -

• setTime

  public void setTime(String i)

  Parameters:

  i -