Package org.apache.uima.jcas.tcas
Class Annotation
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
- All Implemented Interfaces:
Cloneable,AnnotationBaseFS,FeatureStructure,AnnotationBaseImpl,AnnotationImpl,FeatureStructureImpl,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.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.uima.cas.impl.FeatureStructureImplC
FeatureStructureImplC.PrintReferences -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final intstatic final intFields inherited from class org.apache.uima.jcas.cas.AnnotationBase
_FeatName_sofaFields inherited from class org.apache.uima.jcas.cas.TOP
_singletonFields 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
ConstructorsModifierConstructorDescriptionprotectedDeprecated.Annotation(TypeImpl t, CASImpl c) used by generator Make a new AnnotationBaseAnnotation(JCas jcas) Annotation(JCas jcas, int begin, int end) Constructor with begin and end passed as arguments -
Method Summary
Modifier and TypeMethodDescriptionstatic Annotation_createMarkerAnnotation(JCas aJCas, int aBegin, int aEnd) For internal use bySelectFSs_implfinal intcompareAnnotation(Annotation other) Compare two annotations, no type orderfinal intcompareAnnotation(Annotation other, LinearTypeOrder lto) Compare two annotations incl type orderfinal intCompare two annotations, with id comparefinal intcompareAnnotationWithId(Annotation other, LinearTypeOrder lto) Compare two annotations, with type order, with id comparefinal intgetBegin()Get the start position of the annotation as character offset into the text.Get the text covered by an annotation as a string.final intgetEnd()Get the end position of the annotation as character offset into the text.intgetStart()Deprecated.intfinal voidsetBegin(int v) Set the start position of the annotation as character offset into the text.final voidsetEnd(int v) Set the end position of the annotation as character offset into the text.voidtrim(IntPredicate aIsTrimChar) Strips leading and trailing characters matching the given predicate by increasing/decreasing the begin/end offsets.Methods inherited from class org.apache.uima.jcas.cas.AnnotationBase
getSofa, getView, setFeatureValueMethods inherited from class org.apache.uima.jcas.cas.TOP
_createJCasHashMapReserve, _createSearchKeyMethods 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, wrapGetIntCatchExceptionMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.uima.cas.AnnotationBaseFS
getViewMethods inherited from interface org.apache.uima.cas.text.AnnotationFS
coveredBy, coveredBy, covering, covering, following, following, overlapping, overlapping, overlappingAtBegin, overlappingAtBegin, overlappingAtEnd, overlappingAtEnd, preceding, preceding, trimMethods 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, setStringValueMethods inherited from interface org.apache.uima.cas.impl.FeatureStructureImpl
prettyPrint, prettyPrint, prettyPrint, prettyPrint, toString
-
Field Details
-
_TypeName
- See Also:
-
_FeatName_begin
- See Also:
-
_FeatName_end
- See Also:
-
typeIndexID
public static final int typeIndexID -
type
public static final int type
-
-
Constructor Details
-
Annotation
Deprecated. -
Annotation
-
Annotation
used by generator Make a new AnnotationBase- Parameters:
c- -t- -
-
Annotation
Constructor with begin and end passed as arguments- Parameters:
jcas- JCasbegin- begin offsetend- end offset
-
-
Method Details
-
getTypeIndexID
public int getTypeIndexID()- Overrides:
getTypeIndexIDin classAnnotationBase- Returns:
- the type array index
-
getBegin
public final int getBegin()Description copied from interface:AnnotationFSGet 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:
getBeginin interfaceAnnotationFS- Returns:
- The start position.
-
setBegin
public final void setBegin(int v) Description copied from interface:AnnotationFSSet 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:
setBeginin interfaceAnnotationFS- Parameters:
v- The start position.
-
getEnd
public final int getEnd()Description copied from interface:AnnotationFSGet 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:
getEndin interfaceAnnotationFS- Returns:
- The end position.
-
setEnd
public final void setEnd(int v) Description copied from interface:AnnotationFSSet 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:
setEndin interfaceAnnotationFS- Parameters:
v- The end position position.
-
getCoveredText
Description copied from interface:AnnotationFSGet the text covered by an annotation as a string. IfdocTextis your document text andannotan annotation, thenannot.getCoveredText().equals(docText.substring(annot.getBegin(), annot.getEnd())).- Specified by:
getCoveredTextin interfaceAnnotationFS- Returns:
- -
- See Also:
-
getStart
Deprecated.UsegetBegin()instead.- Returns:
- the Annotation "begin" feature value
-
compareAnnotation
Compare two annotations, no type order- Parameters:
other- -- Returns:
- -
-
compareAnnotation
Compare two annotations incl type order- Parameters:
other- -lto- -- Returns:
- -
-
compareAnnotationWithId
Compare two annotations, with id compare- Parameters:
other- -- Returns:
- -
-
compareAnnotationWithId
Compare two annotations, with type order, with id compare- Parameters:
other- -lto- -- Returns:
- -
-
trim
Description copied from interface:AnnotationFSStrips leading and trailing characters matching the given predicate by increasing/decreasing the begin/end offsets.- Specified by:
trimin interfaceAnnotationFS- Parameters:
aIsTrimChar- the predicate used to identify whether a given codepoint is whitespace.- See Also:
-
_createMarkerAnnotation
For internal use bySelectFSs_impl
-
getBegin()instead.