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.examples | |
org.apache.uima.jcas |
Interfaces for accessing the JCAS.
|
org.apache.uima.jcas.cas |
JCAS model for built-in CAS types
|
org.apache.uima.jcas.impl |
Provides the classes that support the Java Cas Model (JCM).
|
org.apache.uima.jcas.tcas |
JCAS model for built-in TCAS types
|
org.apache.uima.util |
Utility classes and interfaces used by UIMA components.
|
Modifier and Type | Interface and Description |
---|---|
interface |
FSIndex<T extends FeatureStructure>
Feature structure index access interface.
|
interface |
FSIterator<T extends FeatureStructure>
Iterator over feature structures.
|
Modifier and Type | Interface and Description |
---|---|
interface |
AnnotationBaseFS
Annotation Base API.
|
interface |
ArrayFS
Feature structure array interface.
|
interface |
BooleanArrayFS
Boolean array interface.
|
interface |
ByteArrayFS
Byte array interface.
|
interface |
CommonArrayFS
Common parts of the Array interfaces.
|
interface |
DoubleArrayFS
Double array interface.
|
interface |
FloatArrayFS
Interface for CAS float arrays.
|
interface |
IntArrayFS
Interface for CAS int arrays.
|
interface |
LongArrayFS
Long array interface.
|
interface |
ShortArrayFS
Short array interface.
|
interface |
SofaFS
Interface for "Subject of Analysis" (Sofa) feature structures.
|
interface |
StringArrayFS
String array interface.
|
Modifier and Type | Method and Description |
---|---|
<T extends FeatureStructure> |
CAS.createFilteredIterator(FSIterator<T> it,
FSMatchConstraint cons)
Create an iterator over structures satisfying a given constraint.
|
<T extends FeatureStructure> |
CAS.createFS(Type type)
Create a new FeatureStructure.
|
<T extends FeatureStructure> |
CAS.fs2listIterator(FSIterator<T> it)
Wrap a standard Java
ListIterator around an FSListIterator. |
<T extends FeatureStructure> |
FSIndexRepository.getAllIndexedFS(Type aType)
Gets an iterator over all indexed FeatureStructures of the specified Type (and any of its
subtypes).
|
<T extends FeatureStructure> |
FSIndexRepository.getIndex(String label)
Retrieve an index according to a label.
|
<T extends FeatureStructure> |
FSIndexRepository.getIndex(String label,
Type type)
Retrieve an index according to a label and a type.
|
Modifier and Type | Method and Description |
---|---|
FeatureStructure |
FSIndex.find(FeatureStructure fs)
Find an entry in the index "equal to" the given feature structure according to the comparators specified
for this index.
|
FeatureStructure |
ArrayFS.get(int i)
Get the i-th feature structure from the array.
|
FeatureStructure |
FeatureStructure.getFeatureValue(Feature feat)
Get a feature value.
|
FeatureStructure |
FeaturePath.getFSValue(FeatureStructure fs)
Returns the FeatureStructure of a FeatureStructure valued feature path.
|
FeatureStructure |
SofaFS.getLocalFSData()
Get the Local Subject of Analysis returns null if not previously set.
|
FeatureStructure |
CAS.getSofaDataArray()
Get the Sofa data array.
|
FeatureStructure[] |
ArrayFS.toArray()
Creates a new array the this array is copied to.
|
Modifier and Type | Method and Description |
---|---|
Iterator<FSIndex<FeatureStructure>> |
FSIndexRepository.getIndexes()
Get all indexes in this repository.
|
Modifier and Type | Method and Description |
---|---|
void |
FSIndexRepository.addFS(FeatureStructure fs)
Add a feature structure to all appropriate indexes in the repository.
|
void |
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.
|
void |
ArrayFS.copyFromArray(FeatureStructure[] src,
int srcOffset,
int destOffset,
int length)
Copy the contents of an external array into this array.
|
void |
ArrayFS.copyToArray(int srcOffset,
FeatureStructure[] dest,
int destOffset,
int length)
Copy the contents of the array from
start to end to the
destination destArray with destination offset destOffset . |
FeatureStructure |
FSIndex.find(FeatureStructure fs)
Find an entry in the index "equal to" the given feature structure according to the comparators specified
for this index.
|
Boolean |
FeaturePath.getBooleanValue(FeatureStructure fs)
Returns the Boolean value of a boolean valued feature path.
|
Byte |
FeaturePath.getByteValue(FeatureStructure fs)
Returns the Byte value of a byte valued feature path.
|
Double |
FeaturePath.getDoubleValue(FeatureStructure fs)
Returns the Double value of a double valued feature path.
|
Float |
FeaturePath.getFloatValue(FeatureStructure fs)
Returns the Float value of a float valued feature path.
|
FeatureStructure |
FeaturePath.getFSValue(FeatureStructure fs)
Returns the FeatureStructure of a FeatureStructure valued feature path.
|
Integer |
FeaturePath.getIntValue(FeatureStructure fs)
Returns the Integer value of an integer valued feature path.
|
Long |
FeaturePath.getLongValue(FeatureStructure fs)
Returns the Long value of a long valued feature path.
|
Short |
FeaturePath.getShortValue(FeatureStructure fs)
Returns the Short value of a short valued feature path.
|
String |
FeaturePath.getStringValue(FeatureStructure fs)
Returns the String value of a string valued feature path.
|
TypeClass |
FeaturePath.getTypClass(FeatureStructure fs)
Returns the type class of the feature path.
|
Type |
FeaturePath.getType(FeatureStructure fs)
Returns the type of the feature path.
|
String |
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 this
Marker existed before the mark was set, and has been modified. |
boolean |
Marker.isNew(FeatureStructure fs) |
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 is equal to
fs . |
void |
FSIndexRepository.removeFS(FeatureStructure fs)
Remove a feature structure from all indexes in the repository.
|
void |
CAS.removeFsFromIndexes(FeatureStructure fs)
Remove a feature structure from all indexes in the repository associated with this CAS View.
|
void |
ArrayFS.set(int i,
FeatureStructure fs)
Set the i-th value.
|
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.
|
Modifier and Type | Class and Description |
---|---|
class |
FSBagIndex<T extends FeatureStructure>
Used for UIMA FS Bag Indexes
Uses IntVector or PositiveIntSet to hold values of FSs
|
interface |
FSGenerator<T extends FeatureStructure> |
class |
FSIndexFlat<T extends FeatureStructure>
Flattened indexes built as a speed-up alternative for Sorted indexes.
|
static class |
FSIndexFlat.FSIteratorFlat<TI extends FeatureStructure> |
class |
FSIntArrayIndex<T extends FeatureStructure>
Used for sorted indexes only
Uses IntVector (sorted) as the index (of FSs)
|
class |
FSIntIteratorImplBase<T extends FeatureStructure>
Base class for int Iterators over indexes.
|
class |
FSIteratorImplBase<T extends FeatureStructure>
Base class for FSIterator implementations.
|
class |
FSIteratorWrapper<T extends FeatureStructure> |
class |
FSIteratorWrapperDoubleCheck<T extends FeatureStructure>
Only used for debugging
Takes two iterators, and compares them; returns the 1st, throws error if unequal
|
class |
FSLeafIndexImpl<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.
|
class |
FSRBTSetIndex<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.
|
class |
IntIterator4set<T extends FeatureStructure> |
Modifier and Type | Class and Description |
---|---|
class |
AnnotationBaseImpl
Class comment for AnnotationImpl.java goes here.
|
class |
AnnotationImpl
Class comment for AnnotationImpl.java goes here.
|
class |
ArrayFSImpl
Implementation of the
ArrayFS interface. |
class |
BooleanArrayFSImpl
Implementation of the
BooleanArrayFS interface. |
class |
ByteArrayFSImpl
Implementation of the
ByteArrayFS interface. |
class |
CommonArrayFSImpl
Common part of array impl for those arrays of primitives which exist in the main heap.
|
class |
CommonAuxArrayFSImpl
Common part of array impl for those arrays of primitives which use auxilliary heaps.
|
class |
DoubleArrayFSImpl
Implementation of the
DoubleArrayFS interface. |
class |
FeatureStructureImpl
Feature structure implementation.
|
class |
FeatureStructureImplC
Feature structure implementation.
|
class |
FloatArrayFSImpl
Implementation of the
IntArrayFS interface. |
class |
IntArrayFSImpl
Implementation of the
IntArrayFS interface. |
class |
LongArrayFSImpl
Implementation of the
ArrayFS interface. |
class |
ShortArrayFSImpl
Implementation of the
ArrayFS interface. |
class |
SofaFSImpl
Implementation of the
SofaFS interface. |
class |
StringArrayFSImpl
Implementation of the
ArrayFS interface. |
Modifier and Type | Field and Description |
---|---|
FSIndex<FeatureStructure> |
DebugFSLogicalStructure.IndexInfo.fsIndex |
Modifier and Type | Method and Description |
---|---|
<T extends FeatureStructure> |
CASImpl.createFilteredIterator(FSIterator<T> it,
FSMatchConstraint cons) |
<T extends FeatureStructure> |
CASImpl.createFS(int addr)
This is your link from the low-level API to the high-level API.
|
<T extends FeatureStructure> |
CASImpl.createFS(Type type) |
<T extends FeatureStructure> |
CASImpl.fs2listIterator(FSIterator<T> it) |
<T extends FeatureStructure> |
FSIndexRepositoryImpl.getAllIndexedFS(Type type) |
<T extends FeatureStructure> |
FSIndexRepositoryImpl.getIndex(String label) |
<T extends FeatureStructure> |
FSIndexRepositoryImpl.getIndex(String label,
Type type) |
<T extends FeatureStructure> |
CASImpl.ll_getFSForRef(int fsRef) |
<T extends FeatureStructure> |
LowLevelCAS.ll_getFSForRef(int fsRef)
Return a FS object that corresponds to a low-level reference.
|
Modifier and Type | Method and Description |
---|---|
FeatureStructure |
FSIntArrayIndex.find(FeatureStructure fs) |
FeatureStructure |
AnnotationIndexImpl.find(FeatureStructure fs) |
FeatureStructure |
FSBagIndex.find(FeatureStructure fs) |
FeatureStructure |
FSRBTSetIndex.find(FeatureStructure fs) |
FeatureStructure |
ArrayFSImpl.get(int i) |
static FeatureStructure[] |
DebugFSLogicalStructure.getDebugLogicalStructure_SubAnnotations(AnnotationFS fs) |
FeatureStructure |
FeatureStructureImpl.getFeatureValue(Feature feat) |
FeatureStructure |
SofaFSImpl.getLocalFSData() |
FeatureStructure |
CASImpl.getSofaDataArray() |
FeatureStructure[] |
ArrayFSImpl.toArray() |
Modifier and Type | Method and Description |
---|---|
Iterator<FSIndex<FeatureStructure>> |
FSIndexRepositoryImpl.getIndexes() |
Modifier and Type | Method and Description |
---|---|
void |
FSIndexRepositoryImpl.addFS(FeatureStructure fs) |
void |
CASImpl.addFsToIndexes(FeatureStructure fs) |
void |
CASImpl.addSofa(FeatureStructure sofa,
String sofaName,
String mimeType) |
void |
CASImpl.commitFS(FeatureStructure fs)
Deprecated.
|
int |
DefaultFSAnnotationComparator.compare(FeatureStructure fs1,
FeatureStructure fs2)
Compare two annotations.
|
int |
FSLeafIndexImpl.compare(FeatureStructure fs1,
FeatureStructure fs2) |
int |
AnnotationIndexImpl.compare(FeatureStructure fs1,
FeatureStructure fs2) |
int |
FSComparator.compare(FeatureStructure fs1,
FeatureStructure fs2)
Compare two FSs.
|
boolean |
FSIntArrayIndex.contains(FeatureStructure fs) |
boolean |
AnnotationIndexImpl.contains(FeatureStructure fs) |
boolean |
FSBagIndex.contains(FeatureStructure fs) |
boolean |
FSRBTSetIndex.contains(FeatureStructure fs) |
void |
ArrayFSImpl.copyFromArray(FeatureStructure[] src,
int srcOffset,
int destOffset,
int length) |
void |
ArrayFSImpl.copyToArray(int srcOffset,
FeatureStructure[] dest,
int destOffset,
int length) |
void |
FSIntArrayIndex.deleteFS(FeatureStructure fs) |
abstract void |
FSLeafIndexImpl.deleteFS(FeatureStructure fs)
Method deleteFS.
|
void |
FSBagIndex.deleteFS(FeatureStructure fs) |
void |
FSRBTSetIndex.deleteFS(FeatureStructure fs) |
FeatureStructure |
FSIntArrayIndex.find(FeatureStructure fs) |
FeatureStructure |
AnnotationIndexImpl.find(FeatureStructure fs) |
FeatureStructure |
FSBagIndex.find(FeatureStructure fs) |
FeatureStructure |
FSRBTSetIndex.find(FeatureStructure fs) |
static Object |
DebugFSLogicalStructure.floatListToArray(FeatureStructure fs) |
static Object |
DebugFSLogicalStructure.fsListToArray(FeatureStructure fs) |
static Object |
DebugFSLogicalStructure.getDebugLogicalStructure_FeatureStructure(FeatureStructure fs) |
static Object |
DebugFSLogicalStructure.integerListToArray(FeatureStructure fs) |
boolean |
MarkerImpl.isModified(FeatureStructure fs) |
boolean |
MarkerImpl.isNew(FeatureStructure fs) |
FSIterator<T> |
FSLeafIndexImpl.iterator(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.
|
int |
CASImpl.ll_getFSRef(FeatureStructure fsImpl) |
int |
LowLevelCAS.ll_getFSRef(FeatureStructure fsImpl)
Get the low-level reference from an existing FS object.
|
boolean |
BooleanConstraint.match(FeatureStructure fs) |
void |
Subiterator.moveTo(FeatureStructure fs) |
void |
FSIteratorWrapperDoubleCheck.moveTo(FeatureStructure fs) |
void |
FSIteratorWrapper.moveTo(FeatureStructure fs) |
void |
FSIndexFlat.FSIteratorFlat.moveTo(FeatureStructure fs) |
void |
FSIndexRepositoryImpl.removeFS(FeatureStructure fs) |
void |
CASImpl.removeFsFromIndexes(FeatureStructure fs) |
void |
ArrayFSImpl.set(int i,
FeatureStructure fs) |
void |
SofaFSImpl.setFeatureValue(Feature feat,
FeatureStructure fs) |
void |
FeatureStructureImpl.setFeatureValue(Feature feat,
FeatureStructure fs) |
void |
SofaFSImpl.setLocalSofaData(FeatureStructure aFS) |
void |
CASImpl.setSofaDataArray(FeatureStructure array,
String mime) |
static Object |
DebugFSLogicalStructure.stringListToArray(FeatureStructure fs) |
Modifier and Type | Interface and Description |
---|---|
interface |
AnnotationFS
Interface for Annotation Feature Structures.
|
Modifier and Type | Class and Description |
---|---|
class |
SourceDocumentInformation
Stores detailed information about the original source document from which the current CAS was
initialized.
|
Modifier and Type | Method and Description |
---|---|
<T extends FeatureStructure> |
JCas.createFilteredIterator(FSIterator<T> it,
FSMatchConstraint cons)
Create an iterator over structures satisfying a given constraint.
|
<T extends FeatureStructure> |
JCas.fs2listIterator(FSIterator<T> it)
Wrap a standard Java
ListIterator around an FSListIterator. |
Modifier and Type | Method and Description |
---|---|
FeatureStructure |
JCas.getSofaDataArray()
Get the Sofa data array.
|
Modifier and Type | Method and Description |
---|---|
void |
JCas.addFsToIndexes(FeatureStructure fs)
Add a feature structure to all appropriate indexes in the repository associated with this CAS
View.
|
void |
JCas.putJfsFromCaddr(int casAddr,
FeatureStructure fs) |
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.
|
Modifier and Type | Class and Description |
---|---|
class |
AnnotationBase
the JCas class model for the CAS type uima.cas.AnnotationBase.
|
class |
BooleanArray
JCas class model for BooleanArray
|
class |
ByteArray
JCas class model for ByteArray
|
class |
DoubleArray
JCas class model for DoubleArray
|
class |
EmptyFloatList |
class |
EmptyFSList |
class |
EmptyIntegerList |
class |
EmptyStringList |
class |
FloatArray
Java Cas model for Cas FloatArray.
|
class |
FloatList |
class |
FSArray
Java Class model for Cas FSArray type
|
class |
FSList |
class |
IntegerArray
The Java Class model corresponding to the Cas IntegerArray_JCasImpl type.
|
class |
IntegerList |
class |
LongArray
JCas class model for LongArray
|
class |
NonEmptyFloatList |
class |
NonEmptyFSList |
class |
NonEmptyIntegerList |
class |
NonEmptyStringList |
class |
ShortArray
JCas class model for ShortArray
|
class |
Sofa
Updated by JCasGen Fri Apr 29 16:05:04 EDT 2005
|
class |
StringArray
JCas class model for StringArray
|
class |
StringList |
class |
TOP
The Java Class model corresponding to the Cas TOP type.
|
Modifier and Type | Method and Description |
---|---|
FeatureStructure |
FSArray.get(int i)
return the indexed value from the corresponding Cas FSArray as a Java Model object.
|
FeatureStructure |
FSArray_Type.get(int addr,
int i) |
FeatureStructure |
Sofa.getLocalFSData() |
FeatureStructure[] |
FSArray.toArray() |
FeatureStructure[] |
FSArray_Type.toArray(int addr) |
Modifier and Type | Method and Description |
---|---|
Iterator<FeatureStructure> |
FSArray.iterator() |
Modifier and Type | Method and Description |
---|---|
void |
FSArray.copyFromArray(FeatureStructure[] src,
int srcOffset,
int destOffset,
int length) |
void |
FSArray_Type.copyFromArray(int addr,
FeatureStructure[] src,
int srcOffset,
int destOffset,
int length) |
void |
FSArray.copyToArray(int srcOffset,
FeatureStructure[] dest,
int destOffset,
int length) |
void |
FSArray_Type.copyToArray(int addr,
int srcOffset,
FeatureStructure[] dest,
int destOffset,
int length) |
void |
FSArray.set(int i,
FeatureStructure v)
updates the Cas, setting the indexed value with the corresponding Cas FeatureStructure.
|
void |
FSArray_Type.set(int addr,
int i,
FeatureStructure v)
updates the Cas, setting the indexed value to the passed in FeatureStructure value.
|
void |
Sofa.setFeatureValue(Feature feat,
FeatureStructure fs) |
void |
Sofa.setLocalSofaData(FeatureStructure aFS) |
Modifier and Type | Method and Description |
---|---|
<T extends FeatureStructure> |
JCasImpl.createFilteredIterator(FSIterator<T> it,
FSMatchConstraint constraint) |
<T extends FeatureStructure> |
JCasImpl.fs2listIterator(FSIterator<T> it) |
Modifier and Type | Method and Description |
---|---|
FeatureStructure |
JCasImpl.getSofaDataArray() |
Modifier and Type | Method and Description |
---|---|
void |
JCasImpl.addFsToIndexes(FeatureStructure instance) |
void |
JCasImpl.putJfsFromCaddr(int casAddr,
FeatureStructure fs) |
void |
JCasImpl.removeFsFromIndexes(FeatureStructure instance) |
void |
JCasImpl.setSofaDataArray(FeatureStructure array,
String mime) |
Modifier and Type | Class and Description |
---|---|
class |
Annotation
the JCas class model for the CAS type uima.cas.Annotation.
|
class |
DocumentAnnotation
The JCas class definition for the CAS
DocumentAnnotation type. |
Modifier and Type | Method and Description |
---|---|
FeatureStructure |
CasCopier.copyFs(FeatureStructure aFS)
Copy 1 feature structure from the originalSrcCas to a new Cas.
|
static FeatureStructure |
ConsumerCasUtils.getTcasFS(CAS aCasView,
String aTypeS) |
Modifier and Type | Method and Description |
---|---|
boolean |
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.
|
FeatureStructure |
CasCopier.copyFs(FeatureStructure aFS)
Copy 1 feature structure from the originalSrcCas to a new Cas.
|
Copyright © 2006–2021 The Apache Software Foundation. All rights reserved.