Package org.apache.uima.jcas.tcas
Class Annotation
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
- All Implemented Interfaces:
Cloneable
,AnnotationBaseFS
,FeatureStructure
,AnnotationFS
- Direct Known Subclasses:
DocumentAnnotation
,SourceDocumentInformation
the JCas class model for the CAS type uima.cas.Annotation. It defines two integer valued features
indicating the begin and end of the span being annotated. There is also a method to retrieve the
spanned text as a string.
-
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Annotation
(int addr, TOP_Type type) Annotation
(JCas jcas) Annotation
(JCas jcas, int begin, int end) Constructor with begin and end passed as arguments -
Method Summary
Modifier and TypeMethodDescriptionint
getBegin()
Get the start position of the annotation as character offset into the text.Get the text covered by an annotation as a string.int
getEnd()
Get the end position of the annotation as character offset into the text.int
getStart()
Deprecated.int
used to obtain reference to the TOP_Type instancevoid
setBegin
(int v) void
setEnd
(int v) 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
-
Annotation
protected Annotation() -
Annotation
-
Annotation
-
Annotation
Constructor with begin and end passed as arguments- Parameters:
jcas
- JCasbegin
- begin offsetend
- end offset
-
-
Method Details
-
getTypeIndexID
public int getTypeIndexID()Description copied from class:TOP
used to obtain reference to the TOP_Type instance- Overrides:
getTypeIndexID
in classAnnotationBase
- Returns:
- the type array index
-
getBegin
public int getBegin()Description copied from interface:AnnotationFS
Get the start position of the annotation as character offset into the text. The smallest possible start position is0
, the offset of the first character in the text.- Specified by:
getBegin
in interfaceAnnotationFS
- Returns:
- The start position.
-
setBegin
public void setBegin(int v) -
getEnd
public int getEnd()Description copied from interface:AnnotationFS
Get the end position of the annotation as character offset into the text. The end position points at the first character after the annotation, such that(getEnd()-getBegin()) == getCoveredText().length()
.- Specified by:
getEnd
in interfaceAnnotationFS
- Returns:
- The end position.
-
setEnd
public void setEnd(int v) -
getCoveredText
Description copied from interface:AnnotationFS
Get the text covered by an annotation as a string. IfdocText
is your document text andannot
an annotation, thenannot.getCoveredText().equals(docText.substring(annot.getBegin(), annot.getEnd()))
.- Specified by:
getCoveredText
in interfaceAnnotationFS
- Returns:
- String
- See Also:
-
getStart
Deprecated.- Returns:
- the Annotation "begin" feature value
- See Also:
-