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
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 Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
DocumentAnnotation
(int addr, TOP_Type type) DocumentAnnotation
(JCas jcas) -
Method Summary
Modifier and TypeMethodDescriptiongetter for languageint
used to obtain reference to the TOP_Type instancevoid
setter for languageMethods inherited from class org.apache.uima.jcas.tcas.Annotation
getBegin, getCoveredText, getEnd, getStart, setBegin, setEnd
Methods inherited from class org.apache.uima.jcas.cas.AnnotationBase
getSofa, getView
Methods inherited from class org.apache.uima.jcas.cas.TOP
addToIndexes, addToIndexes, equals, getAddress, getCAS, getCASImpl, getLowLevelCas, hashCode, removeFromIndexes, removeFromIndexes
Methods inherited from class org.apache.uima.cas.impl.FeatureStructureImpl
clone, getavoidcollisionTypeCode, getBooleanValue, getByteValue, getDoubleValue, getFeatureValue, getFeatureValueAsString, getFloatValue, getIntValue, getLongValue, getShortValue, getStringValue, getType, prettyPrint, prettyPrint, prettyPrint, setBooleanValue, setByteValue, setDoubleValue, setFeatureValue, setFeatureValueFromString, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue, toString, toString
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.apache.uima.cas.AnnotationBaseFS
getView
Methods inherited from interface org.apache.uima.cas.FeatureStructure
clone, equals, getBooleanValue, getByteValue, getCAS, getDoubleValue, getFeatureValue, getFeatureValueAsString, getFloatValue, getIntValue, getLongValue, getShortValue, getStringValue, getType, hashCode, setBooleanValue, setByteValue, setDoubleValue, setFeatureValue, setFeatureValueFromString, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue
-
Field Details
-
typeIndexID
public static final int typeIndexID -
type
public static final int type
-
-
Constructor Details
-
DocumentAnnotation
protected DocumentAnnotation() -
DocumentAnnotation
-
DocumentAnnotation
-
-
Method Details
-
getTypeIndexID
public int getTypeIndexID()Description copied from class:TOP
used to obtain reference to the TOP_Type instance- Overrides:
getTypeIndexID
in classAnnotation
- Returns:
- the type array index
-
getLanguage
getter for language- Returns:
- the language
-
setLanguage
setter for language- Parameters:
v
- the language
-