Uses of Interface
org.apache.uima.cas.FeatureStructure
-
Packages that use FeatureStructure 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.cas.text Text Common Annotation System (TCAS) Interfaces.org.apache.uima.collection.impl.cpm.engine org.apache.uima.examples org.apache.uima.internal.util org.apache.uima.internal.util.rb_trees org.apache.uima.jcas Interfaces for accessing the JCAS.org.apache.uima.jcas.cas JCAS model for built-in CAS typesorg.apache.uima.jcas.impl Provides the classes that support the Java Cas Model (JCM).org.apache.uima.jcas.tcas JCAS model for built-in TCAS typesorg.apache.uima.util 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 FeatureStructure Modifier and Type Interface Description interfaceFSIndex<T extends FeatureStructure>Feature structure index access interface.interfaceFSIterator<T extends FeatureStructure>Iterator over feature structures.Subinterfaces of FeatureStructure in org.apache.uima.cas Modifier and Type Interface Description interfaceAnnotationBaseFSAnnotation Base API.interfaceArrayFSFeature structure array interface.interfaceBooleanArrayFSBoolean array interface.interfaceByteArrayFSByte array interface.interfaceCommonArrayFSCommon parts of the Array interfaces.interfaceDoubleArrayFSDouble array interface.interfaceFloatArrayFSInterface for CAS float arrays.interfaceIntArrayFSInterface for CAS int arrays.interfaceLongArrayFSLong array interface.interfaceShortArrayFSShort array interface.interfaceSofaFSInterface for "Subject of Analysis" (Sofa) feature structures.interfaceStringArrayFSString array interface.Methods in org.apache.uima.cas with type parameters of type FeatureStructure Modifier and Type Method Description <T extends FeatureStructure>
FSIterator<T>CAS. createFilteredIterator(FSIterator<T> it, FSMatchConstraint cons)Create an iterator over structures satisfying a given constraint.<T extends FeatureStructure>
TCAS. createFS(Type type)Create a new FeatureStructure.<T extends FeatureStructure>
java.util.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>FSIndexRepository. getIndex(java.lang.String label)Retrieve an index according to a label.<T extends FeatureStructure>
FSIndex<T>FSIndexRepository. getIndex(java.lang.String label, Type type)Retrieve an index according to a label and a type.Methods in org.apache.uima.cas that return FeatureStructure Modifier and Type Method Description FeatureStructureFSIndex. find(FeatureStructure fs)Find an entry in the index "equal to" the given feature structure according to the comparators specified for this index.FeatureStructureArrayFS. get(int i)Get the i-th feature structure from the array.FeatureStructureFeatureStructure. getFeatureValue(Feature feat)Get a feature value.FeatureStructureFeaturePath. getFSValue(FeatureStructure fs)Returns the FeatureStructure of a FeatureStructure valued feature path.FeatureStructureSofaFS. getLocalFSData()Get the Local Subject of Analysis returns null if not previously set.FeatureStructureCAS. getSofaDataArray()Get the Sofa data array.FeatureStructure[]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 FeatureStructure Modifier and Type Method Description java.util.Iterator<FSIndex<FeatureStructure>>FSIndexRepository. getIndexes()Get all indexes in this repository.Methods in org.apache.uima.cas with parameters of type FeatureStructure Modifier and Type Method Description voidFSIndexRepository. 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.FeatureStructureFSIndex. find(FeatureStructure fs)Find an entry in the index "equal to" the given feature structure according to the comparators specified for this index.java.lang.BooleanFeaturePath. getBooleanValue(FeatureStructure fs)Returns the Boolean value of a boolean valued feature path.java.lang.ByteFeaturePath. getByteValue(FeatureStructure fs)Returns the Byte value of a byte valued feature path.java.lang.DoubleFeaturePath. getDoubleValue(FeatureStructure fs)Returns the Double value of a double valued feature path.java.lang.FloatFeaturePath. getFloatValue(FeatureStructure fs)Returns the Float value of a float valued feature path.FeatureStructureFeaturePath. getFSValue(FeatureStructure fs)Returns the FeatureStructure of a FeatureStructure valued feature path.java.lang.IntegerFeaturePath. getIntValue(FeatureStructure fs)Returns the Integer value of an integer valued feature path.java.lang.LongFeaturePath. getLongValue(FeatureStructure fs)Returns the Long value of a long valued feature path.java.lang.ShortFeaturePath. getShortValue(FeatureStructure fs)Returns the Short value of a short valued feature path.java.lang.StringFeaturePath. getStringValue(FeatureStructure fs)Returns the String value of a string valued feature path.TypeClassFeaturePath. getTypClass(FeatureStructure fs)Returns the type class of the feature path.TypeFeaturePath. getType(FeatureStructure fs)Returns the type of the feature path.java.lang.StringFeaturePath. 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)FSIterator<T>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, java.lang.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 FeatureStructure Modifier and Type Class Description classFSBagIndex<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 FeatureStructure Modifier and Type Class Description classAnnotationBaseImplClass comment for AnnotationImpl.java goes here.classAnnotationImplClass comment for AnnotationImpl.java goes here.classArrayFSImplImplementation of theArrayFSinterface.classBooleanArrayFSImplImplementation of theBooleanArrayFSinterface.classByteArrayFSImplImplementation of theByteArrayFSinterface.classCommonArrayFSImplCommon part of array impl for those arrays of primitives which exist in the main heap.classCommonAuxArrayFSImplCommon part of array impl for those arrays of primitives which use auxilliary heaps.classDoubleArrayFSImplImplementation of theDoubleArrayFSinterface.classFeatureStructureImplFeature structure implementation.classFeatureStructureImplCFeature structure implementation.classFloatArrayFSImplImplementation of theIntArrayFSinterface.classIntArrayFSImplImplementation of theIntArrayFSinterface.classLongArrayFSImplImplementation of theArrayFSinterface.classShortArrayFSImplImplementation of theArrayFSinterface.classSofaFSImplImplementation of theSofaFSinterface.classStringArrayFSImplImplementation of theArrayFSinterface.Fields in org.apache.uima.cas.impl with type parameters of type FeatureStructure Modifier and Type Field Description FSIndex<FeatureStructure>DebugFSLogicalStructure.IndexInfo. fsIndexMethods in org.apache.uima.cas.impl with type parameters of type FeatureStructure Modifier and Type Method Description <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>
TCASImpl. createFS(Type type)<T extends FeatureStructure>
java.util.ListIterator<T>CASImpl. fs2listIterator(FSIterator<T> it)<T extends FeatureStructure>
FSIterator<T>FSIndexRepositoryImpl. getAllIndexedFS(Type type)<T extends FeatureStructure>
FSIndex<T>FSIndexRepositoryImpl. getIndex(java.lang.String label)<T extends FeatureStructure>
FSIndex<T>FSIndexRepositoryImpl. getIndex(java.lang.String label, Type type)<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 FeatureStructure Modifier and Type Method Description FeatureStructureAnnotationIndexImpl. find(FeatureStructure fs)FeatureStructureFSBagIndex. find(FeatureStructure fs)FeatureStructureFSIntArrayIndex. find(FeatureStructure fs)FeatureStructureFSRBTSetIndex. find(FeatureStructure fs)FeatureStructureArrayFSImpl. get(int i)static FeatureStructure[]DebugFSLogicalStructure. getDebugLogicalStructure_SubAnnotations(AnnotationFS fs)FeatureStructureFeatureStructureImpl. getFeatureValue(Feature feat)FeatureStructureSofaFSImpl. getLocalFSData()FeatureStructureCASImpl. getSofaDataArray()FeatureStructure[]ArrayFSImpl. toArray()Methods in org.apache.uima.cas.impl that return types with arguments of type FeatureStructure Modifier and Type Method Description java.util.Iterator<FSIndex<FeatureStructure>>FSIndexRepositoryImpl. getIndexes()Methods in org.apache.uima.cas.impl with parameters of type FeatureStructure Modifier and Type Method Description voidFSIndexRepositoryImpl. addFS(FeatureStructure fs)voidCASImpl. addFsToIndexes(FeatureStructure fs)voidCASImpl. addSofa(FeatureStructure sofa, java.lang.String sofaName, java.lang.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)FeatureStructureAnnotationIndexImpl. find(FeatureStructure fs)FeatureStructureFSBagIndex. find(FeatureStructure fs)FeatureStructureFSIntArrayIndex. find(FeatureStructure fs)FeatureStructureFSRBTSetIndex. find(FeatureStructure fs)static java.lang.ObjectDebugFSLogicalStructure. floatListToArray(FeatureStructure fs)static java.lang.ObjectDebugFSLogicalStructure. fsListToArray(FeatureStructure fs)static java.lang.ObjectDebugFSLogicalStructure. getDebugLogicalStructure_FeatureStructure(FeatureStructure fs)static java.lang.ObjectDebugFSLogicalStructure. integerListToArray(FeatureStructure fs)booleanMarkerImpl. isModified(FeatureStructure fs)booleanMarkerImpl. isNew(FeatureStructure fs)FSIterator<T>AnnotationIndexImpl. iterator(FeatureStructure fs)FSIndexFlat.FSIteratorFlat<T>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.FSIterator<T>FSLeafIndexImpl. iterator(FeatureStructure fs)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, java.lang.String mime)static java.lang.ObjectDebugFSLogicalStructure. stringListToArray(FeatureStructure fs) -
Uses of FeatureStructure in org.apache.uima.cas.text
Subinterfaces of FeatureStructure in org.apache.uima.cas.text Modifier and Type Interface Description interfaceAnnotationFSInterface 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 FeatureStructure Modifier and Type Method Description static FeatureStructureConsumerCasUtils. getTcasFS(CAS aCasView, java.lang.String aTypeS)Returns a Feature Structure of a given type -
Uses of FeatureStructure in org.apache.uima.examples
Classes in org.apache.uima.examples that implement FeatureStructure Modifier and Type Class Description classSourceDocumentInformationStores 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 FeatureStructure Modifier and Type Interface Description interfaceComparableIntPointerIterator<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 FeatureStructure Modifier and Type Method Description <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 FeatureStructure Modifier and Type Method Description <T extends FeatureStructure>
FSIterator<T>JCas. createFilteredIterator(FSIterator<T> it, FSMatchConstraint cons)Create an iterator over structures satisfying a given constraint.<T extends FeatureStructure>
java.util.ListIterator<T>JCas. fs2listIterator(FSIterator<T> it)Wrap a standard JavaListIteratoraround an FSListIterator.Methods in org.apache.uima.jcas that return FeatureStructure Modifier and Type Method Description FeatureStructureJCas. getSofaDataArray()Get the Sofa data array.Methods in org.apache.uima.jcas with parameters of type FeatureStructure Modifier and Type Method Description voidJCas. 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, java.lang.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 FeatureStructure Modifier and Type Class Description classAnnotationBasethe JCas class model for the CAS type uima.cas.AnnotationBase.classBooleanArrayJCas class model for BooleanArrayclassByteArrayJCas class model for ByteArrayclassDoubleArrayJCas class model for DoubleArrayclassEmptyFloatListclassEmptyFSListclassEmptyIntegerListclassEmptyStringListclassFloatArrayJava Cas model for Cas FloatArray.classFloatListclassFSArrayJava Class model for Cas FSArray typeclassFSListclassIntegerArrayThe Java Class model corresponding to the Cas IntegerArray_JCasImpl type.classIntegerListclassLongArrayJCas class model for LongArrayclassNonEmptyFloatListclassNonEmptyFSListclassNonEmptyIntegerListclassNonEmptyStringListclassShortArrayJCas class model for ShortArrayclassSofaUpdated by JCasGen Fri Apr 29 16:05:04 EDT 2005classStringArrayJCas class model for StringArrayclassStringListclassTOPThe Java Class model corresponding to the Cas TOP type.Methods in org.apache.uima.jcas.cas that return FeatureStructure Modifier and Type Method Description FeatureStructureFSArray_Type. get(int addr, int i)FeatureStructureFSArray. get(int i)return the indexed value from the corresponding Cas FSArray as a Java Model object.FeatureStructureSofa. getLocalFSData()FeatureStructure[]FSArray_Type. toArray(int addr)FeatureStructure[]FSArray. toArray()Methods in org.apache.uima.jcas.cas that return types with arguments of type FeatureStructure Modifier and Type Method Description java.util.Iterator<FeatureStructure>FSArray. iterator()Methods in org.apache.uima.jcas.cas with parameters of type FeatureStructure Modifier and Type Method Description voidFSArray_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 FeatureStructure Modifier and Type Method Description <T extends FeatureStructure>
FSIterator<T>JCasImpl. createFilteredIterator(FSIterator<T> it, FSMatchConstraint constraint)<T extends FeatureStructure>
java.util.ListIterator<T>JCasImpl. fs2listIterator(FSIterator<T> it)Methods in org.apache.uima.jcas.impl that return FeatureStructure Modifier and Type Method Description FeatureStructureJCasImpl. getSofaDataArray()Methods in org.apache.uima.jcas.impl with parameters of type FeatureStructure Modifier and Type Method Description voidJCasImpl. addFsToIndexes(FeatureStructure instance)voidJCasImpl. putJfsFromCaddr(int casAddr, FeatureStructure fs)voidJCasImpl. removeFsFromIndexes(FeatureStructure instance)voidJCasImpl. setSofaDataArray(FeatureStructure array, java.lang.String mime) -
Uses of FeatureStructure in org.apache.uima.jcas.tcas
Classes in org.apache.uima.jcas.tcas that implement FeatureStructure Modifier and Type Class Description classAnnotationthe JCas class model for the CAS type uima.cas.Annotation.classDocumentAnnotationThe JCas class definition for the CASDocumentAnnotationtype. -
Uses of FeatureStructure in org.apache.uima.util
Methods in org.apache.uima.util that return FeatureStructure Modifier and Type Method Description FeatureStructureCasCopier. copyFs(FeatureStructure aFS)Copy 1 feature structure from the originalSrcCas to a new Cas.static FeatureStructureConsumerCasUtils. getTcasFS(CAS aCasView, java.lang.String aTypeS)Methods in org.apache.uima.util with parameters of type FeatureStructure Modifier and Type Method Description booleanCasCopier. 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.FeatureStructureCasCopier. copyFs(FeatureStructure aFS)Copy 1 feature structure from the originalSrcCas to a new Cas.
-