Uses of Interface
org.apache.uima.cas.text.AnnotationFS

Packages that use AnnotationFS

Package	Description
org.apache.uima.cas	Common Analysis System(CAS) Interfaces
org.apache.uima.cas.impl	Implementation and Low-Level API for the CAS Interfaces.
org.apache.uima.cas.text	Text Common Annotation System (TCAS) Interfaces.
org.apache.uima.examples
org.apache.uima.jcas.tcas
org.apache.uima.tools.viewer

Uses of AnnotationFS in org.apache.uima.cas

Methods in org.apache.uima.cas with type parameters of type AnnotationFS

Modifier and Type	Method	Description
<T extends AnnotationFS> AnnotationFS	CAS.createAnnotation(Type type, int begin, int end)	Create a new annotation.
<T extends AnnotationFS> AnnotationIndex<T>	CAS.getAnnotationIndex()	Get the standard annotation index.
default <T extends AnnotationFS> AnnotationIndex<T>	CAS.getAnnotationIndex(java.lang.Class<T> clazz)	Get the standard annotation index restricted to a specific annotation type.
<T extends AnnotationFS> AnnotationIndex<T>	CAS.getAnnotationIndex(Type type)	Get the standard annotation index restricted to a specific annotation type.
<T extends AnnotationFS> T	CAS.getDocumentAnnotation()	Get the Document Annotation.

Methods in org.apache.uima.cas that return AnnotationFS

Modifier and Type	Method	Description
<T extends AnnotationFS> AnnotationFS	CAS.createAnnotation(Type type, int begin, int end)	Create a new annotation.

Methods in org.apache.uima.cas with parameters of type AnnotationFS

Modifier and Type	Method	Description
SelectFSs<T>	SelectFSs.at(AnnotationFS fs)	Subselection - specifies selecting Feature Structures having the same begin and end - influenced by typePriority, positionUsesType, and useAnnotationEquals Requires an Annotation Index.
SelectFSs<T>	SelectFSs.between(AnnotationFS fs1, AnnotationFS fs2)	Subselection - specifies selecting Feature Structures which lie between two annotations.
SelectFSs<T>	SelectFSs.coveredBy(AnnotationFS fs)	Subselection - specifies selecting Feature Structures starting (and maybe ending) within a bounding Feature Structure - influenced by typePriority, positionUsesType, useAnnotationEquals, includeAnnotationsWithEndBeyondBounds Requires an Annotation Index.
SelectFSs<T>	SelectFSs.covering(AnnotationFS fs)	Subselection - specifies selecting Feature Structures starting before or equal to bounding Feature Structure and ending at or beyond the bounding Feature Structure - influenced by typePriority, positionUsesType, useAnnotationEquals Requires an Annotation Index.

Uses of AnnotationFS in org.apache.uima.cas.impl

Classes in org.apache.uima.cas.impl with type parameters of type AnnotationFS

Modifier and Type	Class	Description
class	AnnotationTreeImpl<T extends AnnotationFS>	Implementation of annotation tree.
class	AnnotationTreeNodeImpl<T extends AnnotationFS>
class	FsIndex_annotation<T extends AnnotationFS>	Implementation of annotation indexes.
class	Subiterator<T extends AnnotationFS>	Subiterator implementation.

Subinterfaces of AnnotationFS in org.apache.uima.cas.impl

Modifier and Type	Interface	Description
interface	AnnotationImpl	Deprecated. use Annotation instead

Fields in org.apache.uima.cas.impl declared as AnnotationFS

Modifier and Type	Field	Description
private T	AnnotationTreeNodeImpl.annot
private AnnotationFS	SelectFSs_impl.boundingFs
private AnnotationFS	DebugFSLogicalStructure.UnexpandedFeatureStructures.constrainingFS

Methods in org.apache.uima.cas.impl with type parameters of type AnnotationFS

Modifier and Type	Method	Description
private <T extends AnnotationFS> T	CASImpl.createDocumentAnnotation(int length)
<T extends AnnotationFS> AnnotationIndex<T>	CASImpl.getAnnotationIndex()	The generic spec T extends AnnotationFS (rather than AnnotationFS) allows the method JCasImpl getAnnotationIndex to return Annotation instead of AnnotationFS
<T extends AnnotationFS> AnnotationIndex<T>	CASImpl.getAnnotationIndex(Type type)
(package private) <T extends AnnotationFS> FsIndex_annotation<T>	FSIndexRepositoryImpl.getAnnotationIndex(TypeImpl ti)	returns the annotation index for a type which is Annotation or a subtype of it.
<T extends AnnotationFS> T	CASImpl.getDocumentAnnotation()	Generic issue: The returned document annotation could be either an instance of DocumentAnnotation or a subclass of it, or an instance of Annotation - the Java cover class used for annotations when JCas is not being used.
<T extends AnnotationFS> T	CASImpl.getDocumentAnnotationNoCreate()
(package private) <TT extends AnnotationFS> void	FSIteratorImplBase.moveTo(int begin, int end)	A special version of moveTo for subtypes of AnnotationFS, which moves to a particular begin/end (no type priority).

Methods in org.apache.uima.cas.impl that return types with arguments of type AnnotationFS

Modifier and Type	Method	Description
(package private) static java.util.Comparator<AnnotationFS>	Subiterator.getAnnotationBeginEndComparator(int boundingBegin, int boundingEnd)

Methods in org.apache.uima.cas.impl with parameters of type AnnotationFS

Modifier and Type	Method	Description
SelectFSs<T>	SelectFSs_impl.at(AnnotationFS fs)
SelectFSs_impl<T>	SelectFSs_impl.between(AnnotationFS fs1, AnnotationFS fs2)
SelectFSs_impl<T>	SelectFSs_impl.coveredBy(AnnotationFS fs)	subselection based on boundingFs
SelectFSs_impl<T>	SelectFSs_impl.covering(AnnotationFS fs)
static java.lang.Object	DebugFSLogicalStructure.getDebugLogicalStructure_Features(AnnotationFS fs)
static FeatureStructure[]	DebugFSLogicalStructure.getDebugLogicalStructure_SubAnnotations(AnnotationFS fs)
FSIterator<T>	FsIndex_annotation.subiterator(AnnotationFS annot)
FSIterator<T>	FsIndex_annotation.subiterator(AnnotationFS annot, boolean ambiguous, boolean strict)

Constructors in org.apache.uima.cas.impl with parameters of type AnnotationFS

Constructor	Description
Subiterator(FSIterator<T> it, AnnotationFS boundingAnnot, AnnotationFS originalBoundingAnnotation, boolean ambiguous, boolean strict, Subiterator.BoundsUse boundsUse, boolean isUseTypePriority, boolean isSkipSameBeginEndType, boolean isNonStrictIncludesAnnotationsStartingAtEndPosition, boolean isIncludeZeroWidthAtBegin, boolean isIncludeZeroWidthAtEnd)	Caller is the implementation of AnnotationIndex, FSIndex_annotation.
UnexpandedFeatureStructures(AnnotationFS constrainingFS)

Uses of AnnotationFS in org.apache.uima.cas.text

Classes in org.apache.uima.cas.text with type parameters of type AnnotationFS

Modifier and Type	Interface	Description
interface	AnnotationIndex<T extends AnnotationFS>	An annotation index provides additional iterator functionality that applies only to instances of uima.tcas.Annotation (or its subtypes).
interface	AnnotationTree<T extends AnnotationFS>	Represents an annotation tree.
interface	AnnotationTreeNode<T extends AnnotationFS>	Represents a node in an annotation tree.

Methods in org.apache.uima.cas.text with parameters of type AnnotationFS

Modifier and Type	Method	Description
static boolean	AnnotationPredicates.beginningWith(AnnotationFS aX, int aYBegin, int aYEnd)
static boolean	AnnotationPredicates.beginningWith(AnnotationFS aX, AnnotationFS aY)
static boolean	AnnotationPredicates.colocated(AnnotationFS aX, int aYBegin, int aYEnd)
static boolean	AnnotationPredicates.colocated(AnnotationFS aX, AnnotationFS aY)	X starts and ends at the same position as Y.
default boolean	AnnotationFS.coveredBy(AnnotationFS aOther)
static boolean	AnnotationPredicates.coveredBy(AnnotationFS aX, int aYBegin, int aYEnd)
static boolean	AnnotationPredicates.coveredBy(AnnotationFS aX, AnnotationFS aY)	Y is starting before or at the same position as A and ends after or at the same position as X.
default boolean	AnnotationFS.covering(AnnotationFS aOther)
static boolean	AnnotationPredicates.covering(AnnotationFS aX, int aYBegin, int aYEnd)
static boolean	AnnotationPredicates.covering(AnnotationFS aX, AnnotationFS aY)	X is starting before or at the same position as Y and ends after or at the same position as Y.
static boolean	AnnotationPredicates.endingWith(AnnotationFS aX, int aYBegin, int aYEnd)
static boolean	AnnotationPredicates.endingWith(AnnotationFS aX, AnnotationFS aY)
default boolean	AnnotationFS.following(AnnotationFS aOther)
static boolean	AnnotationPredicates.following(AnnotationFS aX, int aYBegin, int aYEnd)
static boolean	AnnotationPredicates.following(AnnotationFS aX, AnnotationFS aY)	X starts at or after the position that Y ends.
default boolean	AnnotationFS.overlapping(AnnotationFS aOther)
static boolean	AnnotationPredicates.overlapping(AnnotationFS aX, int aYBegin, int aYEnd)
static boolean	AnnotationPredicates.overlapping(AnnotationFS aX, AnnotationFS aY)	The intersection of the spans X and Y is non-empty.
default boolean	AnnotationFS.overlappingAtBegin(AnnotationFS aOther)
static boolean	AnnotationPredicates.overlappingAtBegin(AnnotationFS aX, int aYBegin, int aYEnd)
static boolean	AnnotationPredicates.overlappingAtBegin(AnnotationFS aX, AnnotationFS aY)	X is starting before or at the same position as Y and ends before Y ends.
default boolean	AnnotationFS.overlappingAtEnd(AnnotationFS aOther)
static boolean	AnnotationPredicates.overlappingAtEnd(AnnotationFS aX, int aYBegin, int aYEnd)
static boolean	AnnotationPredicates.overlappingAtEnd(AnnotationFS aX, AnnotationFS aY)	X is starting after Y starts and ends after or at the same position as Y.
default boolean	AnnotationFS.preceding(AnnotationFS aOther)
static boolean	AnnotationPredicates.preceding(AnnotationFS aX, int aYBegin, int aYEnd)
static boolean	AnnotationPredicates.preceding(AnnotationFS aX, AnnotationFS aY)	X ends before or at the position that Y starts.
FSIterator<T>	AnnotationIndex.subiterator(AnnotationFS annot)	Return a subiterator whose bounds are defined by the input annotation.
FSIterator<T>	AnnotationIndex.subiterator(AnnotationFS annot, boolean ambiguous, boolean strict)	Return a subiterator whose bounds are defined by the annot.

Uses of AnnotationFS in org.apache.uima.examples

Classes in org.apache.uima.examples that implement AnnotationFS

Modifier and Type	Class	Description
class	SourceDocumentInformation	Stores detailed information about the original source document from which the current CAS was initialized.

Uses of AnnotationFS in org.apache.uima.jcas.tcas

Classes in org.apache.uima.jcas.tcas that implement AnnotationFS

Modifier and Type	Class	Description
class	Annotation	the JCas class model for the CAS type uima.cas.Annotation.
class	DocumentAnnotation	The JCas class definition for the CAS DocumentAnnotation type.

Uses of AnnotationFS in org.apache.uima.tools.viewer

Fields in org.apache.uima.tools.viewer declared as AnnotationFS

Modifier and Type	Field	Description
private AnnotationFS	CasTreeViewer.AnnotationTreeNodeObject.mAnnotation	The m annotation.

Methods in org.apache.uima.tools.viewer that return AnnotationFS

Modifier and Type	Method	Description
AnnotationFS	CasTreeViewer.AnnotationTreeNodeObject.getAnnotation()	Gets the annotation.

Methods in org.apache.uima.tools.viewer with parameters of type AnnotationFS

Modifier and Type	Method	Description
protected void	CasAnnotationViewer.addAnnotationToTree(AnnotationFS aAnnotation)	Adds an annotation to the selected annotations tree.
private void	CasAnnotationViewer.processOneAnnotationInAnnotationView(javax.swing.text.StyledDocument doc, AnnotationFS annotation)	Process one annotation in annotation view.
private void	CasTreeViewer.refreshAnnotationData(AnnotationFS aAnnotation)	Called when the user selects a new node in the JTree.

Constructors in org.apache.uima.tools.viewer with parameters of type AnnotationFS

Constructor	Description
AnnotationTreeNodeObject(AnnotationFS aAnnotation)	Instantiates a new annotation tree node object.