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

Class CheckpointConfig

java.lang.Object
org.apache.uima.collection.impl.cpm.CheckpointConfig
public class CheckpointConfig extends Object
Object containing checkpoint configuration.

  • Constructor Details

    • CheckpointConfig

      public CheckpointConfig(String aChpFile, String aFrequency)
      Initializes 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 Details

    • 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 String getCheckpointFile()
      Returns the path to a file containing checkpoint
      Returns:
      - file path