Package org.apache.uima.jcas.tcas

Class DocumentAnnotation

java.lang.Object
org.apache.uima.cas.impl.FeatureStructureImpl
org.apache.uima.jcas.cas.TOP
org.apache.uima.jcas.cas.AnnotationBase
org.apache.uima.jcas.tcas.Annotation
org.apache.uima.jcas.tcas.DocumentAnnotation
All Implemented Interfaces:
Cloneable, AnnotationBaseFS, FeatureStructure, AnnotationFS
public class DocumentAnnotation extends Annotation
The JCas class definition for the CAS DocumentAnnotation type. When text CASs are created, one instance of this type is created and made accessible via a call to the JCas.getDocumentAnnotationFs() method. It is also a subtype of Annotation and therefore would appear as one of the annotations that an iterator over all the annotations would return.

  • Field Details

    • typeIndexID

      public static final int typeIndexID

    • type

      public static final int type

  • Constructor Details

    • DocumentAnnotation

      protected DocumentAnnotation()

    • DocumentAnnotation

      public DocumentAnnotation(int addr, TOP_Type type)

    • DocumentAnnotation

      public DocumentAnnotation(JCas jcas)

  • Method Details

    • getTypeIndexID

      public int getTypeIndexID()
      Description copied from class: TOP
      used to obtain reference to the TOP_Type instance
      Overrides:
      getTypeIndexID in class Annotation
      Returns:
      the type array index

    • getLanguage

      public String getLanguage()
      getter for language
      Returns:
      the language

    • setLanguage

      public void setLanguage(String v)
      setter for language
      Parameters:
      v - the language