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.tcas
org.apache.uima.util	Utility classes and interfaces used by UIMA components.

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)
<U extends TOP> U	ArrayFS.get(int i) Get the i-th feature structure from the array.
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.
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(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(Type type) Returns an unmodifiable 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> 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

Methods in org.apache.uima.cas.impl that return TOP

Modifier and Type	Method and Description
TOP[]	XmiSerializationSharedData.getAndSortByIdAllFSsInIdMap() Get all FS Addresses that have been added to the id map.
TOP	XmiSerializationSharedData.getEncompassingFS(TOP nonsharedFS)
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()

Methods in org.apache.uima.cas.impl with parameters of type TOP

Modifier and Type	Method and Description
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.
TOP	XmiSerializationSharedData.getEncompassingFS(TOP nonsharedFS)
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)

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> 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).
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> 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.
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	FSList<T extends TOP> T extends TOP, v2 already mandated TOP for set/get
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	FSList<T extends TOP> T extends TOP, v2 already mandated TOP for set/get
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.get(int i) return the indexed value from the corresponding Cas FSArray as a Java Model object.
<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)

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