# Uses of Interface
org.apache.uima.cas.FSIndex

Packages that use FSIndex
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.jcas
Interfaces for accessing the JCAS.
org.apache.uima.jcas.impl
Provides the classes that support the Java Cas Model (JCM).

- ## Uses of FSIndex in org.apache.uima.cas

  Methods in org.apache.uima.cas that return FSIndex
  Modifier and Type
  Method
  Description
  `<T extends FeatureStructure>
  FSIndex<T>`
  FSIndexRepository.`getIndex(String label)`
  Retrieve an index according to a label.
  `<T extends FeatureStructure>
  FSIndex<T>`
  FSIndexRepository.`getIndex(String label, Type type)`
  Retrieve an index according to a label and a type.
  `default <U extends T>
  FSIndex<U>`
  FSIndex.`subType(Class<? extends TOP> clazz)`
  `default <U extends T>
  FSIndex<U>`
  FSIndex.`subType(Type type)`
  `FSIndex<T>`
  FSIndex.`withSnapshotIterators()`
  Creates a shared copy of this FSIndex configured to produce snapshot iterators that don't throw ConcurrentModificationExceptions.
  Methods in org.apache.uima.cas that return types with arguments of type FSIndex
  Modifier and Type
  Method
  Description
  `<T extends FeatureStructure>
  Iterator<FSIndex<T>>`
  FSIndexRepository.`getIndexes()`
  Get all indexes in this repository.
  Methods in org.apache.uima.cas with parameters of type FSIndex
  Modifier and Type
  Method
  Description
  `static <U extends FeatureStructure>
  SelectFSs<U>`
  SelectFSs.`select(FSIndex<U> index)`
  Use this static method to capture the generic argument

- ## Uses of FSIndex in org.apache.uima.cas.impl

  Subinterfaces of FSIndex in org.apache.uima.cas.impl
  Modifier and Type
  Interface
  Description
  `interface`
  `LowLevelIndex<T extends FeatureStructure>`
  Low-level FS index object.
  Classes in org.apache.uima.cas.impl that implement FSIndex
  Modifier and Type
  Class
  Description
  `class`
  `FsIndex_annotation<T extends AnnotationFS>`
  Implementation of annotation indexes.
  `class`
  `FsIndex_bag<T extends FeatureStructure>`
  Used for UIMA FS Bag Indexes Uses ObjHashSet to hold instances of FeatureStructures
  `class`
  `FsIndex_flat<T extends FeatureStructure>`
  Common part of flattened indexes, used for both snapshot iterators and flattened sorted indexes built from passed in instance of FsIndex_iicp
  `final class`
  `FsIndex_set_sorted<T extends FeatureStructure>`
  Common index impl for set and sorted indexes.
  `class`
  `FsIndex_singletype<T extends FeatureStructure>`
  The common (among all index kinds - set, sorted, bag) info for an index over 1 type (excluding subtypes) SubClasses FsIndex_bag, FsIndex_flat, FsIndex_set_sorted, define the actual index repository for each kind.
  `class`
  `FsIndex_snapshot<T extends FeatureStructure>`
  Implementation of light-weight wrapper of normal indexes, which support special kinds of iterators base on the setting of IteratorExtraFunction
  Fields in org.apache.uima.cas.impl declared as FSIndex
  Modifier and Type
  Field
  Description
  `FSIndex<FeatureStructure>`
  DebugFSLogicalStructure.IndexInfo.`fsIndex`
  Methods in org.apache.uima.cas.impl that return FSIndex
  Modifier and Type
  Method
  Description
  `<T extends FeatureStructure>
  FSIndex<T>`
  FSIndexRepositoryImpl.`getIndex(String label, Type type)`
  `FSIndex<T>`
  FsIndex_annotation.`withSnapshotIterators()`
  `FSIndex<T>`
  FsIndex_singletype.`withSnapshotIterators()`
  `FSIndex<T>`
  FsIndex_snapshot.`withSnapshotIterators()`
  Methods in org.apache.uima.cas.impl that return types with arguments of type FSIndex
  Modifier and Type
  Method
  Description
  `Iterator<FSIndex<TOP>>`
  FSIndexRepositoryImpl.`getIndexes()`
  Methods in org.apache.uima.cas.impl with parameters of type FSIndex
  Modifier and Type
  Method
  Description
  `SelectFSs_impl<T>`
  SelectFSs_impl.`index(FSIndex<T> aIndex)`

- ## Uses of FSIndex in org.apache.uima.cas.text

  Subinterfaces of FSIndex in org.apache.uima.cas.text
  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).

- ## Uses of FSIndex in org.apache.uima.jcas

  Methods in org.apache.uima.jcas that return FSIndex
  Modifier and Type
  Method
  Description
  `<T extends TOP>
  FSIndex<T>`
  JCas.`getIndex(String label, Class<T> clazz)`
  Retrieve an index according to a label and a type specified using a JCas class.
  `<T extends TOP>
  FSIndex<T>`
  JFSIndexRepository.`getIndex(String label)`
  Retrieve an index according to a label.
  `<T extends TOP>
  FSIndex<T>`
  JFSIndexRepository.`getIndex(String label, int type)`
  Retrieve an index according to a label and a type.
  Methods in org.apache.uima.jcas that return types with arguments of type FSIndex
  Modifier and Type
  Method
  Description
  `Iterator<FSIndex<TOP>>`
  JFSIndexRepository.`getIndexes()`
  Get all indexes in this repository.

- ## Uses of FSIndex in org.apache.uima.jcas.impl

  Methods in org.apache.uima.jcas.impl that return FSIndex
  Modifier and Type
  Method
  Description
  `<T extends TOP>
  FSIndex<T>`
  JCasImpl.`getIndex(String label, Class<T> clazz)`
  `<T extends TOP>
  FSIndex<T>`
  JFSIndexRepositoryImpl.`getIndex(String label)`
  `<T extends TOP>
  FSIndex<T>`
  JFSIndexRepositoryImpl.`getIndex(String label, int type)`
  Methods in org.apache.uima.jcas.impl that return types with arguments of type FSIndex
  Modifier and Type
  Method
  Description
  `Iterator<FSIndex<TOP>>`
  JFSIndexRepositoryImpl.`getIndexes()`