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

- Packages that use TOP
  Package | Description
  --- | ---
  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 | JCAS model for built-in TCAS types

- - ### 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
    --- | ---
    `<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).
    `<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.
    `<T extends TOP> T` | JCas.`getJfsFromCaddr(int casAddr)`

    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)` Gets the JCas cover class for a given index.
    `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

    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`
    `class` | `EmptyIntegerList`
    `class` | `EmptyStringList`
    `class` | `FloatArray` Java Cas model for Cas FloatArray.
    `class` | `FloatList`
    `class` | `FSArray` Java Class model for Cas FSArray type
    `class` | `FSList`
    `class` | `IntegerArray` The Java Class model corresponding to the Cas IntegerArray_JCasImpl type.
    `class` | `IntegerList`
    `class` | `LongArray` JCas class model for LongArray
    `class` | `NonEmptyFloatList`
    `class` | `NonEmptyFSList`
    `class` | `NonEmptyIntegerList`
    `class` | `NonEmptyStringList`
    `class` | `ShortArray` JCas class model for ShortArray
    `class` | `Sofa` Updated by JCasGen Fri Apr 29 16:05:04 EDT 2005
    `class` | `StringArray` JCas class model for StringArray
    `class` | `StringList`

    Methods in org.apache.uima.jcas.cas that return TOP
    Modifier and Type | Method and Description
    --- | ---
    `TOP` | NonEmptyFSList.`getHead()`
    `TOP` | FSList.`getNthElement(int i)`

    Methods in org.apache.uima.jcas.cas that return types with arguments of type TOP
    Modifier and Type | Method and Description
    --- | ---
    `Iterator<TOP>` | FSList.`iterator()`
    `Iterator<TOP>` | NonEmptyFSList.`iterator()`

    Methods in org.apache.uima.jcas.cas with parameters of type TOP
    Modifier and Type | Method and Description
    --- | ---
    `NonEmptyFSList` | FSList.`push(TOP item)` pushes item onto front of this list
    `void` | NonEmptyFSList.`setHead(TOP v)`

    Constructors in org.apache.uima.jcas.cas with parameters of type TOP
    Constructor and Description
    `NonEmptyFSList(JCas jcas, TOP item, FSList tail)`

  - ### 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)`
    `<T extends TOP> T` | JCasImpl.`getJfsFromCaddr(int casAddr)`

    Methods in org.apache.uima.jcas.impl that return TOP
    Modifier and Type | Method and Description
    --- | ---
    `TOP` | JCasImpl.`getDocumentAnnotationFs()`

    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()`

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

    Method parameters in org.apache.uima.jcas.impl with type arguments of type TOP
    Modifier and Type | Method and Description
    --- | ---
    `Type` | JCasImpl.`getCasType(Class<? extends TOP> clazz)` Return the UIMA Type object corresponding to this JCas's JCas cover class (Note: different JCas's, with different type systems, may share the same cover class impl)

  - ### 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.

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