Logo Search packages:      
Sourcecode: uimaj version File versions  Download package

Public Member Functions | Static Public Attributes | Package Functions | Static Package Attributes

org::apache::uima::cas::CAS Interface Reference

Inheritance diagram for org::apache::uima::cas::CAS:
Inheritance graph
[legend]
Collaboration diagram for org::apache::uima::cas::CAS:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void addFsToIndexes (FeatureStructure fs)
AnnotationFS createAnnotation (Type type, int begin, int end)
ArrayFS createArrayFS (int length) throws CASRuntimeException
BooleanArrayFS createBooleanArrayFS (int length) throws CASRuntimeException
ByteArrayFS createByteArrayFS (int length) throws CASRuntimeException
DoubleArrayFS createDoubleArrayFS (int length) throws CASRuntimeException
FeaturePath createFeaturePath ()
FeatureValuePath createFeatureValuePath (String featureValuePath) throws CASRuntimeException
< TextendsFeatureStructure >
FSIterator< T > 
createFilteredIterator (FSIterator< T > it, FSMatchConstraint cons)
FloatArrayFS createFloatArrayFS (int length) throws CASRuntimeException
FeatureStructure createFS (Type type) throws CASRuntimeException
IntArrayFS createIntArrayFS (int length) throws CASRuntimeException
LongArrayFS createLongArrayFS (int length) throws CASRuntimeException
Marker createMarker ()
ShortArrayFS createShortArrayFS (int length) throws CASRuntimeException
SofaFS createSofa (SofaID sofaID, String mimeType)
StringArrayFS createStringArrayFS (int length) throws CASRuntimeException
CAS createView (String localViewName)
< TextendsFeatureStructure >
ListIterator< T > 
fs2listIterator (FSIterator< T > it)
AnnotationIndex< AnnotationFSgetAnnotationIndex ()
AnnotationIndex< AnnotationFSgetAnnotationIndex (Type type) throws CASRuntimeException
Type getAnnotationType ()
Feature getBeginFeature ()
ConstraintFactory getConstraintFactory ()
CAS getCurrentView ()
AnnotationFS getDocumentAnnotation ()
String getDocumentLanguage ()
String getDocumentText ()
Feature getEndFeature ()
FSIndexRepository getIndexRepository ()
JCas getJCas (SofaFS aSofa) throws CASException
JCas getJCas (SofaID aSofaID) throws CASException
JCas getJCas () throws CASException
LowLevelCAS getLowLevelCAS ()
SofaFS getSofa (SofaID sofaID)
SofaFS getSofa ()
FeatureStructure getSofaDataArray ()
InputStream getSofaDataStream ()
String getSofaDataString ()
String getSofaDataURI ()
FSIterator< SofaFSgetSofaIterator ()
String getSofaMimeType ()
TypeSystem getTypeSystem () throws CASRuntimeException
CAS getView (String localViewName)
CAS getView (SofaFS aSofa)
Iterator< CASgetViewIterator (String localViewNamePrefix)
Iterator< CASgetViewIterator ()
String getViewName ()
void removeFsFromIndexes (FeatureStructure fs)
void reset () throws CASAdminException
void setCurrentComponentInfo (ComponentInfo info)
void setDocumentLanguage (String languageCode) throws CASRuntimeException
void setDocumentText (String text) throws CASRuntimeException
void setSofaDataArray (FeatureStructure array, String mime) throws CASRuntimeException
void setSofaDataString (String text, String mimetype) throws CASRuntimeException
void setSofaDataURI (String uri, String mime) throws CASRuntimeException
int size ()

Static Public Attributes

static final String DEFAULT_LANGUAGE_NAME = "x-unspecified"
static final String FEATURE_BASE_NAME_BEGIN = "begin"
static final String FEATURE_BASE_NAME_END = "end"
static final String FEATURE_BASE_NAME_HEAD = "head"
static final String FEATURE_BASE_NAME_LANGUAGE = "language"
static final String FEATURE_BASE_NAME_SOFA = "sofa"
static final String FEATURE_BASE_NAME_SOFAARRAY = "sofaArray"
static final String FEATURE_BASE_NAME_SOFAID = "sofaID"
static final String FEATURE_BASE_NAME_SOFAMIME = "mimeType"
static final String FEATURE_BASE_NAME_SOFANUM = "sofaNum"
static final String FEATURE_BASE_NAME_SOFASTRING = "sofaString"
static final String FEATURE_BASE_NAME_SOFAURI = "sofaURI"
static final String FEATURE_BASE_NAME_TAIL = "tail"
static final String FEATURE_FULL_NAME_BEGIN
static final String FEATURE_FULL_NAME_END
static final String FEATURE_FULL_NAME_FLOAT_LIST_HEAD
static final String FEATURE_FULL_NAME_FLOAT_LIST_TAIL
static final String FEATURE_FULL_NAME_FS_LIST_HEAD
static final String FEATURE_FULL_NAME_FS_LIST_TAIL
static final String FEATURE_FULL_NAME_INTEGER_LIST_HEAD
static final String FEATURE_FULL_NAME_INTEGER_LIST_TAIL
static final String FEATURE_FULL_NAME_LANGUAGE
static final String FEATURE_FULL_NAME_SOFA
static final String FEATURE_FULL_NAME_SOFAARRAY
static final String FEATURE_FULL_NAME_SOFAID
static final String FEATURE_FULL_NAME_SOFAMIME
static final String FEATURE_FULL_NAME_SOFANUM
static final String FEATURE_FULL_NAME_SOFASTRING
static final String FEATURE_FULL_NAME_SOFAURI
static final String FEATURE_FULL_NAME_STRING_LIST_HEAD
static final String FEATURE_FULL_NAME_STRING_LIST_TAIL
static final String NAME_DEFAULT_SOFA = "_InitialView"
static final String NAME_DEFAULT_TEXT_SOFA = "_InitialView"
static final String NAME_SPACE_UIMA_TCAS = "tcas"
static final String SOFA_INDEX_NAME = "SofaIndex"
static final String STD_ANNOTATION_INDEX = "AnnotationIndex"
static final String TYPE_NAME_ANNOTATION = "Annotation"
static final String TYPE_NAME_ANNOTATION_BASE = "AnnotationBase"
static final String TYPE_NAME_ARRAY_BASE = "ArrayBase"
static final String TYPE_NAME_BOOLEAN = "Boolean"
static final String TYPE_NAME_BOOLEAN_ARRAY = "BooleanArray"
static final String TYPE_NAME_BYTE = "Byte"
static final String TYPE_NAME_BYTE_ARRAY = "ByteArray"
static final String TYPE_NAME_DOCUMENT_ANNOTATION = "DocumentAnnotation"
static final String TYPE_NAME_DOUBLE = "Double"
static final String TYPE_NAME_DOUBLE_ARRAY = "DoubleArray"
static final String TYPE_NAME_EMPTY_FLOAT_LIST = "EmptyFloatList"
static final String TYPE_NAME_EMPTY_FS_LIST = "EmptyFSList"
static final String TYPE_NAME_EMPTY_INTEGER_LIST = "EmptyIntegerList"
static final String TYPE_NAME_EMPTY_STRING_LIST = "EmptyStringList"
static final String TYPE_NAME_FLOAT = "Float"
static final String TYPE_NAME_FLOAT_ARRAY = "FloatArray"
static final String TYPE_NAME_FLOAT_LIST = "FloatList"
static final String TYPE_NAME_FS_ARRAY = "FSArray"
static final String TYPE_NAME_FS_LIST = "FSList"
static final String TYPE_NAME_INTEGER = "Integer"
static final String TYPE_NAME_INTEGER_ARRAY = "IntegerArray"
static final String TYPE_NAME_INTEGER_LIST = "IntegerList"
static final String TYPE_NAME_LIST_BASE = "ListBase"
static final String TYPE_NAME_LONG = "Long"
static final String TYPE_NAME_LONG_ARRAY = "LongArray"
static final String TYPE_NAME_NON_EMPTY_FLOAT_LIST = "NonEmptyFloatList"
static final String TYPE_NAME_NON_EMPTY_FS_LIST = "NonEmptyFSList"
static final String TYPE_NAME_NON_EMPTY_INTEGER_LIST = "NonEmptyIntegerList"
static final String TYPE_NAME_NON_EMPTY_STRING_LIST = "NonEmptyStringList"
static final String TYPE_NAME_SHORT = "Short"
static final String TYPE_NAME_SHORT_ARRAY = "ShortArray"
static final String TYPE_NAME_SOFA = "Sofa"
static final String TYPE_NAME_STRING = "String"
static final String TYPE_NAME_STRING_ARRAY = "StringArray"
static final String TYPE_NAME_STRING_LIST = "StringList"
static final String TYPE_NAME_TOP = "TOP"
static final String UIMA_CAS_PREFIX = NAME_SPACE_UIMA_CAS + TypeSystem.NAMESPACE_SEPARATOR

Package Functions

void release ()

Static Package Attributes

static final String NAME_SPACE_UIMA_CAS = "cas"

Detailed Description

Object-oriented CAS (Common Analysis System) API.

A CAS object provides the starting point for working with the CAS. It provides access to the type system, to indexes, iterators and filters (constraints). It also lets you create new annotations and other data structures. You can create a CAS object using static methods on the class org.apache.uima.util.CasCreationUtils.

The CAS object is also the container that manages multiple Subjects of Analysis or Sofas. A Sofa represents some form of an unstructured artifact that is processed in a UIMA pipeline. The Java string called the "DocumentText" used in a UIMA text processing pipeline is an example of a Sofa. A Sofa can be analyzed independently using the standard UIMA programming model or analyzed together with other Sofas utilizing the Sofa programming model extensions.

A Sofa is implemented as a built-in CAS type uima.cas.Sofa. Use CAS.createSofa() to instantiate a Sofa feature structure. The SofaFS class provides methods to set and get the features of a SofaFS. Although Sofas are implemented as standard feature structures, generic CAS APIs must never be used to create Sofas or set their features.

Use org.apache.uima.cas.CAS#getView(String) or org.apache.uima.cas.CAS#getView(SofaFS) to obtain a view of a particular Sofa in the CAS. This view will provide access to the Sofa data (for example the document text) as well as the index repository, which contains metadata (annotations and other feature structures) about that Sofa.

Use getTypeSystem() to access the type system. With a TypeSystem object, you can access the Type and Feature objects for the CAS built-in types. Note that this interface also provides constants for the names of the built-in types and features.

Definition at line 67 of file CAS.java.


The documentation for this interface was generated from the following file:

Generated by  Doxygen 1.6.0   Back to index