| 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.jcas | Interfaces for accessing the JCAS. | 
| org.apache.uima.jcas.cas | JCAS model for built-in CAS types | 
| Modifier and Type | Method and Description | 
|---|---|
| SelectFSs<T> | SelectFSs. allViews()Extend the selection to be over all the CAS views, not just a single view. | 
| SelectFSs<T> | SelectFSs. allViews(boolean allViews)Extend or not extend the selection to be over all the CAS views, not just a single view. | 
| 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. at(int begin,
  int end)Subselection - specifies selecting Feature Structures having the same begin and end Requires an
 Annotation Index. | 
| SelectFSs<T> | SelectFSs. backwards()Specifies that the iteration should run in reverse order from normal. | 
| SelectFSs<T> | SelectFSs. backwards(boolean backwards)Specifies that the iteration should run in the normal or reverse order. | 
| 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. coveredBy(int begin,
         int end)Subselection - specifies selecting Feature Structures starting (and maybe ending) within a
 bounding Feature Structure 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. | 
| SelectFSs<T> | SelectFSs. covering(int begin,
        int end)Subselection - specifies selecting Feature Structures starting before or equal to bounding
 Feature Structure's begin and ending at or beyond the bounding Feature Structure's end Requires
 an Annotation Index. | 
| SelectFSs<T> | SelectFSs. following(Annotation annotation)For AnnotationIndex, position to first Annotation whose begin >= fs.getEnd(); | 
| SelectFSs<T> | SelectFSs. following(Annotation annotation,
         int offset)For AnnotationIndex, position to first Annotation whose begin >= fs.getEnd() and then adjust
 position by the offset | 
| SelectFSs<T> | SelectFSs. following(int position)Select  annotationsthat follow the specified document position (i.e. | 
| SelectFSs<T> | SelectFSs. following(int position,
         int offset)For AnnotationIndex, position to first Annotation whose begin >= position and then adjust
 position by the offset. | 
| SelectFSs<T> | SelectFSs. includeAnnotationsWithEndBeyondBounds()Meaningful only for coveredBy, includes annotations where the end exceeds the bounding
 annotation's end. | 
| SelectFSs<T> | SelectFSs. includeAnnotationsWithEndBeyondBounds(boolean includeAnnotationsWithEndBeyondBounds)Meaningful only for coveredBy, includes or filters out annotations where the end exceeds the
 bounding annotation's end. | 
| SelectFSs<T> | SelectFSs. limit(int n)Limits the number of Feature Structures returned by this select | 
| SelectFSs<T> | SelectFSs. nonOverlapping()Meaningful only for Annotation Indexes, specifies that iteration should return only annotations
 which don't overlap with each other. | 
| SelectFSs<T> | SelectFSs. nonOverlapping(boolean nonOverlapping)Meaningful only for Annotation Indexes, specifies that iteration should or should not return
 only annotations which don't overlap with each other. | 
| SelectFSs<T> | SelectFSs. nullOK()Applies to the various argument forms of the get and single methods. | 
| SelectFSs<T> | SelectFSs. nullOK(boolean nullOk)Applies to the various argument forms of the get and single methods. | 
| SelectFSs<T> | SelectFSs. orderNotNeeded()Specifies that order is not required while iterating over an otherwise ordered index. | 
| SelectFSs<T> | SelectFSs. orderNotNeeded(boolean unordered)Specifies that order is or is not required while iterating over an otherwise ordered index. | 
| SelectFSs<T> | SelectFSs. preceding(Annotation annotation)For AnnotationIndex, set up a selection that will go from the beginning to the first Annotation
 to the left of the specified position, whose end <= fs.getBegin(). | 
| SelectFSs<T> | SelectFSs. preceding(Annotation annotation,
         int offset)For AnnotationIndex, set up a selection that will go from the beginning to the first Annotation
 to the left of the specified position, ending at the last Annotation whose end <=
 fs.getBegin(), after adjusting by offset items. | 
| SelectFSs<T> | SelectFSs. preceding(int position)Select  annotationsthat precede the specified document position (i.e. | 
| SelectFSs<T> | SelectFSs. preceding(int position,
         int offset)For AnnotationIndex, set up a selection that will go from the beginning to the first Annotation
 to the left of the specified position, ending at the last Annotation whose end <= position. | 
| SelectFSs<T> | FSIndex. select() | 
| default <T extends TOP> | CAS. select() | 
| <N extends T> | FSIndex. select(Class<N> clazz) | 
| default <T extends TOP> | CAS. select(Class<T> clazz) | 
| static <U extends FeatureStructure> | SelectFSs. select(FSIndex<U> index)Use this static method to capture the generic argument | 
| <N extends T> | FSIndex. select(int jcasType) | 
| default <T extends TOP> | CAS. select(int jcasType) | 
| <N extends T> | FSIndex. select(String fullyQualifiedTypeName) | 
| default <T extends TOP> | CAS. select(String fullyQualifiedTypeName) | 
| <N extends T> | FSIndex. select(Type type) | 
| default <T extends TOP> | CAS. select(Type type) | 
| SelectFSs<T> | SelectFSs. shifted(int shiftAmount)Starting Position specification - Shifts the normal start position by the shiftAmount, which
 may be negative. | 
| SelectFSs<T> | SelectFSs. skipWhenSameBeginEndType()Meaningful only for coveredBy and covering: if true, then returned annotations are compared
 equal to the bounding annotation, and if equal, they are skipped. | 
| SelectFSs<T> | SelectFSs. startAt(FeatureStructure fs)Starting Position specification - For ordered sources, specifies which FS to start at. | 
| SelectFSs<T> | SelectFSs. startAt(FeatureStructure fs,
       int shift)Starting Position specification - A combination of startAt followed by a shift
 
 Requires an ordered index not necessarily AnnotationIndex, not necessarily sorted This versions
 avoids a runtime cast check. | 
| SelectFSs<T> | SelectFSs. startAt(int begin)Starting Position specification - For Annotation Indexes, specifies which FS to start at. | 
| SelectFSs<T> | SelectFSs. startAt(int begin,
       int end)Starting Position specification - For Annotation Indexes, specifies which FS to start at. | 
| SelectFSs<T> | SelectFSs. startAt(int begin,
       int end,
       int shift)Starting Position specification - A combination of startAt followed by a shift Requires an
 Annotation Index. | 
| SelectFSs<T> | SelectFSs. startAt(TOP fs)Starting Position specification - For ordered sources, specifies which FS to start at. | 
| SelectFSs<T> | SelectFSs. startAt(TOP fs,
       int shift)Starting Position specification - A combination of startAt followed by a shift
 
 Requires an ordered index not necessarily AnnotationIndex, not necessarily sorted | 
| SelectFSs<T> | SelectFSs. typePriority()Specify that type priority should be included when comparing two Feature Structures when moving
 to the leftmost among otherwise equal items for moveTo(fs). | 
| SelectFSs<T> | SelectFSs. typePriority(boolean typePriority)Specify that type priority should or should not be included when comparing two Feature
 Structures while positioning an iterator | 
| SelectFSs<T> | SelectFSs. useAnnotationEquals(boolean useAnnotationEquals)Meaningful only for coveredBy: if true, then returned annotations are compared to the bounding
 annotation using the specified kind of equal comparison, and if equal, they are skipped. | 
| Modifier and Type | Class and Description | 
|---|---|
| class  | SelectFSs_impl<T extends FeatureStructure>Collection of builder style methods to specify selection of FSs from indexes
 shift handled in this routine
 Comment codes:
   AI = implies AnnotationIndex
 
 Iterator varieties and impl
 
   bounded?  type      order not unambig? strict? skipEq    
             Priority? Needed? 
     no
   coveredBy
   covering
   sameas
 
   for not-bounded, 
     - ignore strict and skipEq
       -- except: preceding implies skipping annotations whose end > positioning begin
     - order-not-needed only applies if iicp size > 1
     - unambig ==> use Subiterator
         -- subiterator wraps: according to typePriority and order-not-needed
     - no Type Priority - need to pass in as arg to fsIterator_multiple_indexes
        == if no type priority, need to prevent rattling off the == type while compare is equal
        == affects both FsIterator_aggregation_common and FsIterator_subtypes_ordered
   for 3 other boundings:
     - use subiterator, pass in strict and skipeq
 
   finish this javadoc comment edit
   T extends FeatureStructure, not TOP, because of ref from FSIndex 
 which uses FeatureStructure for backwards compatibility | 
| Modifier and Type | Method and Description | 
|---|---|
| SelectFSs<T> | SelectFSs_impl. at(AnnotationFS fs) | 
| SelectFSs<T> | SelectFSs_impl. at(int begin,
  int end) | 
| SelectFSs<T> | SelectFSs_impl. following(Annotation fs) | 
| SelectFSs<T> | SelectFSs_impl. following(Annotation fs,
         int offset) | 
| SelectFSs<T> | SelectFSs_impl. following(int position) | 
| SelectFSs<T> | SelectFSs_impl. following(int position,
         int offset) | 
| SelectFSs<T> | SelectFSs_impl. preceding(Annotation fs) | 
| SelectFSs<T> | SelectFSs_impl. preceding(Annotation annotation,
         int offset) | 
| SelectFSs<T> | SelectFSs_impl. preceding(int position) | 
| SelectFSs<T> | SelectFSs_impl. preceding(int position,
         int offset) | 
| default SelectFSs<T> | LowLevelIndex. select() | 
| default <N extends T> | LowLevelIndex. select(Class<N> clazz) | 
| default <N extends T> | LowLevelIndex. select(int jcasType) | 
| default <N extends T> | LowLevelIndex. select(String fullyQualifiedTypeName) | 
| default <N extends T> | LowLevelIndex. select(Type type) | 
| SelectFSs<T> | SelectFSs_impl. skipWhenSameBeginEndType()boolean operations | 
| SelectFSs<T> | SelectFSs_impl. typePriority() | 
| SelectFSs<T> | SelectFSs_impl. typePriority(boolean aTypePriority) | 
| SelectFSs<T> | SelectFSs_impl. useAnnotationEquals(boolean useAnnotationEquals) | 
| Modifier and Type | Method and Description | 
|---|---|
| default <T extends TOP> | JCas. select() | 
| default <N extends TOP> | JCas. select(Class<N> clazz) | 
| default <N extends TOP> | JCas. select(int jcasType) | 
| default <N extends TOP> | JCas. select(String fullyQualifiedTypeName) | 
| default <N extends TOP> | JCas. select(Type type) | 
| Modifier and Type | Method and Description | 
|---|---|
| <U extends T> | FSList. select()Treat an FSArray as a source for SelectFSs. | 
| <U extends T> | FSList. select(Class<U> filterByType)Treat an FSArray as a source for SelectFSs. | 
| default <U extends T> | SelectViaCopyToArray. select(Class<U> filterByType)Treat an FSArray as a source for SelectFSs. | 
| <U extends T> | FSList. select(int filterByType)Treat an FSArray as a source for SelectFSs. | 
| default <U extends T> | SelectViaCopyToArray. select(int filterByType)Treat an FSArray as a source for SelectFSs. | 
| <U extends T> | FSList. select(String filterByType)Treat an FSArray as a source for SelectFSs. | 
| default <U extends T> | SelectViaCopyToArray. select(String filterByType)Treat an FSArray as a source for SelectFSs. | 
| <U extends T> | FSList. select(Type filterByType)Treat an FSArray as a source for SelectFSs. | 
| default <U extends T> | SelectViaCopyToArray. select(Type filterByType)Treat an FSArray as a source for SelectFSs. | 
Copyright © 2006–2022 The Apache Software Foundation. All rights reserved.