## Uses of Class
org.apache.uima.jcas.cas.TOP

- Packages that use TOP
  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.examples |
  org.apache.uima.jcas | Interfaces for accessing the JCAS.
  org.apache.uima.jcas.cas | JCAS model for built-in CAS types
  org.apache.uima.jcas.impl | Provides the classes that support the Java Cas Model (JCM).
  org.apache.uima.jcas.tcas |
  org.apache.uima.spi |
  org.apache.uima.util | Utility classes and interfaces used by UIMA components.
  org.apache.uima.util.impl |

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

    Methods in org.apache.uima.cas with type parameters of type TOP
    Modifier and Type | Method and Description
    --- | ---
    `default <T extends TOP> CommonArrayFS<T>` | CAS.`emptyArray(Class<T> clazz)`
    `default <T extends TOP> EmptyFSList<T>` | CAS.`emptyFSList()`
    `default <T extends TOP> EmptyList` | CAS.`emptyList(Class<T> clazz)`
    `default <T extends TOP> FSIterator<T>` | CAS.`getAllIndexedFS(Class<T> clazz)` Gets an iterator over all indexed (in this CAS view) FeatureStructures of the specified Type (and any of its subtypes).
    `default <T extends TOP> FSIterator<T>` | CAS.`getAllIndexedFS(Type type)` Gets an iterator over all indexed (in this CAS view) FeatureStructures of the specified Type (and any of its subtypes).
    `default <T extends TOP> Type` | CAS.`getCasType(Class<T> clazz)`
    `<T extends TOP> Collection<T>` | FSIndexRepository.`getIndexedFSs()` Returns an unmodifiable collection of all of the FSs that are indexed in this view, in an arbitrary order.
    `<T extends TOP> Collection<T>` | FSIndexRepository.`getIndexedFSs(Class<T> clazz)` Returns an unmodifiable collection of all the FSs of this type and its subtypes, that are indexed in this view, in an arbitrary order.
    `default <T extends TOP> Collection<T>` | CAS.`getIndexedFSs(Class<T> clazz)` Returns a collection of all the FSs that are indexed in this view, in an arbitrary order.
    `<T extends TOP> Collection<T>` | FSIndexRepository.`getIndexedFSs(Type type)` Returns an unmodifiable collection of all the FSs of this type and its subtypes, that are indexed in this view, in an arbitrary order.
    `default <T extends TOP> Collection<T>` | CAS.`getIndexedFSs(Type type)` Returns an unmodifiable collection of all the FSs that are indexed in this view, in an arbitrary order.
    `default <T extends TOP> void` | FSIndexRepository.`removeAllExcludingSubtypes(Class<T> clazz)` Remove all instances of just this type, excluding subtypes, from all indexes in the repository view.
    `default <T extends TOP> void` | FSIndexRepository.`removeAllIncludingSubtypes(Class<T> clazz)` Remove all instances of type, including all subtypes from all indexes in the repository view.
    `default <T extends TOP> SelectFSs<T>` | CAS.`select()`
    `default <T extends TOP> SelectFSs<T>` | CAS.`select(Class<T> clazz)`
    `default <T extends TOP> SelectFSs<T>` | CAS.`select(int jcasType)`
    `default <T extends TOP> SelectFSs<T>` | CAS.`select(String fullyQualifiedTypeName)`
    `default <T extends TOP> SelectFSs<T>` | CAS.`select(Type type)`
    `<T extends TOP> T[]` | ArrayFS.`toArray(T[] a)` Populates an existing array from this FS Array.

    Methods in org.apache.uima.cas that return TOP
    Modifier and Type | Method and Description
    --- | ---
    `<T extends TOP> T[]` | ArrayFS.`toArray(T[] a)` Populates an existing array from this FS Array.

    Methods in org.apache.uima.cas that return types with arguments of type TOP
    Modifier and Type | Method and Description
    --- | ---
    `default Collection<TOP>` | CAS.`getIndexedFSs()` Returns an unmodifiable collection of all of the FSs that are indexed in this view, in an arbitrary order.

    Methods in org.apache.uima.cas with parameters of type TOP
    Modifier and Type | Method and Description
    --- | ---
    `T` | SelectFSs.`get(TOP fs)` Positions to the fs using moveTo(fs).
    `T` | SelectFSs.`get(TOP fs, int offset)` Positions to the fs using moveTo(fs), followed by a shifted(offset).
    `T` | SelectFSs.`single(TOP fs)` Positions to the fs using moveTo(fs).
    `T` | SelectFSs.`single(TOP fs, int offset)` Positions to the fs using moveTo(fs), followed by a shifted(offset).
    `T` | SelectFSs.`singleOrNull(TOP fs)` Positions to the fs using moveTo(fs).
    `T` | SelectFSs.`singleOrNull(TOP fs, int offset)` Positions to the fs using moveTo(fs), followed by a shifted(offset).
    `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
    `<T extends TOP> T[]` | ArrayFS.`toArray(T[] a)` Populates an existing array from this FS Array.

    Method parameters in org.apache.uima.cas with type arguments of type TOP
    Modifier and Type | Method and Description
    --- | ---
    `default <U extends T> FSIndex<U>` | FSIndex.`subType(Class<? extends TOP> clazz)`

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

    Fields in org.apache.uima.cas.impl with type parameters of type TOP
    Modifier and Type | Field and Description
    --- | ---
    `protected Comparator<TOP>` | FsIterator_multiple_indexes.`comparatorMaybeNoTypeWithoutId` for set and sorted, both ignore id because this comparator is not used for comparing within the index, only for compares between index items and outside args.
    `protected Comparator<TOP>` | FsIndex_singletype.`comparatorNoTypeWithID` comparator (with id) (ignoring typeorder) - used within one type
    `protected Comparator<TOP>` | FsIndex_singletype.`comparatorNoTypeWithoutID` comparator (without id) (ignoring typeorder) - used within one type - used for iterator operations where the type is requested to be ignored
    `protected Comparator<TOP>` | FsIndex_singletype.`comparatorWithID`
    `protected Comparator<TOP>` | FsIndex_singletype.`comparatorWithoutID`
    `static Comparator<TOP>` | LowLevelIndex.`FS_ID_COMPARATOR`
    `List<TOP>` | CasSerializerSupport.CasDocSerializer.`modifiedEmbeddedValueFSs`
    `Set<TOP>` | CasSerializerSupport.CasDocSerializer.`multiRefFSs` Set of FSs that have multiple references Has an entry for each FS (not just array or list FSs) which is (from some point on) being serialized as a multi-ref, that is, is **not** being serialized (any more) using the special notation for arrays and lists or, for JSON, **not** being serialized using the embedded notation This is for JSON which is computing the multi-refs, not depending on the setting in a feature.
    `List<TOP>` | CasSerializerSupport.CasDocSerializer.`previouslySerializedFSs`
    `Comparator<TOP>` | CasSerializerSupport.CasDocSerializer.`sortFssByType` Called for JSon Serialization Sort a view, by type and then by begin/end asc/des for subtypes of Annotation, then by id
    `Set<TOP>` | CasSerializerSupport.CasDocSerializer.`visited_not_yet_written` set of FSs that have been visited and enqueued to be serialized - exception: arrays and lists which are "inline" are put into this set, but are not enqueued to be serialized.

    Methods in org.apache.uima.cas.impl with type parameters of type TOP
    Modifier and Type | Method and Description
    --- | ---
    `<N extends TOP> N` | FeatureStructureImplC.`_maybeGetBaseForPearFs()` Called to convert to the base FS from a Pear version
    `protected <N extends TOP> N` | FeatureStructureImplC.`_maybeGetBaseForPearFs(N v)` Called when setting a FS value which might be a trampoline
    `<N extends TOP> N` | FeatureStructureImplC.`_maybeGetPearFs()`
    `protected <N extends TOP> N` | FeatureStructureImplC.`_maybeGetPearFs(N v)` Called when getting a FS value which might need to return a Pear context's trampoline
    `<T extends TOP> void` | FSIndexRepositoryImpl.`addback(T fs)`
    `<T extends TOP> T` | CASImpl.`createFS(int id)` This is your link from the low-level API to the high-level API.
    `<T extends TOP> EmptyFSList<T>` | CASImpl.`emptyFSList()`
    `<T extends TOP> T` | CASImpl.`getFsFromId_checked(int fsRef)`
    `<T extends TOP> T` | CASImpl.`getFsFromId(int id)`
    `<T extends TOP> Collection<T>` | FSIndexRepositoryImpl.`getIndexedFSs(Class<T> clazz)`
    `<T extends TOP> Collection<T>` | FSIndexRepositoryImpl.`getIndexedFSs(Type type)`
    `<T extends TOP> T` | CASImpl.`ll_getFSForRef(int id)`
    `<T extends TOP> T` | LowLevelCAS.`ll_getFSForRef(int fsRef)` Return a FS object that corresponds to a low-level reference.

    Methods in org.apache.uima.cas.impl that return TOP
    Modifier and Type | Method and Description
    --- | ---
    `TOP` | FeatureStructureImplC.`_getFeatureValueNc(FeatureImpl feat)`
    `TOP` | FeatureStructureImplC.`_getFeatureValueNc(int adjOffset)`
    `TOP` | CASImpl.`createArray(TypeImpl array_type, int arrayLength)`
    `TOP` | FsGenerator3.`createFS(TypeImpl typeImpl, CASImpl casImpl)`
    `TOP` | FsGeneratorArray.`createFS(TypeImpl typeImpl, CASImpl casImpl, int length)`
    `TOP[]` | XmiSerializationSharedData.`getAndSortByIdAllFSsInIdMap()` Get all FS Addresses that have been added to the id map.
    `TOP` | XmiSerializationSharedData.`getEncompassingFS(TOP nonsharedFS)`
    `TOP` | FeatureStructureImplC.`getFeatureValue(Feature feat)`
    `TOP` | XmiSerializationSharedData.`getFsForXmiId(int xmiId)` Gets the FS address that corresponds to the given xmi:id, in the most recent serialization or deserialization.
    `TOP[]` | XmiSerializationSharedData.`getNonsharedMulitValuedFSs()`
    `TOP` | CasSeqAddrMaps.`getSrcFsFromTgtSeq(int seq)`

    Methods in org.apache.uima.cas.impl that return types with arguments of type TOP
    Modifier and Type | Method and Description
    --- | ---
    `Set<TOP>` | FSIndexRepositoryImpl.`getAddedFSs()`
    `Comparator<TOP>` | FSIndexRepositoryImpl.`getAnnotationFsComparator(FSComparators withId, FSComparators withTypeOrder)`
    `Comparator<TOP>` | FSIndexRepositoryImpl.`getAnnotationFsComparatorWithoutId()`
    `Comparator<TOP>` | LowLevelIterator_empty.`getComparator()`
    `Comparator<TOP>` | LowLevelIndex.`getComparator()`
    `Comparator<TOP>` | Subiterator.`getComparator()`
    `Comparator<TOP>` | FsIndex_snapshot.`getComparator()`
    `Comparator<TOP>` | FsIterator_subtypes_ordered.`getComparator()`
    `Comparator<TOP>` | FsIndex_singletype.`getComparator()`
    `Comparator<TOP>` | LowLevelIterator.`getComparator()`
    `Comparator<TOP>` | FsIterator_subtypes_snapshot.`getComparator()`
    `Comparator<TOP>` | FSIteratorImplBase.`getComparator()` default implementation of getComparator
    `Set<TOP>` | FSIndexRepositoryImpl.`getDeletedFSs()`
    `Collection<TOP>` | FSIndexRepositoryImpl.`getIndexedFSs()`
    `Iterator<FSIndex<TOP>>` | FSIndexRepositoryImpl.`getIndexes()`
    `FsIndex_singletype<TOP>` | FSIndexRepositoryImpl.`getNonSetSingleIndexForType(int typecode)`
    `FsIndex_singletype<TOP>` | FSIndexRepositoryImpl.`getNonSetSingleIndexForUsedType(int i)`
    `Set<TOP>` | FSIndexRepositoryImpl.`getReindexedFSs()`
    `Set<TOP>` | FSIndexRepositoryImpl.`getUpdatedFSs(Set<TOP> items)`
    `IteratorNvc<TOP>` | Id2FS.`iterator()`
    `Stream<FsIndex_singletype<TOP>>` | FSIndexRepositoryImpl.`streamNonEmptyIndexes(Class<? extends TOP> clazz)`
    `Stream<FsIndex_singletype<TOP>>` | FSIndexRepositoryImpl.`streamNonEmptyIndexes(Type type)` Stream instances of all of the non-empty indexes themselves
    `List<TOP>` | CASImpl.`walkReachablePlusFSsSorted(Consumer<TOP> action_filtered, MarkerImpl mark, Predicate<TOP> includeFilter, CasTypeSystemMapper typeMapper)` find all of the FSs via the indexes plus what's reachable.

    Methods in org.apache.uima.cas.impl with parameters of type TOP
    Modifier and Type | Method and Description
    --- | ---
    `void` | CasSeqAddrMaps.`addItemId(TOP srcFs, int tgtId, boolean inTarget)` Add a new FS id - done during prescan of source during serialization Must call in heap scan order
    `void` | XmiSerializationSharedData.`addNonsharedRefToFSMapping(TOP nonsharedFS, TOP fs)` Add mapping between the address of FS that is the value of a non-shared multi-valued feature of a FeatureStructure.
    `void` | XmiSerializationSharedData.`addOutOfTypeSystemAttribute(TOP fs, String featName, String featVal)` Records an out-of-typesystem attribute that belongs to an in-typesystem FS.
    `void` | XmiSerializationSharedData.`addOutOfTypeSystemChildElements(TOP fs, String featName, ArrayList<String> featVals)` Records out-of-typesystem child elements that belong to an in-typesystem FS.
    `void` | CasSeqAddrMaps.`addSrcFsForTgt(TOP srcFs, boolean inSrc)` Called during deserialize to incrementally add
    `static CommonArrayFS` | CASImpl.`copyArray(TOP srcArray)`
    `static boolean` | CASImpl.`copyFeatureExceptFsRef(TOP fsSrc, FeatureImpl fiSrc, TOP fsTgt, FeatureImpl fiTgt)` Copies a feature from one fs to another FSs may be in different type systems Doesn't copy a feature ref, but instead returns false.
    `void` | CasSerializerSupport.CasDocSerializer.`encodeFS(TOP fs)` Encode an individual FS.
    `T` | SelectFSs_impl.`get(TOP fs)`
    `T` | SelectFSs_impl.`get(TOP fs, int offset)`
    `TOP` | XmiSerializationSharedData.`getEncompassingFS(TOP nonsharedFS)`
    `int` | TypeImpl.`getFsSpaceReq(TOP fs)`
    `static int` | BinaryCasSerDes.`getFsSpaceReq(TOP fs, TypeImpl type)`
    `int` | CASImpl.`getNextFsId(TOP fs)`
    `XmiSerializationSharedData.OotsElementData` | XmiSerializationSharedData.`getOutOfTypeSystemFeatures(TOP fs)` Gets information about out-of-typesystem features that belong to an in-typesystem FS.
    `String` | XmiSerializationSharedData.`getXmiId(TOP fs)`
    `String` | CasSerializerSupport.CasDocSerializer.`getXmiId(TOP fs)` Get the XMI ID to use for an FS.
    `int` | CasSerializerSupport.CasDocSerializer.`getXmiIdAsInt(TOP fs)`
    `void` | CASImpl.`maybeAddback(TOP fs)` Only called if there was something removed that needs to be added back skip the addback (to defer it until later) if: - running in block mode (you can tell this if svd.fssTobeAddedback.size() > 0) or if running in block mode, the add back is delayed until the end of the block
    `static void` | CASImpl.`setFeatureValueMaybeSofa(TOP fs, FeatureImpl feat, TOP value)` internal use - special setter for setting feature values, including special handling if the feature is for the sofaArray, when deserializing
    `void` | CASImpl.`setWithCheckAndJournal(TOP fs, int featCode, Runnable setter)`
    `T` | SelectFSs_impl.`single(TOP fs)`
    `T` | SelectFSs_impl.`single(TOP fs, int offset)`
    `T` | SelectFSs_impl.`singleOrNull(TOP fs)`
    `T` | SelectFSs_impl.`singleOrNull(TOP fs, int offset)`
    `Runnable` | CasCompare.`sort_dedup_FSArray(TOP fs, Feature feat)` This is an optional pre-compare operation.
    `SelectFSs_impl<T>` | SelectFSs_impl.`startAt(TOP fs)`
    `SelectFSs_impl<T>` | SelectFSs_impl.`startAt(TOP fs, int offset)`
    `protected abstract void` | CasSerializerSupport.CasSerializerSupportSerialize.`writeArrays(TOP fsarray, int typeCode, int typeClass)`
    `protected abstract void` | CasSerializerSupport.CasSerializerSupportSerialize.`writeFs(TOP fs, int typeCode)`
    `protected abstract void` | CasSerializerSupport.CasSerializerSupportSerialize.`writeFsRef(TOP fs)`
    `protected abstract boolean` | CasSerializerSupport.CasSerializerSupportSerialize.`writeFsStart(TOP fs, int typeCode)`
    `protected abstract void` | CasSerializerSupport.CasSerializerSupportSerialize.`writeListsAsIndividualFSs(TOP fs, int typeCode)`

    Method parameters in org.apache.uima.cas.impl with type arguments of type TOP
    Modifier and Type | Method and Description
    --- | ---
    `void` | CasCompare.`applyToTypeFeature(String typeName, String featureBaseName, org.apache.uima.internal.util.function.Consumer2<TOP,Feature> c)` Before comparing, you can adjust specific features of specific types, arbitrarily.
    `static MutableCallSite` | TypeSystemImpl.`createCallSite(Class<? extends TOP> clazz, String featName)` Creates and returns a new MutableCallSite, // * recording it in list of all callsites for this type, in a map by typename // * // * Done this way because // * - can't be a classloader-wide list of call sites - some might not be associated with this type system // * - can't be a typesystem-wide list of call sites - the JCas class might be used by multiple type systems // * and the first one to load it would set this value.
    `static MutableCallSite` | TypeSystemImpl.`createCallSiteForBuiltIn(Class<? extends TOP> clazz, String featName)` INTERNAL API - DO NOT USE, MAY CHANGE WITHOUT NOTICE!
    `default <U extends T> LowLevelIndex<U>` | LowLevelIndex.`getSubIndex(Class<? extends TOP> clazz)`
    `Set<TOP>` | FSIndexRepositoryImpl.`getUpdatedFSs(Set<TOP> items)`
    `Stream<FsIndex_singletype<TOP>>` | FSIndexRepositoryImpl.`streamNonEmptyIndexes(Class<? extends TOP> clazz)`
    `List<Runnable>` | CasCompare.`type_feature_to_runnable(String typeName, String featureBaseName, BiFunction<TOP,Feature,Runnable> c)` Before comparing, you can create pending values for specific types / features, and return a list of runnables, which when run, plug in those pending values.
    `void` | FSIndexRepositoryImpl.`walkIndexedFSs(Consumer<TOP> action)` For this view, walk the indexed FSs in arbitrary order.
    `List<TOP>` | CASImpl.`walkReachablePlusFSsSorted(Consumer<TOP> action_filtered, MarkerImpl mark, Predicate<TOP> includeFilter, CasTypeSystemMapper typeMapper)` find all of the FSs via the indexes plus what's reachable.
    `List<TOP>` | CASImpl.`walkReachablePlusFSsSorted(Consumer<TOP> action_filtered, MarkerImpl mark, Predicate<TOP> includeFilter, CasTypeSystemMapper typeMapper)` find all of the FSs via the indexes plus what's reachable.
    `void` | FSIndexRepositoryImpl.`walkSortedIndexedFSs(Consumer<TOP> action)` For this view, walk the indexed FSs, sorted by id (e.g.
    `protected abstract void` | CasSerializerSupport.CasSerializerSupportSerialize.`writeView(Sofa sofa, Collection<TOP> members)`
    `protected abstract void` | CasSerializerSupport.CasSerializerSupportSerialize.`writeView(Sofa sofa, Collection<TOP> added, Collection<TOP> deleted, Collection<TOP> reindexed)`
    `protected abstract void` | CasSerializerSupport.CasSerializerSupportSerialize.`writeView(Sofa sofa, Collection<TOP> added, Collection<TOP> deleted, Collection<TOP> reindexed)`
    `protected abstract void` | CasSerializerSupport.CasSerializerSupportSerialize.`writeView(Sofa sofa, Collection<TOP> added, Collection<TOP> deleted, Collection<TOP> reindexed)`

    Constructor parameters in org.apache.uima.cas.impl with type arguments of type TOP
    Constructor and Description
    `CasSeqAddrMaps(List<TOP> tgtSeq2SrcFs, org.apache.uima.internal.util.rb_trees.Int2IntRBT srcAddr2TgtSeq)`
    `FsIndex_snapshot(org.apache.uima.cas.impl.FsIndex_iicp<T> wrapped, Comparator<TOP> comparatorWithoutId, Comparator<TOP> comparatorTypeWithoutId)`
    `FsIndex_snapshot(org.apache.uima.cas.impl.FsIndex_iicp<T> wrapped, Comparator<TOP> comparatorWithoutId, Comparator<TOP> comparatorTypeWithoutId)`
    `FsIterator_multiple_indexes(LowLevelIndex<T> main_idx, LowLevelIterator<T>[] iterators, Comparator<TOP> comparatorMaybeNoTypeWithoutId)`
    `FsIterator_subtypes_ordered(org.apache.uima.cas.impl.FsIndex_iicp<T> iicp, Comparator<TOP> comparatorMaybeNoTypeWithoutId)`
    `FsIterator_subtypes_snapshot(FsIndex_flat<T> flatIndex, 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)

  - ### Uses of TOP in org.apache.uima.examples

    Subclasses of TOP in org.apache.uima.examples
    Modifier and Type | Class and Description
    --- | ---
    `class` | `SourceDocumentInformation` Stores detailed information about the original source document from which the current CAS was initialized.

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

    Methods in org.apache.uima.jcas with type parameters of type TOP
    Modifier and Type | Method and Description
    --- | ---
    `default <T extends TOP> CommonArrayFS` | JCas.`emptyArray(Class<T> clazz)`
    `default <T extends TOP> FSArray<T>` | JCas.`emptyFSArray(Class<T> clazz)` Retrieve a lazily-created constant from the cas which holds a 0-length instance of a subtype of FSArray.
    `default <T extends TOP> EmptyFSList<T>` | JCas.`emptyFSList()`
    `default <T extends TOP> EmptyList` | JCas.`emptyList(Class<T> clazz)`
    `<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).
    `default <T extends TOP> FSIterator<T>` | JCas.`getAllIndexedFS(Type type)` Gets an iterator over all indexed FeatureStructures of the specified Type (and any of its subtypes).
    `<T extends TOP> FSIndex<T>` | JFSIndexRepository.`getIndex(String label)` Retrieve an index according to a label.
    `<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, int type)` Retrieve an index according to a label and a type.
    `default <T extends TOP> Collection<T>` | JCas.`getIndexedFSs(Class<T> clazz)` Returns an unmodifiable collection of all the FSs that are indexed in this view, in an arbitrary order.
    `default <T extends TOP> Collection<T>` | JCas.`getIndexedFSs(Type type)` Returns an unmodifiable collection of all the FSs that are indexed in this view, in an arbitrary order.
    `default <T extends TOP> T` | JCas.`getJfsFromCaddr(int casAddr)`
    `default <T extends TOP> void` | JCas.`removeAllExcludingSubtypes(Class<T> clazz)` Remove all instances of just this type, excluding subtypes, from all indexes in the repository view.
    `default <T extends TOP> void` | JCas.`removeAllIncludingSubtypes(Class<T> clazz)` Remove all instances of type, including all subtypes from all indexes in the repository view.
    `default <T extends TOP> SelectFSs<T>` | JCas.`select()`
    `default <N extends TOP> SelectFSs<N>` | JCas.`select(Class<N> clazz)`
    `default <N extends TOP> SelectFSs<N>` | JCas.`select(int jcasType)`
    `default <N extends TOP> SelectFSs<N>` | JCas.`select(String fullyQualifiedTypeName)`
    `default <N extends TOP> SelectFSs<N>` | JCas.`select(Type type)`

    Methods in org.apache.uima.jcas that return TOP
    Modifier and Type | Method and Description
    --- | ---
    `TOP` | JCas.`getDocumentAnnotationFs()` Gets the document annotation.

    Methods in org.apache.uima.jcas that return types with arguments of type TOP
    Modifier and Type | Method and Description
    --- | ---
    `static Class<? extends TOP>` | JCasRegistry.`getClassForIndex(int aIndex)` Used for error message: When a particular loaded type system is missing the type that corresponds to a loaded JCas class (perhaps that class was loaded when another type system was being used, or it was just referred to in Java code (which causes it to be loaded) then the error message uses this to get the class to be able to print the class name Gets the JCas cover class for a given index.
    `default Collection<TOP>` | JCas.`getIndexedFSs()` Returns an unmodifiable collection of all of the FSs that are indexed in this view, in an arbitrary order.
    `Iterator<FSIndex<TOP>>` | JFSIndexRepository.`getIndexes()` Get all indexes in this repository.

    Methods in org.apache.uima.jcas with parameters of type TOP
    Modifier and Type | Method and Description
    --- | ---
    `TOP_Type` | JCas.`getType(TOP instance)` Deprecated. use instance.jcasType instead - faster

    Method parameters in org.apache.uima.jcas with type arguments of type TOP
    Modifier and Type | Method and Description
    --- | ---
    `static int` | JCasRegistry.`register(Class<? extends TOP> aJCasCoverClass)` Registers a JCas cover class with this registry.

  - ### Uses of TOP in org.apache.uima.jcas.cas

    Classes in org.apache.uima.jcas.cas with type parameters of type TOP
    Modifier and Type | Class and Description
    --- | ---
    `class` | `EmptyFSList<T extends TOP>`
    `class` | `FSArrayList<T extends TOP>` An ArrayList type containing Feature Structures, for UIMA Has all the methods of List Implements the select(...) APIs
    `class` | `FSHashSet<T extends TOP>` a hash set of Feature Structures Is Pear aware - stores non-pear versions but may return pear version in pear contexts Updated by JCasGen Fri Jan 20 11:55:59 EST 2017 XML source: C:/au/svnCheckouts/branches/uimaj/v3-alpha/uimaj-types/src/main/descriptors/java_object_type_descriptors.xml
    `class` | `FSLinkedHashSet<T extends TOP>` a hash set of Feature Structures Is Pear aware - stores non-pear versions but may return pear version in pear contexts Updated by JCasGen Fri Jan 20 11:55:59 EST 2017 XML source: C:/au/svnCheckouts/branches/uimaj/v3-alpha/uimaj-types/src/main/descriptors/java_object_type_descriptors.xml
    `class` | `FSList<T extends TOP>` T extends TOP, v2 already mandated TOP for set/get
    `class` | `Int2FS<T extends TOP>` A map from ints to Feature Structures Is Pear aware - stores non-pear versions but may return pear version in pear contexts
    `class` | `NonEmptyFSList<T extends TOP>`

    Subclasses of TOP in org.apache.uima.jcas.cas
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AnnotationBase` the JCas class model for the CAS type uima.cas.AnnotationBase.
    `class` | `BooleanArray` JCas class model for BooleanArray
    `class` | `ByteArray` JCas class model for ByteArray
    `class` | `DoubleArray` JCas class model for DoubleArray
    `class` | `EmptyFloatList`
    `class` | `EmptyFSList<T extends TOP>`
    `class` | `EmptyIntegerList`
    `class` | `EmptyStringList`
    `class` | `FloatArray` Java Cas model for Cas FloatArray.
    `class` | `FloatList`
    `class` | `FSArray<T extends FeatureStructure>` Java Class model for Cas FSArray type extends FeatureStructure for backwards compatibility when using FSArray with no typing.
    `class` | `FSArrayList<T extends TOP>` An ArrayList type containing Feature Structures, for UIMA Has all the methods of List Implements the select(...) APIs
    `class` | `FSHashSet<T extends TOP>` a hash set of Feature Structures Is Pear aware - stores non-pear versions but may return pear version in pear contexts Updated by JCasGen Fri Jan 20 11:55:59 EST 2017 XML source: C:/au/svnCheckouts/branches/uimaj/v3-alpha/uimaj-types/src/main/descriptors/java_object_type_descriptors.xml
    `class` | `FSLinkedHashSet<T extends TOP>` a hash set of Feature Structures Is Pear aware - stores non-pear versions but may return pear version in pear contexts Updated by JCasGen Fri Jan 20 11:55:59 EST 2017 XML source: C:/au/svnCheckouts/branches/uimaj/v3-alpha/uimaj-types/src/main/descriptors/java_object_type_descriptors.xml
    `class` | `FSList<T extends TOP>` T extends TOP, v2 already mandated TOP for set/get
    `class` | `Int2FS<T extends TOP>` A map from ints to Feature Structures Is Pear aware - stores non-pear versions but may return pear version in pear contexts
    `class` | `IntegerArray` The Java Class model corresponding to the Cas IntegerArray_JCasImpl type.
    `class` | `IntegerArrayList` An ArrayList type containing ints, for UIMA - implements a subset of the List API, Iterable<Integer>, IntListIterator.
    `class` | `IntegerList`
    `class` | `LongArray` JCas class model for LongArray
    `class` | `NonEmptyFloatList`
    `class` | `NonEmptyFSList<T extends TOP>`
    `class` | `NonEmptyIntegerList`
    `class` | `NonEmptyStringList`
    `class` | `ShortArray` JCas class model for ShortArray
    `class` | `Sofa`
    `class` | `StringArray` JCas class model for StringArray
    `class` | `StringList`

    Fields in org.apache.uima.jcas.cas declared as TOP
    Modifier and Type | Field and Description
    --- | ---
    `static TOP` | TOP.`_singleton` Internal use - used as removed marker in maps

    Methods in org.apache.uima.jcas.cas with type parameters of type TOP
    Modifier and Type | Method and Description
    --- | ---
    `static <U extends TOP,E extends FeatureStructure> FSList<U>` | FSList.`create(JCas jcas, E[] a)` Create an FSList from an existing array of Feature Structures
    `static <E extends TOP,F extends FeatureStructure> FSArrayList<E>` | FSArrayList.`create(JCas jcas, F[] a)` Convenience - create a FSArrayList from an existing Array.
    `<U extends TOP> U[]` | FSArray.`toArray(U[] a)`

    Methods in org.apache.uima.jcas.cas that return TOP
    Modifier and Type | Method and Description
    --- | ---
    `static TOP` | TOP.`_createJCasHashMapReserve(int id)` for internal use only, creates a reserved marker
    `static TOP` | TOP.`_createSearchKey(int id)`
    `TOP[]` | FSArray.`_getTheArray()`
    `T[]` | FSHashSet.`_toArrayForSelect()`
    `TOP` | Sofa.`getSofaArray()` These getter methods are for creating method handle access The getter name must match the feature name + transformation - used in generic pretty printing routines
    `TOP[]` | FSArrayList.`toArray()` returns TOP[] because can't make array of T Note: converts to pear trampolines.
    `T[]` | FSHashSet.`toArray()`
    `<U extends TOP> U[]` | FSArray.`toArray(U[] a)`

    Methods in org.apache.uima.jcas.cas with parameters of type TOP
    Modifier and Type | Method and Description
    --- | ---
    `<U extends TOP> U[]` | FSArray.`toArray(U[] a)`

    Constructor parameters in org.apache.uima.jcas.cas with type arguments of type TOP
    Constructor and Description
    `FSArray(Class<? extends TOP> clazz, JCas jcas, int length)` Constructs an instance of a subtype of FSArray having the component type clazz Note: the array with this component type must already be specified in the type system declaration as a feature whose range is FSArray with the specified elementType.

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

    Methods in org.apache.uima.jcas.impl with type parameters of type TOP
    Modifier and Type | Method and Description
    --- | ---
    `<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)`
    `<T extends TOP> FSIndex<T>` | JFSIndexRepositoryImpl.`getIndex(String label)`
    `<T extends TOP> FSIndex<T>` | JCasImpl.`getIndex(String label, Class<T> clazz)`
    `<T extends TOP> FSIndex<T>` | JFSIndexRepositoryImpl.`getIndex(String label, int type)`

    Methods in org.apache.uima.jcas.impl that return TOP
    Modifier and Type | Method and Description
    --- | ---
    `TOP` | JCasImpl.`createFS(Type type)`
    `TOP` | JCasHashMap.`get(int key)`
    `TOP` | JCasImpl.`getDocumentAnnotationFs()`
    `TOP` | JCasHashMap.`put(int key, TOP value)`
    `TOP` | JCasHashMap.`put(TOP value)`
    `TOP` | JCasHashMap.`putIfAbsent(int key, IntFunction<TOP> creator)`

    Methods in org.apache.uima.jcas.impl that return types with arguments of type TOP
    Modifier and Type | Method and Description
    --- | ---
    `Iterator<FSIndex<TOP>>` | JFSIndexRepositoryImpl.`getIndexes()`
    `IteratorNvc<TOP>` | JCasHashMap.`iterator()`

    Methods in org.apache.uima.jcas.impl with parameters of type TOP
    Modifier and Type | Method and Description
    --- | ---
    `TOP_Type` | JCasImpl.`getType(TOP instance)`
    `TOP` | JCasHashMap.`put(int key, TOP value)`
    `TOP` | JCasHashMap.`put(TOP value)`

    Method parameters in org.apache.uima.jcas.impl with type arguments of type TOP
    Modifier and Type | Method and Description
    --- | ---
    `TOP` | JCasHashMap.`putIfAbsent(int key, IntFunction<TOP> creator)`

  - ### Uses of TOP in org.apache.uima.jcas.tcas

    Subclasses of TOP in org.apache.uima.jcas.tcas
    Modifier and Type | Class and 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 TOP in org.apache.uima.spi

    Methods in org.apache.uima.spi that return types with arguments of type TOP
    Modifier and Type | Method and Description
    --- | ---
    `List<Class<? extends TOP>>` | JCasClassProvider.`listJCasClasses()`

  - ### Uses of TOP in org.apache.uima.util

    Methods in org.apache.uima.util with parameters of type TOP
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | CasCopier.`alreadyCopied(TOP aFS)` Note: if lenient is in effect, this method will return false for FSs which are not copied because the target doesn't have that type.

  - ### Uses of TOP in org.apache.uima.util.impl

    Fields in org.apache.uima.util.impl declared as TOP
    Modifier and Type | Field and Description
    --- | ---
    `static TOP[]` | Constants.`EMPTY_TOP_ARRAY`

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