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

- Packages that use FSIterator
  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 FSIterator in org.apache.uima.cas

    Methods in org.apache.uima.cas that return FSIterator
    Modifier and Type | Method and Description
    --- | ---
    `FSIterator<T>` | FSIterator.`copy()` Copy this iterator.
    `<T extends FeatureStructure> FSIterator<T>` | CAS.`createFilteredIterator(FSIterator<T> it, FSMatchConstraint cons)` Create an iterator over structures satisfying a given constraint.
    `<T extends FeatureStructure> FSIterator<T>` | FSIndexRepository.`getAllIndexedFS(Type aType)` Gets an iterator over all indexed FeatureStructures of the specified Type (and any of its subtypes).
    `FSIterator<SofaFS>` | CAS.`getSofaIterator()` Get iterator for all SofaFS in the CAS.
    `FSIterator<T>` | FSIndex.`iterator()` Return an iterator over the index.
    `FSIterator<T>` | FSIndex.`iterator(FeatureStructure fs)` Return an iterator over the index.

    Methods in org.apache.uima.cas with parameters of type FSIterator
    Modifier and Type | Method and Description
    --- | ---
    `<T extends FeatureStructure> FSIterator<T>` | CAS.`createFilteredIterator(FSIterator<T> it, FSMatchConstraint cons)` Create an iterator over structures satisfying a given constraint.
    `<T extends FeatureStructure> ListIterator<T>` | CAS.`fs2listIterator(FSIterator<T> it)` Wrap a standard Java `ListIterator` around an FSListIterator.

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

    Classes in org.apache.uima.cas.impl that implement FSIterator
    Modifier and Type | Class and Description
    --- | ---
    `static class` | `FSIndexFlat.FSIteratorFlat<TI extends FeatureStructure>`
    `class` | `FSIteratorImplBase<T extends FeatureStructure>` Base class for FSIterator implementations.
    `class` | `FSIteratorWrapper<T extends FeatureStructure>`
    `class` | `FSIteratorWrapperDoubleCheck<T extends FeatureStructure>` Only used for debugging Takes two iterators, and compares them; returns the 1st, throws error if unequal
    `class` | `Subiterator<T extends AnnotationFS>` Subiterator implementation.

    Methods in org.apache.uima.cas.impl that return FSIterator
    Modifier and Type | Method and Description
    --- | ---
    `FSIterator<T>` | Subiterator.`copy()`
    `FSIterator<T>` | FSIteratorWrapperDoubleCheck.`copy()`
    `FSIterator<T>` | FSIteratorWrapper.`copy()`
    `<T extends FeatureStructure> FSIterator<T>` | CASImpl.`createFilteredIterator(FSIterator<T> it, FSMatchConstraint cons)`
    `<T extends FeatureStructure> FSIterator<T>` | FSIndexRepositoryImpl.`getAllIndexedFS(Type type)`
    `FSIterator<SofaFS>` | CASImpl.`getSofaIterator()`
    `FSIterator<T>` | AnnotationIndexImpl.`iterator()`
    `FSIterator<T>` | FSIndexFlat.`iterator()` This iterator either returns an iterator over the flattened index, or null.
    `FSIterator<T>` | AnnotationIndexImpl.`iterator(boolean ambiguous)`
    `FSIterator<T>` | FSLeafIndexImpl.`iterator(FeatureStructure fs)`
    `FSIterator<T>` | AnnotationIndexImpl.`iterator(FeatureStructure fs)`
    `FSIterator<T>` | AnnotationIndexImpl.`subiterator(AnnotationFS annot)`
    `FSIterator<T>` | AnnotationIndexImpl.`subiterator(AnnotationFS annot, boolean ambiguous, boolean strict)`

    Methods in org.apache.uima.cas.impl with parameters of type FSIterator
    Modifier and Type | Method and Description
    --- | ---
    `<T extends FeatureStructure> FSIterator<T>` | CASImpl.`createFilteredIterator(FSIterator<T> it, FSMatchConstraint cons)`
    `<T extends FeatureStructure> ListIterator<T>` | CASImpl.`fs2listIterator(FSIterator<T> it)`

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

    Methods in org.apache.uima.cas.text that return FSIterator
    Modifier and Type | Method and Description
    --- | ---
    `FSIterator<T>` | AnnotationIndex.`iterator(boolean ambiguous)` Return an iterator over annotations that can be constrained to be unambiguous.
    `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 FSIterator in org.apache.uima.jcas

    Methods in org.apache.uima.jcas that return FSIterator
    Modifier and Type | Method and Description
    --- | ---
    `<T extends FeatureStructure> FSIterator<T>` | JCas.`createFilteredIterator(FSIterator<T> it, FSMatchConstraint cons)` Create an iterator over structures satisfying a given constraint.
    `<T extends TOP> FSIterator<T>` | JCas.`getAllIndexedFS(Class<T> clazz)` Gets an iterator over all indexed FeatureStructures of the specified Type (and any of its subtypes).
    `<T extends TOP> FSIterator<T>` | JFSIndexRepository.`getAllIndexedFS(int aType)` Gets an iterator over all indexed FeatureStructures of the specified Type (and any of its subtypes).
    `<T extends TOP> FSIterator<T>` | JFSIndexRepository.`getAllIndexedFS(Type aType)` Gets an iterator over all indexed FeatureStructures of the specified Type (and any of its subtypes).
    `FSIterator<SofaFS>` | JCas.`getSofaIterator()` Get iterator for all SofaFS in the CAS.

    Methods in org.apache.uima.jcas with parameters of type FSIterator
    Modifier and Type | Method and Description
    --- | ---
    `<T extends FeatureStructure> FSIterator<T>` | JCas.`createFilteredIterator(FSIterator<T> it, FSMatchConstraint cons)` Create an iterator over structures satisfying a given constraint.
    `<T extends FeatureStructure> ListIterator<T>` | JCas.`fs2listIterator(FSIterator<T> it)` Wrap a standard Java `ListIterator` around an FSListIterator.

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

    Methods in org.apache.uima.jcas.impl that return FSIterator
    Modifier and Type | Method and Description
    --- | ---
    `<T extends FeatureStructure> FSIterator<T>` | JCasImpl.`createFilteredIterator(FSIterator<T> it, FSMatchConstraint constraint)`
    `<T extends TOP> FSIterator<T>` | JCasImpl.`getAllIndexedFS(Class<T> clazz)`
    `<T extends TOP> FSIterator<T>` | JFSIndexRepositoryImpl.`getAllIndexedFS(int aType)`
    `<T extends TOP> FSIterator<T>` | JFSIndexRepositoryImpl.`getAllIndexedFS(Type aType)`
    `FSIterator<SofaFS>` | JCasImpl.`getSofaIterator()`

    Methods in org.apache.uima.jcas.impl with parameters of type FSIterator
    Modifier and Type | Method and Description
    --- | ---
    `<T extends FeatureStructure> FSIterator<T>` | JCasImpl.`createFilteredIterator(FSIterator<T> it, FSMatchConstraint constraint)`
    `<T extends FeatureStructure> ListIterator<T>` | JCasImpl.`fs2listIterator(FSIterator<T> it)`

Copyright © 2006–2021 The Apache Software Foundation. All rights reserved.