Uses of Interface
org.apache.uima.cas.FeatureStructure
Packages that use FeatureStructure
Package
Description
Common Analysis System(CAS) Interfaces
Implementation and Low-Level API for the CAS Interfaces.
Text Common Annotation System (TCAS) 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 FeatureStructure in org.apache.uima.cas
Classes in org.apache.uima.cas with type parameters of type FeatureStructureModifier and TypeInterfaceDescriptioninterface
ArrayFS<E extends FeatureStructure>
Feature structure array interface.interface
FSIndex<T extends FeatureStructure>
Feature structure index access interface.interface
FSIterator<T extends FeatureStructure>
Iterator over feature structures.interface
SelectFSs<T extends FeatureStructure>
Collection of builder style methods to specify selection of FSs from indexes Documentation is in a chapter in the UIMA Version 3 User's Guide.Subinterfaces of FeatureStructure in org.apache.uima.casModifier and TypeInterfaceDescriptioninterface
Annotation Base API.interface
ArrayFS<E extends FeatureStructure>
Feature structure array interface.interface
Boolean array interface.interface
Byte array interface.interface
Common parts of the Array interfaces.interface
Double array interface.interface
Interface for CAS float arrays.interface
Interface for CAS int arrays.interface
Long array interface.interface
Short array interface.interface
Interface for "Subject of Analysis" (Sofa) feature structures.interface
String array interface.Methods in org.apache.uima.cas with type parameters of type FeatureStructureModifier and TypeMethodDescription<T extends FeatureStructure>
voidFSIndexRepository.addFS
(T fs) Add a feature structure to all appropriate indexes in the repository.<T extends FeatureStructure>
voidArrayFS.copyFromArray
(T[] src, int srcOffset, int destOffset, int length) Copy the contents of an external array into this array.<U extends FeatureStructure>
voidArrayFS.copyToArray
(int srcOffset, U[] dest, int destOffset, int length) Copy the contents of the array fromstart
toend
to the destinationdestArray
with destination offsetdestOffset
.<T extends FeatureStructure>
FSIterator<T> CAS.createFilteredIterator
(FSIterator<T> it, FSMatchConstraint cons) Create an iterator over structures satisfying a given constraint.<T extends FeatureStructure>
TCreate a new FeatureStructure.default <T extends FeatureStructure>
FSArray<T> CAS.emptyFSArray()
default <T extends FeatureStructure>
FSArray<T> CAS.emptyFSArray
(Type type) <T extends FeatureStructure>
ListIterator<T> CAS.fs2listIterator
(FSIterator<T> it) Wrap a standard JavaListIterator
around an FSListIterator.<U extends FeatureStructure>
UArrayFS.get
(int i) Get the i-th feature structure from the array.default <T extends FeatureStructure>
FSIterator<T> FSIndexRepository.getAllIndexedFS
(Class<T> clazz) Gets an FSIterator over all indexed (in this view) FeatureStructures of the specified Type (and any of its subtypes).<T extends FeatureStructure>
FSIterator<T> FSIndexRepository.getAllIndexedFS
(Type aType) Gets an iterator over all indexed (in this View) FeatureStructures of the specified Type (and any of its subtypes).<T extends FeatureStructure>
FSIndex<T> Retrieve an index according to a label.<T extends FeatureStructure>
FSIndex<T> Retrieve an index according to a label and a type.<T extends FeatureStructure>
Iterator<FSIndex<T>> FSIndexRepository.getIndexes()
Get all indexes in this repository.<T extends FeatureStructure>
Iterator<LowLevelIndex<T>> FSIndexRepository.ll_getIndexes()
Get all indexes in this repository as low level indexes<T extends FeatureStructure>
voidFSIndexRepository.removeFS
(T fs) Remove a feature structure from all indexes in the repository.static <U extends FeatureStructure>
SelectFSs<U> Use this static method to capture the generic argumentMethods in org.apache.uima.cas that return FeatureStructureModifier and TypeMethodDescriptionT[]
FeatureStructure.getFeatureValue
(Feature feat) Get a feature value.FeaturePath.getFSValue
(FeatureStructure fs) Returns the FeatureStructure of a FeatureStructure valued feature path.SofaFS.getLocalFSData()
Get the Local Subject of Analysis returns null if not previously set.CAS.getSofaDataArray()
Get the Sofa data array.ArrayFS.toArray()
Creates a new array the this array is copied to.Methods in org.apache.uima.cas with parameters of type FeatureStructureModifier and TypeMethodDescriptionvoid
CAS.addFsToIndexes
(FeatureStructure fs) Add a feature structure to all appropriate indexes in the repository associated with this CAS View.int
FSIndex.compare
(FeatureStructure fs1, FeatureStructure fs2) Compare two feature structures according to the ordering relation of the index.boolean
FSIndex.contains
(FeatureStructure fs) Check if the index contains an element equal to the given feature structure according to the comparators defined for this index.<T extends FeatureStructure>
voidArrayFS.copyFromArray
(T[] src, int srcOffset, int destOffset, int length) Copy the contents of an external array into this array.<U extends FeatureStructure>
voidArrayFS.copyToArray
(int srcOffset, U[] dest, int destOffset, int length) Copy the contents of the array fromstart
toend
to the destinationdestArray
with destination offsetdestOffset
.FSIndex.find
(FeatureStructure fs) Find an entry in the index "equal to" the given feature structure according to the comparators specified for this index.SelectFSs.get
(FeatureStructure fs) Positions to the fs using moveTo(fs).SelectFSs.get
(FeatureStructure fs, int offset) Positions to the fs using moveTo(fs), followed by a shifted(offset).FeaturePath.getBooleanValue
(FeatureStructure fs) Returns the Boolean value of a boolean valued feature path.FeaturePath.getByteValue
(FeatureStructure fs) Returns the Byte value of a byte valued feature path.FeaturePath.getDoubleValue
(FeatureStructure fs) Returns the Double value of a double valued feature path.FeaturePath.getFloatValue
(FeatureStructure fs) Returns the Float value of a float valued feature path.FeaturePath.getFSValue
(FeatureStructure fs) Returns the FeatureStructure of a FeatureStructure valued feature path.FeaturePath.getIntValue
(FeatureStructure fs) Returns the Integer value of an integer valued feature path.FeaturePath.getLongValue
(FeatureStructure fs) Returns the Long value of a long valued feature path.FeaturePath.getShortValue
(FeatureStructure fs) Returns the Short value of a short valued feature path.FeaturePath.getStringValue
(FeatureStructure fs) Returns the String value of a string valued feature path.FeaturePath.getTypClass
(FeatureStructure fs) Deprecated.use getTypeClass (spelling fix)FeaturePath.getType
(FeatureStructure fs) Returns the type of the feature path.FeaturePath.getTypeClass
(FeatureStructure fs) Returns the type class of the feature path.FeaturePath.getValueAsString
(FeatureStructure fs) Returns the feature path value as string for the given FeatureStructure.boolean
Marker.isModified
(FeatureStructure fs) Test if a FeatureStructure in a CAS represented by thisMarker
existed before the mark was set, and has been modified.boolean
Marker.isNew
(FeatureStructure fs) default FSIterator
<T> FSIndex.iterator
(FeatureStructure fs) Return an iterator over the index.boolean
FSMatchConstraint.match
(FeatureStructure fs) Match against feature structures.void
FSIterator.moveTo
(FeatureStructure fs) Move the iterator to the first Feature Structure that matches thefs
.void
CAS.removeFsFromIndexes
(FeatureStructure fs) Remove a feature structure from all indexes in the repository associated with this CAS View.void
FeatureStructure.setFeatureValue
(Feature feat, FeatureStructure fs) Set a feature value to another FS.void
SofaFS.setLocalSofaData
(FeatureStructure aFS) Set the Local Subject of Analysis to be a predefined ArrayFS.void
CAS.setSofaDataArray
(FeatureStructure array, String mime) Set the Sofa data as an ArrayFS.SelectFSs.single
(FeatureStructure fs) Positions to the fs using moveTo(fs).SelectFSs.single
(FeatureStructure fs, int offset) Positions to the fs using moveTo(fs), followed by a shifted(offset).SelectFSs.singleOrNull
(FeatureStructure fs) Positions to the fs using moveTo(fs).SelectFSs.singleOrNull
(FeatureStructure fs, int offset) Positions to the fs using moveTo(fs), followed by a shifted(offset).SelectFSs.startAt
(FeatureStructure fs) Starting Position specification - For ordered sources, specifies which FS to start at.SelectFSs.startAt
(FeatureStructure fs, int shift) Starting Position specification - A combination of startAt followed by a shift Requires an ordered index not necessarily AnnotationIndex, not necessarily sorted This versions avoids a runtime cast check. -
Uses of FeatureStructure in org.apache.uima.cas.admin
Methods in org.apache.uima.cas.admin with parameters of type FeatureStructureModifier and TypeMethodDescriptionint
LinearTypeOrder.compare
(FeatureStructure fs1, FeatureStructure fs2) Compare two Feature Structure's types -
Uses of FeatureStructure in org.apache.uima.cas.impl
Classes in org.apache.uima.cas.impl with type parameters of type FeatureStructureModifier and TypeInterfaceDescriptioninterface
CopyOnWriteIndexPart<T extends FeatureStructure>
common APIs supporting the copy on write aspect of index parts(package private) class
FilteredIterator<T extends FeatureStructure>
Implements a filtered iterator.interface
FSGenerator<T extends FeatureStructure>
Deprecated.unused in v3, only present to avoid compile errors in unused v2 classesclass
FsIndex_bag<T extends FeatureStructure>
Used for UIMA FS Bag Indexes Uses ObjHashSet to hold instances of FeatureStructuresclass
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(package private) class
FsIndex_iicp<T extends FeatureStructure>
FsIndex_iicp (iicp) A pair of an leaf index and an iterator cache.final 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(package private) class
FsIterator_aggregation_common<T extends FeatureStructure>
Aggregate several FS iterators.(package private) class
FsIterator_backwards<T extends FeatureStructure>
Wraps FSIterator, runs it backwards (package private) class
FsIterator_bag<T extends FeatureStructure>
(package private) class
FsIterator_bag_pear<T extends FeatureStructure>
This version of the FsIterator is used while iterating within a PEAR Indexes keep references to the base (possibly non-pear) version of FSs.(package private) class
FsIterator_limited<T extends FeatureStructure>
Wraps FSIterator, limits results to n gets. class
FsIterator_multiple_indexes<T extends FeatureStructure>
Common code for both aggregation of indexes (e.g.(package private) class
FsIterator_set_sorted_pear<T extends FeatureStructure>
(package private) class
FsIterator_set_sorted2<T extends FeatureStructure>
An iterator for a single type for a set or sorted index NOTE: This is the version used for set/sorted iterators It is built directly on top of a CopyOnWrite wrapper for OrderedFsSet_array It uses the version of OrdereFsSet_array that has no embedded nullsclass
FsIterator_singletype<T extends FeatureStructure>
class
FsIterator_subtypes_ordered<T extends FeatureStructure>
Performs an ordered iteration among a set of iterators, each one corresponding to the type or subtype of the uppermost type.class
FsIterator_subtypes_snapshot<T extends FeatureStructure>
class
FSIteratorImplBase<T extends FeatureStructure>
Version 2 compatibility only, not used internally in version 3 Base class for FSIterator implementations.class
LLUnambiguousIteratorImpl<T extends FeatureStructure>
Implements a low level ambiguous or unambiguous iterator over some type T which doesn't need to be a subtype of Annotation.interface
LowLevelIndex<T extends FeatureStructure>
Low-level FS index object.interface
LowLevelIterator<T extends FeatureStructure>
Low-level FS iterator.class
LowLevelIterator_empty<T extends FeatureStructure>
An empty Low-level FS iteratorclass
SelectFSs_impl<T extends FeatureStructure>
Collection of builder style methods to specify selection of FSs from indexes shift handled in this routine Comment codes: AI = implies AnnotationIndex Iterator varieties and impl bounded? type order not unambig? strict? skipEq Priority? Needed? no coveredBy covering sameas for not-bounded, - ignore strict and skipEq -- except: preceding implies skipping annotations whose end > positioning begin - order-not-needed only applies if iicp size > 1 - unambig ==> use Subiterator -- subiterator wraps: according to typePriority and order-not-needed - no Type Priority - need to pass in as arg to fsIterator_multiple_indexes == if no type priority, need to prevent rattling off the == type while compare is equal == affects both FsIterator_aggregation_common and FsIterator_subtypes_ordered for 3 other boundings: - use subiterator, pass in strict and skipeq finish this javadoc comment edit T extends FeatureStructure, not TOP, because of ref from FSIndex which uses FeatureStructure for backwards compatibilitySubinterfaces of FeatureStructure in org.apache.uima.cas.implModifier and TypeInterfaceDescriptioninterface
Deprecated.use AnnotationBase insteadinterface
Deprecated.use Annotation insteadinterface
Deprecated.use BooleanArray insteadinterface
Deprecated.use ByteArray insteadinterface
Deprecated.interface
Deprecated.use DoubleArray insteadinterface
Deprecated.use TOP insteadinterface
Deprecated.use FloatArray insteadinterface
Deprecated.use IntegerArray insteadinterface
Deprecated.use LongArray insteadinterface
Deprecated.use ShortArray insteadinterface
Deprecated.use Sofa insteadinterface
Deprecated.use StringArray insteadClasses in org.apache.uima.cas.impl that implement FeatureStructureModifier and TypeClassDescriptionclass
Feature structure implementation (for non JCas and JCas) Each FS has - int data - used for boolean, byte, short, int, long, float, double data -- long and double use 2 int slots - may be null if all slots are in JCas cover objects as fields - ref data - used for references to other Java objects, such as -- strings -- other feature structures -- arbitrary Java Objects - may be null if all slots are in JCas cover objects as fields - an id: an incrementing integer, starting at 1, per CAS, of all FSs created for that CAS - a ref to the casView where this FS was created - a ref to the TypeImpl for this class -- can't be static - may be multiple type systems in useFields in org.apache.uima.cas.impl declared as FeatureStructureModifier and TypeFieldDescriptionprivate FeatureStructure[]
DebugFSLogicalStructure.UnexpandedFeatureStructures.items
private final T[]
FsIterator_subtypes_snapshot.snapshot
private FeatureStructure[]
SelectFSs_impl.sourceFSArray
Fields in org.apache.uima.cas.impl with type parameters of type FeatureStructureModifier and TypeFieldDescriptionstatic final LowLevelIterator
<FeatureStructure> LowLevelIterator.FS_ITERATOR_LOW_LEVEL_EMPTY
an empty iteratorDebugFSLogicalStructure.IndexInfo.fsIndex
private FSIndex
<? extends FeatureStructure> DebugFSLogicalStructure.UnexpandedFeatureStructures.fsIndex
private Set
<FeatureStructure> FeatureStructureImplC.PrintReferences.seen
private Map
<FeatureStructure, String> FeatureStructureImplC.PrintReferences.tree
Methods in org.apache.uima.cas.impl with type parameters of type FeatureStructureModifier and TypeMethodDescriptionprivate <T extends FeatureStructure>
voidFSIndexRepositoryImpl.addDirectSubtypes
(TypeImpl type, List<LowLevelIterator<T>> iteratorList) <T extends FeatureStructure>
voidFSIndexRepositoryImpl.addFS
(T fs) <T extends FeatureStructure>
FSIterator<T> CASImpl.createFilteredIterator
(FSIterator<T> it, FSMatchConstraint cons) <T extends FeatureStructure>
TCreate the appropriate Feature Structure Java instance - from whatever the generator for this type specifies.(package private) <T extends FeatureStructure>
voidFSIndexRepositoryImpl.createIndex
(FSIndexRepositoryImpl baseIndexRepo, String key) create indexes in a view, by copying the baseCas's index repository's definitions Called when creating or refreshing (after deserializing) a view<T extends FeatureStructure>
booleanFSIndexRepositoryImpl.createIndexNoQuestionsAsked
(FSIndexComparator comp, String label, int indexType) This is public only until the xml specifier format supports specifying index kinds (set, bag etc.).<T extends FeatureStructure>
FSArray<T> CASImpl.emptyFSArray()
<T extends FeatureStructure>
FSArray<T> CASImpl.emptyFSArray
(Type type) <T extends FeatureStructure>
ListIterator<T> CASImpl.fs2listIterator
(FSIterator<T> it) <T extends FeatureStructure>
LowLevelIterator<T> FSIndexRepositoryImpl.getAllIndexedFS
(Type type) private final <T extends FeatureStructure>
voidFSIndexRepositoryImpl.getAllIndexedFS
(Type type, List<LowLevelIterator<T>> iteratorList) <T extends FeatureStructure>
LowLevelIndex<T> <T extends FeatureStructure>
FSIndex<T> <T extends FeatureStructure>
FsIndex_iicp<T> FSIndexRepositoryImpl.getIndexBySpec
(int typeCode, int indexingStrategy, FSIndexComparatorImpl comp) Get the FsIndex_iicp for a given typeCode, indexingStrategy, and comparator (type ignored)(package private) <T extends FeatureStructure>
FsIndex_iicp<T> FSIndexRepositoryImpl.IndexesForType.getIndexExcludingType
(int indexingStrategy, FSIndexComparatorImpl comparatorForIndexSpecs) <T extends FeatureStructure>
Iterator<String> FSIndexRepositoryImpl.getLabels
(FSIndexComparator comp) Get the labels for a specific comparator.<T extends FeatureStructure>
LowLevelIterator<T> FSIndexRepositoryImpl.ll_getAllIndexedFS
(Type type) <T extends FeatureStructure>
LowLevelIndex<T> FSIndexRepositoryImpl.ll_getIndex
(String indexName) <T extends FeatureStructure>
LowLevelIndex<T> FSIndexRepositoryImpl.ll_getIndex
(String indexName, int typeCode) <T extends FeatureStructure>
LowLevelIndex<T> LowLevelIndexRepository.ll_getIndex
(String indexName) Get an index by its name.<T extends FeatureStructure>
LowLevelIndex<T> LowLevelIndexRepository.ll_getIndex
(String indexName, int typeCode) Get an index by a name and type.(package private) static <T extends FeatureStructure>
TCASImpl.pearConvert
(T aFs) Convert base FS to Pear equivalent 3 cases: 1) no trampoline needed, no conversion, return the original fs 2) trampoline already exists - return that one 3) create new trampolineMethods in org.apache.uima.cas.impl that return FeatureStructureModifier and TypeMethodDescriptionT[]
private T[]
SelectFSs_impl.asArray
(LowLevelIterator<T> it, Class<? super T> clazz) This is a terminal operation, so can use/modify the original iteratorstatic FeatureStructure[]
DebugFSLogicalStructure.getDebugLogicalStructure_SubAnnotations
(AnnotationFS fs) (package private) FeatureStructure[]
FsIndex_flat.getFlatArray()
FeaturePathImpl.getFSValue
(FeatureStructure fs) private static FeatureStructure[]
DebugFSLogicalStructure.getIndexContents
(FSIndex<? extends FeatureStructure> fsIndex) private static FeatureStructure[]
DebugFSLogicalStructure.getIndexContents
(FSIterator<? extends FeatureStructure> it) DebugFSLogicalStructure.UnexpandedFeatureStructures.getItems()
final FeatureStructure
CASImpl.getRefArrayValue
(FSArray array, int i) CASImpl.getSofaDataArray()
Methods in org.apache.uima.cas.impl with parameters of type FeatureStructureModifier and TypeMethodDescriptionvoid
FeatureStructureImplC._setFeatureValueNcWj
(int adjOffset, FeatureStructure v) Nc - no check, Wj = with journaling if neededvoid
CASImpl.addFsToIndexes
(FeatureStructure fs) (package private) boolean
FeatureStructureImplC.PrintReferences.addReference
(FeatureStructure fs) protected final void
FsIndex_singletype.assertFsTypeMatchesIndexType
(FeatureStructure fs, String operation) void
CASImpl.commitFS
(FeatureStructure fs) Deprecated.int
FSComparator.compare
(FeatureStructure fs1, FeatureStructure fs2) Compare two FSs.int
FsIndex_bag.compare
(FeatureStructure fs1, FeatureStructure fs2) Override the super impl which uses comparators.int
FsIndex_flat.compare
(FeatureStructure fs1, FeatureStructure fs2) int
FsIndex_iicp.compare
(FeatureStructure fs1, FeatureStructure fs2) int
FsIndex_set_sorted.compare
(FeatureStructure o1, FeatureStructure o2) abstract int
FsIndex_singletype.compare
(FeatureStructure o1, FeatureStructure o2) This is required to avoid compilation error (but not in Eclipse) due to ambiguous interface inheritance from both FeatureStructure and Comparator(package private) int
FsIndex_singletype.compare
(FeatureStructure afs1, FeatureStructure afs2, boolean ignoreType) int
FsIndex_snapshot.compare
(FeatureStructure o1, FeatureStructure o2) private int
FsIterator_subtypes_ordered.compare
(FeatureStructure fsLeft, FeatureStructure fsRight) Only used to compare two iterator's with different types positionint
FsIterator_subtypes_snapshot.compare
(FeatureStructure fs1, FeatureStructure fs2) int
LinearTypeOrderBuilderImpl.TotalTypeOrder.compare
(FeatureStructure fs1, FeatureStructure fs2) boolean
FsIndex_bag.contains
(FeatureStructure fs) boolean
FsIndex_flat.contains
(FeatureStructure fs) boolean
FsIndex_iicp.contains
(FeatureStructure fs) boolean
FsIndex_set_sorted.contains
(FeatureStructure templateKey) boolean
FsIndex_snapshot.contains
(FeatureStructure fs) int
CopyOnWriteIndexPart.copyToArray
(T[] target, int startingIndexInTarget) Copy FS refs to target from this index partprivate void
CASImpl.featModWhileInIndexReport
(FeatureStructure fs, int featCode) private void
CASImpl.featModWhileInIndexReport
(FeatureStructure fs, FeatureImpl fi) private static void
DebugFSLogicalStructure.fillFeatures
(DebugNameValuePair[] result, int startOffset, FeatureStructure fs, List<Feature> features) FsIndex_bag.find
(FeatureStructure fs) This is a silly method for bag indexes in V3, since dupl add to indexes is not allowed.FsIndex_flat.find
(FeatureStructure fs) FsIndex_iicp.find
(FeatureStructure fs) FsIndex_set_sorted.find
(FeatureStructure templateKey) find any arbitrary matching FS two comparators: cp, and cpx (has extra id comparing) First find an FS in the index that's the smallest that's GE to key using cpx - if none found, then all of the entries in the index are LessThan the key (using cpx); but one might be equal using cp -- if one or more would be equal using cp, it would be because the only reason for the inequality using cpx was due to the _id miscompare.FsIndex_snapshot.find
(FeatureStructure fs) static Object
DebugFSLogicalStructure.floatListToArray
(FeatureStructure fs) static Object
DebugFSLogicalStructure.fsListToArray
(FeatureStructure fs) SelectFSs_impl.get
(FeatureStructure fs) SelectFSs_impl.get
(FeatureStructure fs, int offset) FeaturePathImpl.getBooleanValue
(FeatureStructure fs) FeaturePathImpl.getByteValue
(FeatureStructure fs) static Object
DebugFSLogicalStructure.getDebugLogicalStructure_FeatureStructure
(FeatureStructure fs) FeaturePathImpl.getDoubleValue
(FeatureStructure fs) FeaturePathImpl.getFloatValue
(FeatureStructure fs) FeaturePathImpl.getFSValue
(FeatureStructure fs) FeaturePathImpl.getIntValue
(FeatureStructure fs) (package private) String
FeatureStructureImplC.PrintReferences.getLabel
(FeatureStructure ref) FeaturePathImpl.getLongValue
(FeatureStructure fs) FeaturePathImpl.getShortValue
(FeatureStructure fs) FeaturePathImpl.getStringValue
(FeatureStructure fs) FeaturePathImpl.getTypClass
(FeatureStructure fs) Deprecated.FeaturePathImpl.getType
(FeatureStructure fs) FeaturePathImpl.getTypeClass
(FeatureStructure fs) FeaturePathImpl.getValueAsString
(FeatureStructure fs) static Object
DebugFSLogicalStructure.integerListToArray
(FeatureStructure fs) boolean
CASImpl.isInCAS
(FeatureStructure fs) boolean
MarkerImpl.isModified
(FeatureStructure fs) boolean
MarkerImpl.isNew
(FeatureStructure fs) FsIndex_singletype.iterator
(FeatureStructure initialPositionFs) final int
CASImpl.ll_getFSRef
(FeatureStructure fs) Safety - any time the low level API to a FS is requested, hold on to that FS until CAS reset to mimic how v2 works.int
LowLevelCAS.ll_getFSRef
(FeatureStructure fsImpl) Get the low-level reference from an existing FS object.boolean
BooleanConstraint.match
(FeatureStructure fs) boolean
ConjunctiveConstraint.match
(FeatureStructure fs) boolean
DisjunctiveConstraint.match
(FeatureStructure fs) boolean
EmbeddedConstraint.match
(FeatureStructure fs) boolean
FloatConstraint.match
(FeatureStructure fs) boolean
FSTypeConstraintImpl.match
(FeatureStructure fs) boolean
IntConstraint.match
(FeatureStructure fs) boolean
StringConstraint.match
(FeatureStructure fs) default void
LowLevelIterator.moveTo
(FeatureStructure fs) void
SelectFSs_impl.SelectFSIterator.moveTo
(FeatureStructure aFs) private void
Subiterator.moveTo_iterators
(FeatureStructure fs, boolean initialPositioning) Move the sub iterator to the given position.private void
Subiterator.moveTo_listForm
(FeatureStructure fs) private void
FsIterator_set_sorted2.moveToLeftMost
(FeatureStructure fs) Starting at a position where the item is equal to fs using the compare without id, move to the leftmost one search opportunistically, starting at 1 before, 2, 4, 8, 16, etc.private void
FsIterator_set_sorted2.moveToLeftMostUp
(FeatureStructure fs, int upperValidPos) Must be possible to leave the pos == to upperValidPos.void
FilteredIterator.moveToNoReinit
(FeatureStructure fs) void
FsIterator_aggregation_common.moveToNoReinit
(FeatureStructure fs) MoveTo for this kind of iterator Happens for set or sorted indexes being operated without rattling, or for other kinds of aggregation.void
FsIterator_backwards.moveToNoReinit
(FeatureStructure fs) void
FsIterator_bag.moveToNoReinit
(FeatureStructure fs) void
FsIterator_limited.moveToNoReinit
(FeatureStructure fs) void
FsIterator_set_sorted2.moveToNoReinit
(FeatureStructure fs) void
FsIterator_subtypes_ordered.moveToNoReinit
(FeatureStructure fs) void
FsIterator_subtypes_snapshot.moveToNoReinit
(FeatureStructure fs) void
LowLevelIterator_empty.moveToNoReinit
(FeatureStructure fs) void
LowLevelIterator.moveToNoReinit
(FeatureStructure fs) Internal use same as moveTo(fs), but won't reset to use current contents of index if index has changedvoid
SelectFSs_impl.SelectFSIterator.moveToNoReinit
(FeatureStructure aFs) void
Subiterator.moveToNoReinit
(FeatureStructure fs) (package private) int
FeatureStructureImplC.PrintReferences.printInfo
(FeatureStructure ref) void
FSIndexRepositoryImpl.removeFS
(FeatureStructure fs) void
CASImpl.removeFsFromIndexes
(FeatureStructure fs) void
FeatureStructureImplC.setFeatureValue
(Feature feat, FeatureStructure v) void
CASImpl.setId2FSsMaybeUnconditionally
(FeatureStructure... fss) Test case usevoid
CASImpl.setSofaDataArray
(FeatureStructure array, String mime) SelectFSs_impl.single
(FeatureStructure fs) SelectFSs_impl.single
(FeatureStructure fs, int offset) SelectFSs_impl.singleOrNull
(FeatureStructure fs) SelectFSs_impl.singleOrNull
(FeatureStructure fs, int offset) SelectFSs_impl.startAt
(FeatureStructure fs) SelectFSs_impl.startAt
(FeatureStructure fs, int offset) static Object
DebugFSLogicalStructure.stringListToArray
(FeatureStructure fs) Method parameters in org.apache.uima.cas.impl with type arguments of type FeatureStructureModifier and TypeMethodDescriptionint
FsIndex_iicp.compareTo
(FsIndex_iicp<? extends FeatureStructure> cp) Maybe not used 3/2015 Compares two instances of FsIndex_iicp, for ordering.private static Annotation[]
LLUnambiguousIteratorImpl.createItemsArray
(LowLevelIterator<FeatureStructure> it) private static FeatureStructure[]
DebugFSLogicalStructure.getIndexContents
(FSIndex<? extends FeatureStructure> fsIndex) private static FeatureStructure[]
DebugFSLogicalStructure.getIndexContents
(FSIterator<? extends FeatureStructure> it) private void
FsIndex_iicp.initOneTypeThenAllSubtypes
(TypeImpl ti, ArrayList<FsIndex_singletype<FeatureStructure>> cache, int indexKind) This method inits one type then calls itself for all direct subtypesConstructors in org.apache.uima.cas.impl with parameters of type FeatureStructureModifierConstructorDescriptionFsIterator_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)SelectFSs_impl
(FeatureStructure[] source, CAS cas) Constructor parameters in org.apache.uima.cas.impl with type arguments of type FeatureStructureModifierConstructorDescriptionUnexpandedFeatureStructures
(FSIndex<? extends FeatureStructure> fsIndex) -
Uses of FeatureStructure in org.apache.uima.cas.text
Subinterfaces of FeatureStructure in org.apache.uima.cas.textModifier and TypeInterfaceDescriptioninterface
Interface for Annotation Feature Structures. -
Uses of FeatureStructure in org.apache.uima.collection.impl.cpm.engine
Methods in org.apache.uima.collection.impl.cpm.engine that return FeatureStructureModifier and TypeMethodDescriptionstatic FeatureStructure
Returns a Feature Structure of a given type. -
Uses of FeatureStructure in org.apache.uima.examples
Classes in org.apache.uima.examples that implement FeatureStructureModifier and TypeClassDescriptionclass
Stores detailed information about the original source document from which the current CAS was initialized. -
Uses of FeatureStructure in org.apache.uima.internal.util
Classes in org.apache.uima.internal.util with type parameters of type FeatureStructureModifier and TypeInterfaceDescriptioninterface
ComparableFSIterator<F extends FeatureStructure>
Interface for a comparable FSIterator.class
CopyOnWriteObjHashSet<T extends FeatureStructure>
implements ObjHashSet partially, for iterator useclass
CopyOnWriteOrderedFsSet_array<T extends FeatureStructure>
implements OrderedFsSet_array partially, for iterator useclass
OrderedFsSet_array<T extends FeatureStructure>
This one is being used, the other one (ending in 2) may be put back into service for large sizes, later.Fields in org.apache.uima.internal.util declared as FeatureStructureMethods in org.apache.uima.internal.util with parameters of type FeatureStructureModifier and TypeMethodDescriptionint
CopyOnWriteObjHashSet.copyToArray
(T[] target, int startingIndexInTarget) int
CopyOnWriteOrderedFsSet_array.copyToArray
(T[] target, int startingIndexInTarget) int
CopyOnWriteObjHashSet.moveTo
(FeatureStructure fs) if the fs is in the set, the iterator should return it.int
ObjHashSet.moveTo
(FeatureStructure fs) if the fs is in the set, the iterator should return it. -
Uses of FeatureStructure in org.apache.uima.jcas
Methods in org.apache.uima.jcas with type parameters of type FeatureStructureModifier and TypeMethodDescription<T extends FeatureStructure>
FSIterator<T> JCas.createFilteredIterator
(FSIterator<T> it, FSMatchConstraint cons) Create an iterator over structures satisfying a given constraint.<T extends FeatureStructure>
ListIterator<T> JCas.fs2listIterator
(FSIterator<T> it) Wrap a standard JavaListIterator
around an FSListIterator.Methods in org.apache.uima.jcas that return FeatureStructureMethods in org.apache.uima.jcas with parameters of type FeatureStructureModifier and TypeMethodDescriptionvoid
JCas.addFsToIndexes
(FeatureStructure fs) Add a feature structure to all appropriate indexes in the repository associated with this CAS View.default void
JCas.putJfsFromCaddr
(int casAddr, FeatureStructure fs) Deprecated.void
JCas.removeFsFromIndexes
(FeatureStructure fs) Remove a feature structure from all indexes in the repository associated with this CAS View.void
JCas.setSofaDataArray
(FeatureStructure array, String mime) Set the Sofa data as an ArrayFS.Method parameters in org.apache.uima.jcas with type arguments of type FeatureStructureModifier and TypeMethodDescriptionJCas.getCasType
(Class<? extends FeatureStructure> 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 FeatureStructure in org.apache.uima.jcas.cas
Classes in org.apache.uima.jcas.cas with type parameters of type FeatureStructureModifier and TypeInterfaceDescriptioninterface
ArrayFSImpl<E extends FeatureStructure>
Deprecated.use FSArray insteadfinal class
FSArray<T extends FeatureStructure>
Java Class model for Cas FSArray type extends FeatureStructure for backwards compatibility when using FSArray with no typing.interface
SelectViaCopyToArray<T extends FeatureStructure>
Classes which provide a toArrayForSelect() method that returns a FeatureStructure[] can implement this to enable the class to be used as a "select" source T extends FeatureStructure because FSArray with no typing needs to default to FeatureStructure for backwards compatibilitySubinterfaces of FeatureStructure in org.apache.uima.jcas.casModifier and TypeInterfaceDescriptioninterface
ArrayFSImpl<E extends FeatureStructure>
Deprecated.use FSArray insteadinterface
This class is the super class of list nodes (both empty and non empty)interface
This interface is implemented by arrays of non-FeatureStructure components boolean, byte, short, int, long, float, double, String, JavaObject Internal Use Only.interface
a marker interface for empty listsinterface
a marker interface for nonempty listsClasses in org.apache.uima.jcas.cas that implement FeatureStructureModifier 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
class
The JCas Class model corresponding to the Cas TOP type.Methods in org.apache.uima.jcas.cas with type parameters of type FeatureStructureModifier and TypeMethodDescription<U extends FeatureStructure>
voidFSArray.copyFromArray
(U[] src, int srcPos, int destPos, int length) <E extends FeatureStructure>
voidFSArrayList.copyFromArray
(E[] src, int srcPos, int destPos, int length) Copy from array.<U extends FeatureStructure>
voidFSArray.copyToArray
(int srcPos, U[] dest, int destPos, int length) <E extends FeatureStructure>
voidFSArrayList.copyToArray
(int srcPos, E[] dest, int destPos, int length) Copy to array.static <U extends FeatureStructure>
FSArray<U> FSArray.create
(JCas jcas, FeatureStructure[] a) Convenience - create a FSArray from an existing FeatureStructure[]static <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 FeatureStructure>
UFSArray.get
(int i) return the indexed value from the corresponding Cas FSArray as a Java Model object.Methods in org.apache.uima.jcas.cas that return FeatureStructureModifier and TypeMethodDescriptionFSArray._toArrayForSelect()
FSArrayList._toArrayForSelect()
SelectViaCopyToArray._toArrayForSelect()
Sofa.getLocalFSData()
FSArray.toArray()
Methods in org.apache.uima.jcas.cas with parameters of type FeatureStructureModifier and TypeMethodDescription<U extends FeatureStructure>
voidFSArray.copyFromArray
(U[] src, int srcPos, int destPos, int length) <E extends FeatureStructure>
voidFSArrayList.copyFromArray
(E[] src, int srcPos, int destPos, int length) Copy from array.<U extends FeatureStructure>
voidFSArray.copyToArray
(int srcPos, U[] dest, int destPos, int length) <E extends FeatureStructure>
voidFSArrayList.copyToArray
(int srcPos, E[] dest, int destPos, int length) Copy to array.static <U extends FeatureStructure>
FSArray<U> FSArray.create
(JCas jcas, FeatureStructure[] a) Convenience - create a FSArray from an existing FeatureStructure[]static <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 Structuresvoid
AnnotationBase.setFeatureValue
(Feature feat, FeatureStructure v) void
Sofa.setFeatureValue
(Feature feat, FeatureStructure fs) void
Sofa.setLocalSofaData
(FeatureStructure aFS) void
Sofa.setLocalSofaData
(FeatureStructure aFS, String mimeType) -
Uses of FeatureStructure in org.apache.uima.jcas.impl
Methods in org.apache.uima.jcas.impl with type parameters of type FeatureStructureModifier and TypeMethodDescription<T extends FeatureStructure>
FSIterator<T> JCasImpl.createFilteredIterator
(FSIterator<T> it, FSMatchConstraint constraint) <T extends FeatureStructure>
ListIterator<T> JCasImpl.fs2listIterator
(FSIterator<T> it) Methods in org.apache.uima.jcas.impl that return FeatureStructureMethods in org.apache.uima.jcas.impl with parameters of type FeatureStructureModifier and TypeMethodDescriptionvoid
JCasImpl.addFsToIndexes
(FeatureStructure instance) void
JCasImpl.removeFsFromIndexes
(FeatureStructure instance) void
JCasImpl.setSofaDataArray
(FeatureStructure array, String mime) Method parameters in org.apache.uima.jcas.impl with type arguments of type FeatureStructureModifier and TypeMethodDescriptionJCasImpl.getCasType
(Class<? extends FeatureStructure> 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)private static int
JCasImpl.getTypeRegistryIndex
(Class<? extends FeatureStructure> clazz) Static method to get the corresponding Type for a JCas class object -
Uses of FeatureStructure in org.apache.uima.jcas.tcas
Classes in org.apache.uima.jcas.tcas that implement FeatureStructureModifier and TypeClassDescriptionclass
the JCas class model for the CAS type uima.cas.Annotation.class
The JCas class definition for the CASDocumentAnnotation
type. -
Uses of FeatureStructure in org.apache.uima.tools.viewer
Fields in org.apache.uima.tools.viewer declared as FeatureStructureModifier and TypeFieldDescriptionprivate FeatureStructure
CasAnnotationViewer.FsTreeNodeObject.featureStructure
The feature structure.Methods in org.apache.uima.tools.viewer that return FeatureStructureModifier and TypeMethodDescriptionCasAnnotationViewer.FsTreeNodeObject.getFeatureStructure()
Gets the feature structure.Methods in org.apache.uima.tools.viewer with parameters of type FeatureStructureModifier and TypeMethodDescriptionprivate void
CasAnnotationViewer.addFeatureTreeNodes
(DefaultMutableTreeNode aParentNode, FeatureStructure aFS) Adds the feature tree nodes.private String
CasAnnotationViewer.getFeatureValueInString
(FeatureStructure aFS, Feature feature) Get feature value in string, if value is not another annotation and not an array of annotations.Constructors in org.apache.uima.tools.viewer with parameters of type FeatureStructureModifierConstructorDescriptionFsTreeNodeObject
(FeatureStructure inFeatureStructure, String inFeatureName) Instantiates a new fs tree node object. -
Uses of FeatureStructure in org.apache.uima.util
Methods in org.apache.uima.util with type parameters of type FeatureStructureModifier and TypeMethodDescriptionprivate <T extends FeatureStructure>
voidCasCopier.copyFeatures
(T srcFSi, T tgtFSi) Copy feature values from one FS to another.<T extends FeatureStructure>
TCasCopier.copyFs
(T aFS) Copy 1 feature structure from the originalSrcCas to a new Cas.private <T extends FeatureStructure>
booleanCasCopier.isDocumentAnnotation
(T aFS) Determines whether the given FS is the DocumentAnnotation in the srcCasView.Methods in org.apache.uima.util that return FeatureStructureMethods in org.apache.uima.util with parameters of type FeatureStructureModifier and TypeMethodDescriptionboolean
CasCopier.alreadyCopied
(FeatureStructure 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.private Attributes
CasToInlineXml.getFeatureAttributes
(FeatureStructure aFS, CAS aCAS) private final Attributes
TCasToInlineXml.getFeatureAttributes
(FeatureStructure aFS, CAS aCAS) Deprecated.