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).
JCAS model for built-in TCAS types
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 TypeInterfaceDescriptioninterfaceFSIndex<T extends FeatureStructure>Feature structure index access interface.interfaceFSIterator<T extends FeatureStructure>Iterator over feature structures.Subinterfaces of FeatureStructure in org.apache.uima.casModifier and TypeInterfaceDescriptioninterfaceAnnotation Base API.interfaceFeature structure array interface.interfaceBoolean array interface.interfaceByte array interface.interfaceCommon parts of the Array interfaces.interfaceDouble array interface.interfaceInterface for CAS float arrays.interfaceInterface for CAS int arrays.interfaceLong array interface.interfaceShort array interface.interfaceInterface for "Subject of Analysis" (Sofa) feature structures.interfaceString array interface.Methods in org.apache.uima.cas with type parameters of type FeatureStructureModifier and TypeMethodDescription<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.<T extends FeatureStructure>
ListIterator<T>CAS.fs2listIterator(FSIterator<T> it) Wrap a standard JavaListIteratoraround an FSListIterator.<T extends FeatureStructure>
FSIterator<T>FSIndexRepository.getAllIndexedFS(Type aType) Gets an iterator over all indexed 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.Methods in org.apache.uima.cas that return FeatureStructureModifier and TypeMethodDescriptionFSIndex.find(FeatureStructure fs) Find an entry in the index "equal to" the given feature structure according to the comparators specified for this index.ArrayFS.get(int i) Get the i-th feature structure from the array.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 that return types with arguments of type FeatureStructureModifier and TypeMethodDescriptionFSIndexRepository.getIndexes()Get all indexes in this repository.Methods in org.apache.uima.cas with parameters of type FeatureStructureModifier and TypeMethodDescriptionvoidFSIndexRepository.addFS(FeatureStructure fs) Add a feature structure to all appropriate indexes in the repository.voidCAS.addFsToIndexes(FeatureStructure fs) Add a feature structure to all appropriate indexes in the repository associated with this CAS View.intFSIndex.compare(FeatureStructure fs1, FeatureStructure fs2) Compare two feature structures according to the ordering relation of the index.booleanFSIndex.contains(FeatureStructure fs) Check if the index contains an element equal to the given feature structure according to the comparators defined for this index.voidArrayFS.copyFromArray(FeatureStructure[] src, int srcOffset, int destOffset, int length) Copy the contents of an external array into this array.voidArrayFS.copyToArray(int srcOffset, FeatureStructure[] dest, int destOffset, int length) Copy the contents of the array fromstarttoendto the destinationdestArraywith 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.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) Returns the type class of the feature path.FeaturePath.getType(FeatureStructure fs) Returns the type of the feature path.FeaturePath.getValueAsString(FeatureStructure fs) Returns the feature path value as string for the given FeatureStructure.booleanMarker.isModified(FeatureStructure fs) Test if a FeatureStructure in a CAS represented by thisMarkerexisted before the mark was set, and has been modified.booleanMarker.isNew(FeatureStructure fs) FSIndex.iterator(FeatureStructure fs) Return an iterator over the index.booleanFSMatchConstraint.match(FeatureStructure fs) Match against feature structures.voidFSIterator.moveTo(FeatureStructure fs) Move the iterator to the first Feature Structure that is equal tofs.voidFSIndexRepository.removeFS(FeatureStructure fs) Remove a feature structure from all indexes in the repository.voidCAS.removeFsFromIndexes(FeatureStructure fs) Remove a feature structure from all indexes in the repository associated with this CAS View.voidArrayFS.set(int i, FeatureStructure fs) Set the i-th value.voidFeatureStructure.setFeatureValue(Feature feat, FeatureStructure fs) Set a feature value to another FS.voidSofaFS.setLocalSofaData(FeatureStructure aFS) Set the Local Subject of Analysis to be a predefined ArrayFS.voidCAS.setSofaDataArray(FeatureStructure array, String mime) Set the Sofa data as an ArrayFS. -
Uses of FeatureStructure in org.apache.uima.cas.impl
Classes in org.apache.uima.cas.impl with type parameters of type FeatureStructureModifier and TypeClassDescriptionclassFSBagIndex<T extends FeatureStructure>Used for UIMA FS Bag Indexes Uses IntVector or PositiveIntSet to hold values of FSsinterfaceFSGenerator<T extends FeatureStructure>classFSIndexFlat<T extends FeatureStructure>Flattened indexes built as a speed-up alternative for Sorted indexes.static classFSIndexFlat.FSIteratorFlat<TI extends FeatureStructure>classFSIntArrayIndex<T extends FeatureStructure>Used for sorted indexes only Uses IntVector (sorted) as the index (of FSs)classFSIntIteratorImplBase<T extends FeatureStructure>Base class for int Iterators over indexes.classFSIteratorImplBase<T extends FeatureStructure>Base class for FSIterator implementations.classFSIteratorWrapper<T extends FeatureStructure>classFSIteratorWrapperDoubleCheck<T extends FeatureStructure>Only used for debugging Takes two iterators, and compares them; returns the 1st, throws error if unequalclassFSLeafIndexImpl<T extends FeatureStructure>The common (among all index kinds - set, sorted, bag) info for an index Subtypes define the actual index repository (integers indexing the CAS) for each kind.classFSRBTSetIndex<T extends FeatureStructure>Used for UIMA FS Set Indexes Uses CompIntArrayRBT red black tree to hold items Same as FSRBTIndex, but duplicates are not inserted.classIntIterator4set<T extends FeatureStructure>Classes in org.apache.uima.cas.impl that implement FeatureStructureModifier and TypeClassDescriptionclassClass comment for AnnotationImpl.java goes here.classClass comment for AnnotationImpl.java goes here.classImplementation of theArrayFSinterface.classImplementation of theBooleanArrayFSinterface.classImplementation of theByteArrayFSinterface.classCommon part of array impl for those arrays of primitives which exist in the main heap.classCommon part of array impl for those arrays of primitives which use auxilliary heaps.classImplementation of theDoubleArrayFSinterface.classFeature structure implementation.classFeature structure implementation.classImplementation of theIntArrayFSinterface.classImplementation of theIntArrayFSinterface.classImplementation of theArrayFSinterface.classImplementation of theArrayFSinterface.classImplementation of theSofaFSinterface.classImplementation of theArrayFSinterface.Fields in org.apache.uima.cas.impl with type parameters of type FeatureStructureMethods in org.apache.uima.cas.impl with type parameters of type FeatureStructureModifier and TypeMethodDescription<T extends FeatureStructure>
FSIterator<T>CASImpl.createFilteredIterator(FSIterator<T> it, FSMatchConstraint cons) <T extends FeatureStructure>
TCASImpl.createFS(int addr) This is your link from the low-level API to the high-level API.<T extends FeatureStructure>
T<T extends FeatureStructure>
ListIterator<T>CASImpl.fs2listIterator(FSIterator<T> it) <T extends FeatureStructure>
FSIterator<T>FSIndexRepositoryImpl.getAllIndexedFS(Type type) <T extends FeatureStructure>
FSIndex<T><T extends FeatureStructure>
FSIndex<T><T extends FeatureStructure>
TCASImpl.ll_getFSForRef(int fsRef) <T extends FeatureStructure>
TLowLevelCAS.ll_getFSForRef(int fsRef) Return a FS object that corresponds to a low-level reference.Methods in org.apache.uima.cas.impl that return FeatureStructureModifier and TypeMethodDescriptionAnnotationIndexImpl.find(FeatureStructure fs) FSBagIndex.find(FeatureStructure fs) FSIntArrayIndex.find(FeatureStructure fs) FSRBTSetIndex.find(FeatureStructure fs) ArrayFSImpl.get(int i) static FeatureStructure[]DebugFSLogicalStructure.getDebugLogicalStructure_SubAnnotations(AnnotationFS fs) FeatureStructureImpl.getFeatureValue(Feature feat) SofaFSImpl.getLocalFSData()CASImpl.getSofaDataArray()ArrayFSImpl.toArray()Methods in org.apache.uima.cas.impl that return types with arguments of type FeatureStructureMethods in org.apache.uima.cas.impl with parameters of type FeatureStructureModifier and TypeMethodDescriptionvoidFSIndexRepositoryImpl.addFS(FeatureStructure fs) voidCASImpl.addFsToIndexes(FeatureStructure fs) voidCASImpl.addSofa(FeatureStructure sofa, String sofaName, String mimeType) voidCASImpl.commitFS(FeatureStructure fs) Deprecated.intAnnotationIndexImpl.compare(FeatureStructure fs1, FeatureStructure fs2) intDefaultFSAnnotationComparator.compare(FeatureStructure fs1, FeatureStructure fs2) Compare two annotations.intFSComparator.compare(FeatureStructure fs1, FeatureStructure fs2) Compare two FSs.intFSLeafIndexImpl.compare(FeatureStructure fs1, FeatureStructure fs2) booleanAnnotationIndexImpl.contains(FeatureStructure fs) booleanFSBagIndex.contains(FeatureStructure fs) booleanFSIntArrayIndex.contains(FeatureStructure fs) booleanFSRBTSetIndex.contains(FeatureStructure fs) voidArrayFSImpl.copyFromArray(FeatureStructure[] src, int srcOffset, int destOffset, int length) voidArrayFSImpl.copyToArray(int srcOffset, FeatureStructure[] dest, int destOffset, int length) voidFSBagIndex.deleteFS(FeatureStructure fs) voidFSIntArrayIndex.deleteFS(FeatureStructure fs) abstract voidFSLeafIndexImpl.deleteFS(FeatureStructure fs) Method deleteFS.voidFSRBTSetIndex.deleteFS(FeatureStructure fs) AnnotationIndexImpl.find(FeatureStructure fs) FSBagIndex.find(FeatureStructure fs) FSIntArrayIndex.find(FeatureStructure fs) FSRBTSetIndex.find(FeatureStructure fs) static ObjectDebugFSLogicalStructure.floatListToArray(FeatureStructure fs) static ObjectDebugFSLogicalStructure.fsListToArray(FeatureStructure fs) static ObjectDebugFSLogicalStructure.getDebugLogicalStructure_FeatureStructure(FeatureStructure fs) static ObjectDebugFSLogicalStructure.integerListToArray(FeatureStructure fs) booleanMarkerImpl.isModified(FeatureStructure fs) booleanMarkerImpl.isNew(FeatureStructure fs) AnnotationIndexImpl.iterator(FeatureStructure fs) FSIndexFlat.iterator(FeatureStructure fs) As of July 2015, flattened indexes are disabled - too little benefit, too many edge cases: edge cases to handle: going from non-JCas -> JCas requires existing flat indexes to be invalidated edge case: entering a PEAR, may require different impl of flattened indexes while in the PEAR, plus restoration of previous versions upon PEAR exit This iterator either returns an iterator over the flattened index, or null.FSLeafIndexImpl.iterator(FeatureStructure fs) final intCASImpl.ll_getFSRef(FeatureStructure fsImpl) intLowLevelCAS.ll_getFSRef(FeatureStructure fsImpl) Get the low-level reference from an existing FS object.booleanBooleanConstraint.match(FeatureStructure fs) voidFSIndexFlat.FSIteratorFlat.moveTo(FeatureStructure fs) voidFSIteratorWrapper.moveTo(FeatureStructure fs) voidFSIteratorWrapperDoubleCheck.moveTo(FeatureStructure fs) voidSubiterator.moveTo(FeatureStructure fs) voidFSIndexRepositoryImpl.removeFS(FeatureStructure fs) voidCASImpl.removeFsFromIndexes(FeatureStructure fs) voidArrayFSImpl.set(int i, FeatureStructure fs) voidFeatureStructureImpl.setFeatureValue(Feature feat, FeatureStructure fs) voidSofaFSImpl.setFeatureValue(Feature feat, FeatureStructure fs) voidSofaFSImpl.setLocalSofaData(FeatureStructure aFS) voidCASImpl.setSofaDataArray(FeatureStructure array, String mime) static ObjectDebugFSLogicalStructure.stringListToArray(FeatureStructure fs) -
Uses of FeatureStructure in org.apache.uima.cas.text
Subinterfaces of FeatureStructure in org.apache.uima.cas.textModifier and TypeInterfaceDescriptioninterfaceInterface 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 FeatureStructureReturns 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 TypeClassDescriptionclassStores 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 TypeInterfaceDescriptioninterfaceComparableIntPointerIterator<F extends FeatureStructure>Interface for a comparable IntPointerIterator. -
Uses of FeatureStructure in org.apache.uima.internal.util.rb_trees
Methods in org.apache.uima.internal.util.rb_trees with type parameters of type FeatureStructureModifier and TypeMethodDescription<T extends FeatureStructure>
ComparableIntPointerIterator<T>IntArrayRBT.pointerIterator(FSRBTSetIndex<T> fsSetIndex, int[] detectIllegalIndexUpdates, IntComparator comp) <T extends FeatureStructure>
IntPointerIteratorIntArrayRBT.pointerIterator(IntComparator comp, FSRBTSetIndex<T> fsSetIndex) -
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 JavaListIteratoraround an FSListIterator.Methods in org.apache.uima.jcas that return FeatureStructureMethods in org.apache.uima.jcas with parameters of type FeatureStructureModifier and TypeMethodDescriptionvoidJCas.addFsToIndexes(FeatureStructure fs) Add a feature structure to all appropriate indexes in the repository associated with this CAS View.voidJCas.putJfsFromCaddr(int casAddr, FeatureStructure fs) voidJCas.removeFsFromIndexes(FeatureStructure fs) Remove a feature structure from all indexes in the repository associated with this CAS View.voidJCas.setSofaDataArray(FeatureStructure array, String mime) Set the Sofa data as an ArrayFS. -
Uses of FeatureStructure in org.apache.uima.jcas.cas
Classes in org.apache.uima.jcas.cas that implement FeatureStructureModifier and TypeClassDescriptionclassthe JCas class model for the CAS type uima.cas.AnnotationBase.final classJCas class model for BooleanArrayfinal classJCas class model for ByteArrayfinal classJCas class model for DoubleArrayclassclassclassclassfinal classJava Cas model for Cas FloatArray.classfinal classJava Class model for Cas FSArray typeclassfinal classThe Java Class model corresponding to the Cas IntegerArray_JCasImpl type.classfinal classJCas class model for LongArrayclassclassclassclassfinal classJCas class model for ShortArrayclassUpdated by JCasGen Fri Apr 29 16:05:04 EDT 2005final classJCas class model for StringArrayclassclassThe Java Class model corresponding to the Cas TOP type.Methods in org.apache.uima.jcas.cas that return FeatureStructureModifier and TypeMethodDescriptionFSArray_Type.get(int addr, int i) FSArray.get(int i) return the indexed value from the corresponding Cas FSArray as a Java Model object.Sofa.getLocalFSData()FSArray_Type.toArray(int addr) FSArray.toArray()Methods in org.apache.uima.jcas.cas that return types with arguments of type FeatureStructureMethods in org.apache.uima.jcas.cas with parameters of type FeatureStructureModifier and TypeMethodDescriptionvoidFSArray_Type.copyFromArray(int addr, FeatureStructure[] src, int srcOffset, int destOffset, int length) voidFSArray.copyFromArray(FeatureStructure[] src, int srcOffset, int destOffset, int length) voidFSArray_Type.copyToArray(int addr, int srcOffset, FeatureStructure[] dest, int destOffset, int length) voidFSArray.copyToArray(int srcOffset, FeatureStructure[] dest, int destOffset, int length) voidFSArray_Type.set(int addr, int i, FeatureStructure v) updates the Cas, setting the indexed value to the passed in FeatureStructure value.voidFSArray.set(int i, FeatureStructure v) updates the Cas, setting the indexed value with the corresponding Cas FeatureStructure.voidSofa.setFeatureValue(Feature feat, FeatureStructure fs) voidSofa.setLocalSofaData(FeatureStructure aFS) -
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 TypeMethodDescriptionvoidJCasImpl.addFsToIndexes(FeatureStructure instance) voidJCasImpl.putJfsFromCaddr(int casAddr, FeatureStructure fs) voidJCasImpl.removeFsFromIndexes(FeatureStructure instance) voidJCasImpl.setSofaDataArray(FeatureStructure array, String mime) -
Uses of FeatureStructure in org.apache.uima.jcas.tcas
Classes in org.apache.uima.jcas.tcas that implement FeatureStructureModifier and TypeClassDescriptionclassthe JCas class model for the CAS type uima.cas.Annotation.classThe JCas class definition for the CASDocumentAnnotationtype. -
Uses of FeatureStructure in org.apache.uima.util
Methods in org.apache.uima.util that return FeatureStructureModifier and TypeMethodDescriptionCasCopier.copyFs(FeatureStructure aFS) Copy 1 feature structure from the originalSrcCas to a new Cas.static FeatureStructureMethods in org.apache.uima.util with parameters of type FeatureStructureModifier and TypeMethodDescriptionbooleanCasCopier.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.CasCopier.copyFs(FeatureStructure aFS) Copy 1 feature structure from the originalSrcCas to a new Cas.