Package | Description |
---|---|
org.apache.uima.cas |
Common Analysis System(CAS) Interfaces
|
org.apache.uima.cas.admin | |
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.tcas | |
org.apache.uima.util |
Utility classes and interfaces used by UIMA components.
|
Modifier and Type | Interface and Description |
---|---|
interface |
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.
|
Modifier and Type | Interface and Description |
---|---|
interface |
AnnotationBaseFS
Annotation Base API.
|
interface |
ArrayFS<E extends FeatureStructure>
Feature structure array interface.
|
interface |
BooleanArrayFS
Boolean array interface.
|
interface |
ByteArrayFS
Byte array interface.
|
interface |
CommonArrayFS<E>
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> |
FSIndexRepository.addFS(T fs)
Add a feature structure to all appropriate indexes in the repository.
|
<T extends FeatureStructure> |
ArrayFS.copyFromArray(T[] src,
int srcOffset,
int destOffset,
int length)
Copy the contents of an external array into this array.
|
<U extends FeatureStructure> |
ArrayFS.copyToArray(int srcOffset,
U[] dest,
int destOffset,
int length)
Copy the contents of the array from
start to end to the
destination destArray with destination offset destOffset . |
<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.
|
default <T extends FeatureStructure> |
CAS.emptyFSArray() |
default <T extends FeatureStructure> |
CAS.emptyFSArray(Type type) |
<T extends FeatureStructure> |
CAS.fs2listIterator(FSIterator<T> it)
Wrap a standard Java
ListIterator around an FSListIterator. |
<U extends FeatureStructure> |
ArrayFS.get(int i)
Get the i-th feature structure from the array.
|
default <T extends FeatureStructure> |
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> |
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> |
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.
|
<T extends FeatureStructure> |
FSIndexRepository.getIndexes()
Get all indexes in this repository.
|
<T extends FeatureStructure> |
FSIndexRepository.ll_getIndexes()
Get all indexes in this repository as low level indexes
|
<T extends FeatureStructure> |
FSIndexRepository.removeFS(T fs)
Remove a feature structure from all indexes in the repository.
|
static <U extends FeatureStructure> |
SelectFSs.select(FSIndex<U> index)
Use this static method to capture the generic argument
|
Modifier and Type | Method and Description |
---|---|
T[] |
SelectFSs.asArray(Class<? super T> clazz) |
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 |
---|---|
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.
|
<T extends FeatureStructure> |
ArrayFS.copyFromArray(T[] src,
int srcOffset,
int destOffset,
int length)
Copy the contents of an external array into this array.
|
<U extends FeatureStructure> |
ArrayFS.copyToArray(int srcOffset,
U[] dest,
int destOffset,
int length)
Copy the contents of the array from
start to end to the
destination destArray with destination offset destOffset . |
T |
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)
Deprecated.
use getTypeClass (spelling fix)
|
Type |
FeaturePath.getType(FeatureStructure fs)
Returns the type of the feature path.
|
TypeClass |
FeaturePath.getTypeClass(FeatureStructure fs)
Returns the type class 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) |
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 the
fs . |
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.
|
Modifier and Type | Method and Description |
---|---|
int |
LinearTypeOrder.compare(FeatureStructure fs1,
FeatureStructure fs2)
Compare two Feature Structure's types
|
Modifier and Type | Class and Description |
---|---|
class |
org.apache.uima.cas.impl.FeatureStructureImplC
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 use
|
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.
|
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.
|
Modifier and Type | Method and Description |
---|---|
Type |
JCas.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)
|
Modifier and Type | Interface and Description |
---|---|
interface |
ArrayFSImpl<E extends FeatureStructure>
Deprecated.
use FSArray instead
|
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 compatibility
|
Modifier and Type | Interface and Description |
---|---|
interface |
ArrayFSImpl<E extends FeatureStructure>
Deprecated.
use FSArray instead
|
interface |
CommonList
This class is the super class of list nodes (both empty and non empty)
|
interface |
CommonPrimitiveArray<T>
This interface is implemented by arrays of non-FeatureStructure components
boolean, byte, short, int, long, float, double, String, JavaObject
Internal Use Only.
|
interface |
EmptyList
a marker interface for empty lists
|
interface |
NonEmptyList
a marker interface for nonempty lists
|
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<T extends TOP> |
class |
EmptyIntegerList |
class |
EmptyStringList |
class |
FloatArray
Java Cas model for Cas FloatArray.
|
class |
FloatList |
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(...) APIs
|
class |
FSHashSet<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.xml
|
class |
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.xml
|
class |
FSList<T extends TOP>
T extends TOP, v2 already mandated TOP for set/get
|
class |
Int2FS<T extends TOP>
A map from ints to Feature Structures
Is Pear aware - stores non-pear versions but may return pear version in pear contexts
|
class |
IntegerArray
The Java Class model corresponding to the Cas IntegerArray_JCasImpl type.
|
class |
IntegerArrayList
An ArrayList type containing ints, for UIMA
- implements a subset of the List API, Iterable<Integer>, IntListIterator.
|
class |
IntegerList |
class |
LongArray
JCas class model for LongArray
|
class |
NonEmptyFloatList |
class |
NonEmptyFSList<T extends TOP> |
class |
NonEmptyIntegerList |
class |
NonEmptyStringList |
class |
ShortArray
JCas class model for ShortArray
|
class |
Sofa |
class |
StringArray
JCas class model for StringArray
|
class |
StringList |
class |
TOP
The JCas Class model corresponding to the Cas TOP type.
|
Modifier and Type | Method and Description |
---|---|
<E extends FeatureStructure> |
FSArrayList.copyFromArray(E[] src,
int srcPos,
int destPos,
int length)
Copy from array.
|
<U extends FeatureStructure> |
FSArray.copyFromArray(U[] src,
int srcPos,
int destPos,
int length) |
<E extends FeatureStructure> |
FSArrayList.copyToArray(int srcPos,
E[] dest,
int destPos,
int length)
Copy to array.
|
<U extends FeatureStructure> |
FSArray.copyToArray(int srcPos,
U[] dest,
int destPos,
int length) |
static <U extends TOP,E extends FeatureStructure> |
FSList.create(JCas jcas,
E[] a)
Create an FSList from an existing array of Feature Structures
|
static <E extends TOP,F extends FeatureStructure> |
FSArrayList.create(JCas jcas,
F[] a)
Convenience - create a FSArrayList from an existing Array.
|
static <U extends FeatureStructure> |
FSArray.create(JCas jcas,
FeatureStructure[] a)
Convenience - create a FSArray from an existing FeatureStructure[]
|
<U extends FeatureStructure> |
FSArray.get(int i)
return the indexed value from the corresponding Cas FSArray as a Java Model object.
|
Modifier and Type | Method and Description |
---|---|
FeatureStructure[] |
FSArray._toArrayForSelect() |
FeatureStructure[] |
FSArrayList._toArrayForSelect() |
FeatureStructure[] |
SelectViaCopyToArray._toArrayForSelect() |
FeatureStructure |
Sofa.getLocalFSData() |
FeatureStructure[] |
FSArray.toArray() |
Modifier and Type | Method and Description |
---|---|
<E extends FeatureStructure> |
FSArrayList.copyFromArray(E[] src,
int srcPos,
int destPos,
int length)
Copy from array.
|
<U extends FeatureStructure> |
FSArray.copyFromArray(U[] src,
int srcPos,
int destPos,
int length) |
<E extends FeatureStructure> |
FSArrayList.copyToArray(int srcPos,
E[] dest,
int destPos,
int length)
Copy to array.
|
<U extends FeatureStructure> |
FSArray.copyToArray(int srcPos,
U[] dest,
int destPos,
int length) |
static <U extends TOP,E extends FeatureStructure> |
FSList.create(JCas jcas,
E[] a)
Create an FSList from an existing array of Feature Structures
|
static <E extends TOP,F extends FeatureStructure> |
FSArrayList.create(JCas jcas,
F[] a)
Convenience - create a FSArrayList from an existing Array.
|
static <U extends FeatureStructure> |
FSArray.create(JCas jcas,
FeatureStructure[] a)
Convenience - create a FSArray from an existing FeatureStructure[]
|
void |
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) |
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 |
---|---|
<T extends FeatureStructure> |
CasCopier.copyFs(T aFS)
Copy 1 feature structure from the originalSrcCas to a new Cas.
|
Modifier and Type | Method and Description |
---|---|
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.
|
Copyright © 2006–2019 The Apache Software Foundation. All rights reserved.