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

Public Member Functions | Package Functions

org::apache::uima::cas::SofaFS Interface Reference

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

List of all members.

Public Member Functions

Object clone () throws CASRuntimeException
boolean equals (Object o) throws ClassCastException
boolean getBooleanValue (Feature feat) throws CASRuntimeException
byte getByteValue (Feature feat) throws CASRuntimeException
CAS getCAS ()
double getDoubleValue (Feature feat) throws CASRuntimeException
FeatureStructure getFeatureValue (Feature feat) throws CASRuntimeException
String getFeatureValueAsString (Feature feat) throws CASRuntimeException
float getFloatValue (Feature feat) throws CASRuntimeException
int getIntValue (Feature feat) throws CASRuntimeException
FeatureStructure getLocalFSData ()
String getLocalStringData ()
long getLongValue (Feature feat) throws CASRuntimeException
short getShortValue (Feature feat) throws CASRuntimeException
InputStream getSofaDataStream ()
String getSofaID ()
String getSofaMime ()
int getSofaRef ()
String getSofaURI ()
String getStringValue (Feature f) throws CASRuntimeException
int hashCode ()
void setBooleanValue (Feature feat, boolean i) throws CASRuntimeException
void setByteValue (Feature feat, byte i) throws CASRuntimeException
void setDoubleValue (Feature feat, double i) throws CASRuntimeException
void setFeatureValue (Feature feat, FeatureStructure fs) throws CASRuntimeException
void setFeatureValueFromString (Feature feat, String s) throws CASRuntimeException
void setFloatValue (Feature feat, float f) throws CASRuntimeException
void setIntValue (Feature feat, int i) throws CASRuntimeException
void setLocalSofaData (String aString) throws CASRuntimeException
void setLocalSofaData (FeatureStructure aFS) throws CASRuntimeException
void setLongValue (Feature feat, long i) throws CASRuntimeException
void setShortValue (Feature feat, short i) throws CASRuntimeException
void setStringValue (Feature feat, String s) throws CASRuntimeException

Package Functions

Type getType ()
void setRemoteSofaURI (String aURI) throws CASRuntimeException

Detailed Description

Interface for "Subject of Analysis" (Sofa) feature structures. A Sofa is implemented as a built-in CAS type uima.cas.Sofa. The features of the Sofa type include:

SofaFS (the feature structure that represents a sofa) are created as a side effect of creating a new CAS view. To create a new CAS view, use CAS.createView(string-view-name). From the returned CAS view, you can get the associated SofaFS instance, using CAS.getSofa(). The SofaFS interface provides methods to set the values of the features of the Sofa FS. Generic CAS APIs should never be used to create Sofas or set their features.

Sofa data can be contained locally in the CAS itself or it can be remote from CAS. To set the local Sofa data in the Sofa FS use: SofaFS.setLocalSofaData(). If the data is remote from the CAS use: SofaFS.setRemoteSofaURI().

Once set, the Sofa data cannot be set again until the CAS has been reset. This is so that annotators cannot change the subject of analysis during processing.

Definition at line 54 of file SofaFS.java.


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

Generated by  Doxygen 1.6.0   Back to index