Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.uima.cas.text
Interface AnnotationFS

All Superinterfaces:
  AnnotationBaseFS, FeatureStructure

All Known Implementing Classes:
  Annotation, DocumentAnnotation, SourceDocumentInformation

    public interface AnnotationFS

extends AnnotationBaseFS

Interface for Annotation Feature Structures.

Method Summary
`int` | `getBegin()` Get the start position of the annotation as character offset into the text.
`String` | `getCoveredText()` 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.

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`

Method Detail

### getBegin

    int getBegin()

  Get the start position of the annotation as character offset into the text. The smallest possible start position is `0`, the offset of the first character in the text.

  Returns:
    The start position.

### getEnd

    int getEnd()

  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()`.

  Returns:
    The end position.

### getCoveredText

    String getCoveredText()

  Get the text covered by an annotation as a string. If `docText` is your document text and `annot` an annotation, then `annot.getCoveredText().equals(docText.substring(annot.getBegin(), annot.getEnd()))`.

  Returns:
    String

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2008 The Apache Software Foundation. All Rights Reserved.