Package org.apache.uima.collection.impl.cpm

Class CheckpointConfig

  • public class CheckpointConfig
extends java.lang.Object
    Object containing checkpoint configuration.

    • Constructor Summary

      Constructors 
      Constructor Description
      CheckpointConfig​(java.lang.String aChpFile, java.lang.String aFrequency)
      Initilizes instance with a file where the checkpoint will be stored and checkpoint frequency.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getCheckpointFile()
      Returns the path to a file containing checkpoint
      long getFrequency()
      Returns checkpoint frequency
      boolean isCountBased()
      Returns true if frequency is count based
      boolean isMillis()
      Returns checkpoint frequency resolution in millis
      boolean isMinutes()
      Returns checkpoint frequency resolution in minutes
      boolean isSeconds()
      Retusn checkpoint frequency in seconds
      boolean isTimeBased()
      Returns true if the checkpoint frequency is in terms of time

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • CheckpointConfig

        public CheckpointConfig​(java.lang.String aChpFile,
                        java.lang.String aFrequency)
        Initilizes instance with a file where the checkpoint will be stored and checkpoint frequency.
        Parameters:
        aChpFile - - path to the checkpoint file
        aFrequency - - frequency of checkpoints

    • Method Detail

      • isCountBased

        public boolean isCountBased()
        Returns true if frequency is count based
        Returns:
        - true if count based frequency

      • getFrequency

        public long getFrequency()
        Returns checkpoint frequency
        Returns:
        - frequency of checkpoints

      • isMillis

        public boolean isMillis()
        Returns checkpoint frequency resolution in millis
        Returns:
        - frequency in millis

      • isMinutes

        public boolean isMinutes()
        Returns checkpoint frequency resolution in minutes
        Returns:
        - frequency in minutes

      • isSeconds

        public boolean isSeconds()
        Retusn checkpoint frequency in seconds
        Returns:
        - frequency in seconds

      • isTimeBased

        public boolean isTimeBased()
        Returns true if the checkpoint frequency is in terms of time
        Returns:
        - true if time based frequency

      • getCheckpointFile

        public java.lang.String getCheckpointFile()
        Returns the path to a file containing checkpoint
        Returns:
        - file path