Package org.apache.uima.cas

Interface Marker

All Known Implementing Classes:
MarkerImpl
public interface Marker
An object obtained from the CAS that is used to query when FSs were created or modified with respect to the marker.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isModified(FeatureStructure fs)
    Test if a FeatureStructure in a CAS represented by this Marker existed before the mark was set, and has been modified.
    boolean
    isNew(FeatureStructure fs)
     
    boolean
    isValid()
    A Marker becomes invalid when the CAS from which it was obtained is reset.

  • Method Details

    • isNew

      boolean isNew(FeatureStructure fs)
      Parameters:
      fs - -
      Returns:
      true if a FeatureStructure was created after the mark represented by this Marker object.

    • isModified

      boolean isModified(FeatureStructure fs)
      Test if a FeatureStructure in a CAS represented by this Marker existed before the mark was set, and has been modified. isModified(fs) == true implies that isNew(fs) == false.
      Parameters:
      fs - -
      Returns:
      true if a FeatureStructure that existed prior to the mark being set has been modified

    • isValid

      boolean isValid()
      A Marker becomes invalid when the CAS from which it was obtained is reset.
      Returns:
      true if the Marker is still valid.