Package org.apache.uima.jcas.tcas

Class DocumentAnnotation

java.lang.Object

org.apache.uima.cas.impl.FeatureStructureImplC

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, AnnotationBaseImpl, AnnotationImpl, FeatureStructureImpl, 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.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.uima.cas.impl.FeatureStructureImplC

FeatureStructureImplC.PrintReferences

Field Summary

Fields

Modifier and Type	Field	Description
static final String	_FeatName_language
static final String	_TypeName
static final int	type
static final int	typeIndexID

Fields inherited from class org.apache.uima.jcas.tcas.Annotation

_FeatName_begin, _FeatName_end

Fields inherited from class org.apache.uima.jcas.cas.AnnotationBase

_FeatName_sofa

Fields inherited from class org.apache.uima.jcas.cas.TOP

_singleton

Fields inherited from class org.apache.uima.cas.impl.FeatureStructureImplC

_casView, _id, DISABLE_RUNTIME_FEATURE_VALIDATION, DISABLE_RUNTIME_FEATURE_VALUE_VALIDATION, IS_ENABLE_RUNTIME_FEATURE_VALIDATION, IS_ENABLE_RUNTIME_FEATURE_VALUE_VALIDATION, IS_V2_PRETTY_PRINT, V2_PRETTY_PRINT

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DocumentAnnotation()
	DocumentAnnotation(TypeImpl t, CASImpl c)	used by generator Make a new AnnotationBase
	DocumentAnnotation(JCas jcas)

Method Summary

Modifier and Type	Method	Description
String	getLanguage()	getter for language
int	getTypeIndexID()
void	setLanguage(String v)	setter for language

Methods inherited from class org.apache.uima.jcas.tcas.Annotation

_createMarkerAnnotation, compareAnnotation, compareAnnotation, compareAnnotationWithId, compareAnnotationWithId, getBegin, getCoveredText, getEnd, getStart, setBegin, setEnd, trim

Methods inherited from class org.apache.uima.jcas.cas.AnnotationBase

getSofa, getView, setFeatureValue

Methods inherited from class org.apache.uima.jcas.cas.TOP

_createJCasHashMapReserve, _createSearchKey

Methods inherited from class org.apache.uima.cas.impl.FeatureStructureImplC

_copyIntAndRefArraysEqTypesFrom, _copyIntAndRefArraysFrom, _copyIntArrayEqTypesFrom, _getBooleanValueNc, _getBooleanValueNc, _getByteValueNc, _getByteValueNc, _getDoubleValueNc, _getDoubleValueNc, _getFeatFromAdjOffset, _getFeatureValueNc, _getFeatureValueNc, _getFloatValueNc, _getFloatValueNc, _getIntLikeValue, _getIntValueNc, _getIntValueNc, _getLongValueNc, _getLongValueNc, _getRefValueCommon, _getShortValueNc, _getShortValueNc, _getStringValueNc, _getStringValueNc, _getTypeCode, _getTypeImpl, _getView, _id, _inSetSortedIndex, _isJCasHashMapReserve, _isPearTrampoline, _maybeGetBaseForPearFs, _maybeGetBaseForPearFs, _maybeGetPearFs, _maybeGetPearFs, _resetInSetSortedIndex, _setBooleanValueNcNj, _setBooleanValueNcNj, _setBooleanValueNfc, _setByteValueNcNj, _setByteValueNcNj, _setByteValueNfc, _setDoubleValueNcNj, _setDoubleValueNcNj, _setDoubleValueNfc, _setFeatureValueNcNj, _setFeatureValueNcNj, _setFeatureValueNcWj, _setFloatValueNcNj, _setFloatValueNcNj, _setFloatValueNfc, _setInSetSortedIndexed, _setIntLikeValue, _setIntLikeValueNcNj, _setIntValueCJ, _setIntValueNcNj, _setIntValueNcNj, _setIntValueNfc, _setIntValueNfcCJ, _setJCasHashMapReserve, _setLongValueCJ, _setLongValueNcNj, _setLongValueNcNj, _setLongValueNfc, _setLongValueNfcCJ, _setPearTrampoline, _setRefValueCJ, _setRefValueCommon, _setRefValueCommonWj, _setRefValueNfcCJ, _setShortValueNcNj, _setShortValueNcNj, _setShortValueNfc, _setStringValueNcNj, _setStringValueNcWj, _setStringValueNfc, _setTypeImpl, addStringOrPrimitive, addToIndexes, addToIndexes, addToIndexes, clone, compare, equals, getAddress, getBooleanValue, getByteValue, getCAS, getCASImpl, getDoubleValue, getFeatureValue, getFeatureValueAsString, getFloatValue, getIntValue, getLongValue, getLowLevelCas, getShortValue, getStringValue, getType, hashCode, prettyPrint, prettyPrint, prettyPrint, prettyPrint, prettyPrint, prettyPrint, prettyPrintShort, removeFromIndexes, removeFromIndexes, removeFromIndexes, setBooleanValue, setByteValue, setDoubleValue, setFeatureValueFromString, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue, toShortString, toString, toString, wrapGetIntCatchException

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.text.AnnotationFS

coveredBy, coveredBy, covering, covering, following, following, overlapping, overlapping, overlappingAtBegin, overlappingAtBegin, overlappingAtEnd, overlappingAtEnd, preceding, preceding, trim

Methods inherited from interface org.apache.uima.cas.FeatureStructure

_getTypeCode, _id, clone, equals, getAddress, getBooleanValue, getByteValue, getCAS, getDoubleValue, getFeatureValue, getFeatureValueAsString, getFloatValue, getIntValue, getJCas, getLongValue, getShortValue, getStringValue, getType, hashCode, setBooleanValue, setByteValue, setDoubleValue, setFeatureValue, setFeatureValueFromString, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue

Methods inherited from interface org.apache.uima.cas.impl.FeatureStructureImpl

prettyPrint, prettyPrint, prettyPrint, prettyPrint, toString

Field Details

_TypeName

public static final String _TypeName

See Also:

• Constant Field Values

_FeatName_language

public static final String _FeatName_language

See Also:

• Constant Field Values

typeIndexID

public static final int typeIndexID

type

public static final int type

Constructor Details

DocumentAnnotation

protected DocumentAnnotation()

DocumentAnnotation

public DocumentAnnotation(JCas jcas)

DocumentAnnotation

public DocumentAnnotation(TypeImpl t,
 CASImpl c)

used by generator Make a new AnnotationBase

Parameters:

c - -

t - -

Method Details

getTypeIndexID

public int getTypeIndexID()

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