Uses of Class
org.apache.uima.jcas.cas.TOP
Package
Description
Common Analysis System(CAS) Interfaces
Implementation and Low-Level API for the CAS Interfaces.
Interfaces for accessing the JCAS.
JCAS model for built-in CAS types
Provides the classes that support the Java Cas Model (JCM).
Utility classes and interfaces used by UIMA components.
-
Uses of TOP in org.apache.uima.cas
Modifier and TypeMethodDescriptiondefault <T extends TOP>
CommonArrayFS<T>CAS.emptyArray
(Class<T> clazz) default <T extends TOP>
EmptyFSList<T>CAS.emptyFSList()
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).CAS.getCasType
(Class<T> clazz) 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.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()
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.<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>
voidFSIndexRepository.removeAllExcludingSubtypes
(Class<T> clazz) Remove all instances of just this type, excluding subtypes, from all indexes in the repository view.default <T extends TOP>
voidFSIndexRepository.removeAllIncludingSubtypes
(Class<T> clazz) Remove all instances of type, including all subtypes from all indexes in the repository view.CAS.select()
CAS.select
(int jcasType) <T extends TOP>
T[]ArrayFS.toArray
(T[] a) Populates an existing array from this FS Array.Modifier and TypeMethodDescription<T extends TOP>
T[]ArrayFS.toArray
(T[] a) Populates an existing array from this FS Array.Modifier and TypeMethodDescriptiondefault Collection<TOP>
CAS.getIndexedFSs()
Returns an unmodifiable collection of all of the FSs that are indexed in this view, in an arbitrary order.Modifier and TypeMethodDescriptionPositions to the fs using moveTo(fs).Positions to the fs using moveTo(fs), followed by a shifted(offset).Positions to the fs using moveTo(fs).Positions to the fs using moveTo(fs), followed by a shifted(offset).SelectFSs.singleOrNull
(TOP fs) Positions to the fs using moveTo(fs).SelectFSs.singleOrNull
(TOP fs, int offset) Positions to the fs using moveTo(fs), followed by a shifted(offset).Starting Position specification - For ordered sources, specifies which FS to start at.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. -
Uses of TOP in org.apache.uima.cas.impl
Modifier and TypeFieldDescriptionprotected final 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 final Comparator<TOP>
FsIndex_singletype.comparatorNoTypeWithID
comparator (with id) (ignoring typeorder) - used within one typeprotected final 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 ignoredprotected final Comparator<TOP>
FsIndex_singletype.comparatorWithID
protected final Comparator<TOP>
FsIndex_singletype.comparatorWithoutID
static final Comparator<TOP>
LowLevelIndex.FS_ID_COMPARATOR
CasSerializerSupport.CasDocSerializer.modifiedEmbeddedValueFSs
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.CasSerializerSupport.CasDocSerializer.previouslySerializedFSs
final 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 idCasSerializerSupport.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.Modifier and TypeMethodDescription<N extends TOP>
NFeatureStructureImplC._maybeGetBaseForPearFs()
Called to convert to the base FS from a Pear versionprotected <N extends TOP>
NFeatureStructureImplC._maybeGetBaseForPearFs
(N v) Called when setting a FS value which might be a trampoline<N extends TOP>
NFeatureStructureImplC._maybeGetPearFs()
protected <N extends TOP>
NFeatureStructureImplC._maybeGetPearFs
(N v) Called when getting a FS value which might need to return a Pear context's trampoline<T extends TOP>
voidFSIndexRepositoryImpl.addback
(T fs) <T extends TOP>
TCASImpl.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>
TCASImpl.getFsFromId
(int id) final <T extends TOP>
TCASImpl.getFsFromId_checked
(int fsRef) <T extends TOP>
Collection<T>FSIndexRepositoryImpl.getIndexedFSs
(Class<T> clazz) <T extends TOP>
Collection<T>FSIndexRepositoryImpl.getIndexedFSs
(Type type) <T extends TOP>
TCASImpl.ll_getFSForRef
(int id) <T extends TOP>
TLowLevelCAS.ll_getFSForRef
(int fsRef) Return a FS object that corresponds to a low-level reference.Modifier and TypeMethodDescriptionFeatureStructureImplC._getFeatureValueNc
(int adjOffset) FeatureStructureImplC._getFeatureValueNc
(FeatureImpl feat) CASImpl.createArray
(TypeImpl array_type, int arrayLength) TOP[]
XmiSerializationSharedData.getAndSortByIdAllFSsInIdMap()
Get all FS Addresses that have been added to the id map.XmiSerializationSharedData.getEncompassingFS
(TOP nonsharedFS) FeatureStructureImplC.getFeatureValue
(Feature feat) 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()
CasSeqAddrMaps.getSrcFsFromTgtSeq
(int seq) Modifier and TypeMethodDescriptionFSIndexRepositoryImpl.getAddedFSs()
FSIndexRepositoryImpl.getAnnotationFsComparator
(FSComparators withId, FSComparators withTypeOrder) FSIndexRepositoryImpl.getAnnotationFsComparatorWithoutId()
FsIndex_singletype.getComparator()
FsIndex_snapshot.getComparator()
FsIterator_subtypes_ordered.getComparator()
FsIterator_subtypes_snapshot.getComparator()
FSIteratorImplBase.getComparator()
default implementation of getComparatorLowLevelIndex.getComparator()
LowLevelIterator_empty.getComparator()
LowLevelIterator.getComparator()
Subiterator.getComparator()
FSIndexRepositoryImpl.getDeletedFSs()
FSIndexRepositoryImpl.getIndexedFSs()
FSIndexRepositoryImpl.getIndexes()
FSIndexRepositoryImpl.getNonSetSingleIndexForType
(int typecode) FSIndexRepositoryImpl.getNonSetSingleIndexForUsedType
(int i) FSIndexRepositoryImpl.getReindexedFSs()
FSIndexRepositoryImpl.getUpdatedFSs
(Set<TOP> items) Id2FS.iterator()
FSIndexRepositoryImpl.streamNonEmptyIndexes
(Class<? extends TOP> clazz) FSIndexRepositoryImpl.streamNonEmptyIndexes
(Type type) Stream instances of all of the non-empty indexes themselvesCASImpl.walkReachablePlusFSsSorted
(Consumer<TOP> action_filtered, MarkerImpl mark, Predicate<TOP> includeFilter, CasTypeSystemMapper typeMapper) find all of the FSs via the indexes plus what's reachable.Modifier and TypeMethodDescriptionvoid
Add a new FS id - done during prescan of source during serialization Must call in heap scan ordervoid
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 addstatic CommonArrayFS
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
Encode an individual FS.XmiSerializationSharedData.getEncompassingFS
(TOP nonsharedFS) static int
BinaryCasSerDes.getFsSpaceReq
(TOP fs, TypeImpl type) int
TypeImpl.getFsSpaceReq
(TOP fs) final int
CASImpl.getNextFsId
(TOP fs) XmiSerializationSharedData.getOutOfTypeSystemFeatures
(TOP fs) Gets information about out-of-typesystem features that belong to an in-typesystem 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 blockstatic 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 deserializingfinal void
CASImpl.setWithCheckAndJournal
(TOP fs, int featCode, Runnable setter) SelectFSs_impl.singleOrNull
(TOP fs) SelectFSs_impl.singleOrNull
(TOP fs, int offset) CasCompare.sort_dedup_FSArray
(TOP fs, Feature feat) This is an optional pre-compare operation.protected abstract void
CasSerializerSupport.CasSerializerSupportSerialize.writeArrays
(TOP fsarray, int typeCode, int typeClass) protected abstract void
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) Modifier and TypeMethodDescriptionvoid
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 final 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 final 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) FSIndexRepositoryImpl.getUpdatedFSs
(Set<TOP> items) FSIndexRepositoryImpl.streamNonEmptyIndexes
(Class<? extends TOP> clazz) 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.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.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) ModifierConstructorDescriptionCasSeqAddrMaps
(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) 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
Modifier and TypeClassDescriptionclass
Stores detailed information about the original source document from which the current CAS was initialized. -
Uses of TOP in org.apache.uima.jcas
Modifier and TypeMethodDescriptiondefault <T extends TOP>
CommonArrayFSJCas.emptyArray
(Class<T> clazz) 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()
<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).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
(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).Retrieve an index according to a label and a type specified using a JCas class.Retrieve an index according to a label.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>
TJCas.getJfsFromCaddr
(int casAddr) default <T extends TOP>
voidJCas.removeAllExcludingSubtypes
(Class<T> clazz) Remove all instances of just this type, excluding subtypes, from all indexes in the repository view.default <T extends TOP>
voidJCas.removeAllIncludingSubtypes
(Class<T> clazz) Remove all instances of type, including all subtypes from all indexes in the repository view.JCas.select()
JCas.select
(int jcasType) Modifier and TypeMethodDescriptionJCasRegistry.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.JFSIndexRepository.getIndexes()
Get all indexes in this repository.Modifier and TypeMethodDescriptionDeprecated.use instance.jcasType instead - faster -
Uses of TOP in org.apache.uima.jcas.cas
Modifier and TypeClassDescriptionclass
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(...) APIsclass
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.xmlclass
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.xmlclass
T extends TOP, v2 already mandated TOP for set/getclass
A map from ints to Feature Structures Is Pear aware - stores non-pear versions but may return pear version in pear contextsclass
NonEmptyFSList<T extends TOP>
Modifier and TypeClassDescriptionclass
the JCas class model for the CAS type uima.cas.AnnotationBase.final class
JCas class model for BooleanArrayfinal class
JCas class model for ByteArrayfinal class
JCas class model for DoubleArrayclass
class
EmptyFSList<T extends TOP>
class
class
final class
Java Cas model for Cas FloatArray.class
final 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(...) APIsclass
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.xmlclass
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.xmlclass
T extends TOP, v2 already mandated TOP for set/getclass
A map from ints to Feature Structures Is Pear aware - stores non-pear versions but may return pear version in pear contextsfinal class
The Java Class model corresponding to the Cas IntegerArray_JCasImpl type.class
An ArrayList type containing ints, for UIMA - implements a subset of the List API, Iterable<Integer>, IntListIterator.class
final class
JCas class model for LongArrayclass
class
NonEmptyFSList<T extends TOP>
class
class
final class
JCas class model for ShortArrayclass
final class
JCas class model for StringArrayclass
Modifier and TypeFieldDescriptionstatic final TOP
TOP._singleton
Internal use - used as removed marker in mapsModifier and TypeMethodDescriptionstatic <E extends TOP,
F extends FeatureStructure>
FSArrayList<E>Convenience - create a FSArrayList from an existing Array.static <U extends TOP,
E extends FeatureStructure>
FSList<U>Create an FSList from an existing array of Feature Structures<U extends TOP>
U[]FSArray.toArray
(U[] a) Modifier and TypeMethodDescriptionstatic TOP
TOP._createJCasHashMapReserve
(int id) for internal use only, creates a reserved markerstatic TOP
TOP._createSearchKey
(int id) TOP[]
FSArray._getTheArray()
T[]
FSHashSet._toArrayForSelect()
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<U extends TOP>
U[]FSArray.toArray
(U[] a) TOP[]
FSArrayList.toArray()
returns TOP[] because can't make array of T Note: converts to pear trampolines.T[]
FSHashSet.toArray()
ModifierConstructorDescriptionConstructs 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
Modifier and TypeMethodDescription<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) Modifier and TypeMethodDescriptionfinal TOP
JCasHashMap.get
(int key) JCasImpl.getDocumentAnnotationFs()
final TOP
final TOP
JCasHashMap.putIfAbsent
(int key, IntFunction<TOP> creator) Modifier and TypeMethodDescriptionfinal TOP
JCasHashMap.putIfAbsent
(int key, IntFunction<TOP> creator) -
Uses of TOP in org.apache.uima.jcas.tcas
Modifier and TypeClassDescriptionclass
the JCas class model for the CAS type uima.cas.Annotation.class
The JCas class definition for the CASDocumentAnnotation
type. -
Uses of TOP in org.apache.uima.spi
-
Uses of TOP in org.apache.uima.util
Modifier and TypeMethodDescriptionboolean
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