## Uses of Interface
org.apache.uima.cas.impl.LowLevelIndex

- Packages that use LowLevelIndex
  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.

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

    Methods in org.apache.uima.cas that return types with arguments of type LowLevelIndex
    Modifier and Type | Method and Description
    --- | ---
    `<T extends FeatureStructure> Iterator<LowLevelIndex<T>>` | FSIndexRepository.`ll_getIndexes()` Get all indexes in this repository as low level indexes

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

    Classes in org.apache.uima.cas.impl that implement LowLevelIndex
    Modifier and Type | Class and 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
    `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 LowLevelIndex
    Modifier and Type | Field and Description
    --- | ---
    `protected LowLevelIndex<T>` | FsIterator_multiple_indexes.`main_idx`

    Methods in org.apache.uima.cas.impl that return LowLevelIndex
    Modifier and Type | Method and Description
    --- | ---
    `<T extends FeatureStructure> LowLevelIndex<T>` | FSIndexRepositoryImpl.`getIndex(String label)`
    `default <U extends T> LowLevelIndex<U>` | LowLevelIndex.`getSubIndex(Class<? extends TOP> clazz)`
    `default <U extends T> LowLevelIndex<U>` | LowLevelIndex.`getSubIndex(Type type)`
    `LowLevelIndex<T>` | LowLevelIterator_empty.`ll_getIndex()`
    `LowLevelIndex<T>` | Subiterator.`ll_getIndex()`
    `LowLevelIndex<T>` | FsIterator_multiple_indexes.`ll_getIndex()`
    `LowLevelIndex<T>` | LowLevelIterator.`ll_getIndex()` Get the index for just the top most type of this iterator (excludes subtypes).
    `LowLevelIndex<T>` | FsIterator_subtypes_snapshot.`ll_getIndex()`
    `<T extends FeatureStructure> LowLevelIndex<T>` | LowLevelIndexRepository.`ll_getIndex(String indexName)` Get an index by its name.
    `<T extends FeatureStructure> LowLevelIndex<T>` | FSIndexRepositoryImpl.`ll_getIndex(String indexName)`
    `<T extends FeatureStructure> LowLevelIndex<T>` | LowLevelIndexRepository.`ll_getIndex(String indexName, int typeCode)` Get an index by a name and type.
    `<T extends FeatureStructure> LowLevelIndex<T>` | FSIndexRepositoryImpl.`ll_getIndex(String indexName, int typeCode)`

    Methods in org.apache.uima.cas.impl that return types with arguments of type LowLevelIndex
    Modifier and Type | Method and Description
    --- | ---
    `Iterator<LowLevelIndex>` | FSIndexRepositoryImpl.`ll_getIndexes()`

    Constructors in org.apache.uima.cas.impl with parameters of type LowLevelIndex
    Constructor and Description
    `FsIterator_multiple_indexes(LowLevelIndex<T> main_idx, LowLevelIterator<T>[] iterators, Comparator<TOP> comparatorMaybeNoTypeWithoutId)`
    `FsIterator_subtypes_snapshot(T[] snapshot, LowLevelIndex<T> index, boolean is_unordered, Comparator<TOP> comparatorMaybeNoTypeWithoutId)` Alternative source iterator, 1st arg is different (not an "index", just an array) - altSources are unordered, and NoType is ignored - also supports backwards iterators, these are ordered (Maybe fix this in the future - this is not necessarily required)

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