---

             

---

uima::SofaFS Class Reference

Inherits uima::FeatureStructure.

List of all members.

---

Detailed Description

The Sofa is implemented as a feature structure of type uima.cas.Sofa.

Class SofaFS derives from a standard FeatureStrucure and extends with convenience functions specific for feature structures of type uima.cas.Sofa.
The generic CAS Apis must never be used to set/get features of a Sofa. Instead SofaFS methods must be used to set/get features of a Sofa.
The features of the Sofa type include:

• SofaID : Every Sofa in a CAS must have a unique SofaID. SofaIDs are the primary handle or access.
• Mime type : This string feature can be used to describe the type of the data represented by the Sofa.
• Sofa Data : The data itself. This data can be resident in the CAS or it can be a reference to data outside the CAS.

To create a Sofa FS, use CAS.createSofa().

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: uima::SofaFS::setLocalSofaData(). If the data is remote from the CAS use: uima::SofaFS::setRemoteSofaURI().

Public Types
typedef lowlevel::TyHeapCell	TyArrayElement
Public Member Functions
	SofaFS ()
	Default constructor.
	SofaFS (FeatureStructure const &fs)
	Promote a generic FeatureStructure object to an SofaFS.
void	setLocalSofaData (FeatureStructure aFS)
	Set the Local Subject of Analysis to be a predefined ArrayFS.
void	setLocalSofaData (UnicodeStringRef const aString)
	Set the Local Subject of Analysis to be a String.
void	setRemoteSofaURI (const char *aURI)
	Set the Remote Subject of Analysis URI.
void	setRemoteSofaURI (icu::UnicodeString const &aString)
UnicodeStringRef	getSofaID ()
	Get the Sofa name.
UnicodeStringRef	getSofaMime ()
	Get the Sofa mime type.
UnicodeStringRef	getSofaURI ()
	Get the Sofa URI value.
int	getSofaRef ()
	Get the Sofa Ref value.
FeatureStructure	getLocalFSData ()
	Get the Sofa FSArray value.
UnicodeStringRef	getLocalStringData ()
	Get the Sofa FSArray value.
SofaDataStream *	getSofaDataStream ()
	Get the Sofa Data Stream for this SofA fs.
CAS &	getCAS ()
	Returns the CAS object in which this feature structure lives.
CAS const &	getCAS () const
bool	isValid () const
	Check if this FS object is valid, i.e., properly initialized.
Type	getType () const
FeatureStructure	clone ()
	Creates a copy of this feature structure.
FeatureStructure	clone (Type const &t)
	creates a feature structure of type t and copies all "common" features of t and this->getType().
bool	isUntouchedFSValue (Feature const &crFeature) const
	Check if the value of crFeature was already used via a call to getFSValue() or setFSValue().
FeatureStructure	getFSValue (Feature const &crFeature) const
	Get the value of feature crFeature of this feature structure (must not be a builtin type).
FeatureStructure	getFeatureValue (Feature const &crFeature) const
	Get the value of feature crFeature of this feature structure (must not be a builtin type).
void	setFSValue (Feature const &crFeature, FeatureStructure const &anFS)
	set the value of feature crFeature of this feature structure (must not be a builtin type).
void	setFeatureValue (Feature const &crFeature, FeatureStructure const &anFS)
	set the value of feature crFeature of this feature structure (must not be a builtin type).
int	getIntValue (Feature const &crFeature) const
	Get the value of feature crFeature, must be builtin type integer.
void	setIntValue (Feature const &crFeature, int i)
	Set the value of feature crFeature, must be builtin type integer.
float	getFloatValue (Feature const &crFeature) const
	Get the value of feature crFeature, must be builtin type float.
void	setFloatValue (Feature const &crFeature, float)
	Set the value of feature crFeature, must be builtin type float.
UnicodeStringRef	getStringValue (Feature const &crFeature) const
	Get the value of feature crFeature, must be of type string.
void	setStringValue (Feature const &crFeature, UnicodeStringRef cuStr)
	sets the value of feature crFeature of this feature structure to a new string on the heap.
void	setStringValue (Feature const &crFeature, UChar const *cuStr, size_t uiLen)
void	setStringValue (Feature const &crFeature, icu::UnicodeString const &crustr)
void	setStringValueExternal (Feature const &crFeature, UnicodeStringRef cuStr)
	sets the value of feature crFeature of this feature structure to a new string outside of the heap.
void	setStringValueExternal (Feature const &crFeature, UChar const *cuStr, size_t uiLen)
void	setStringValueExternal (Feature const &crFeature, icu::UnicodeString const &crustr)
ArrayFS	getArrayFSValue (Feature const &fArray) const
	Return feature structure of type array stored at feature fArray.
FloatArrayFS	getFloatArrayFSValue (Feature const &fArray) const
	Return feature structure of type array stored at feature fArray.
IntArrayFS	getIntArrayFSValue (Feature const &fArray) const
	Return feature structure of type array stored at feature fArray.
StringArrayFS	getStringArrayFSValue (Feature const &fArray) const
	Return feature structure of type array stored at feature fArray.
bool	hasListElements (Feature const &fList) const
	Returns true if the list stored at feature fList has elements.
ListFS	getListFSValue (Feature const &fList) const
	Return feature structure of type list stored at feature fList.
FloatListFS	getFloatListFSValue (Feature const &f) const
	Return feature structure of type list stored at feature fList.
IntListFS	getIntListFSValue (Feature const &f) const
	Return feature structure of type list stored at feature fList.
StringListFS	getStringListFSValue (Feature const &f) const
	Return feature structure of type list stored at feature fList.
bool	getBooleanValue (Feature const &crFeature) const
	Get the value of feature crFeature, must be builtin type byte.
void	setBooleanValue (Feature const &crFeature, bool)
	Set the value of feature crFeature, must be builtin type byte.
char	getByteValue (Feature const &crFeature) const
	Get the value of feature crFeature, must be builtin type byte.
void	setByteValue (Feature const &crFeature, char)
	Set the value of feature crFeature, must be builtin type byte.
short	getShortValue (Feature const &crFeature) const
	Get the value of feature crFeature, must be builtin type short.
void	setShortValue (Feature const &crFeature, short)
	Set the value of feature crFeature, must be builtin type short.
INT64	getLongValue (Feature const &crFeature) const
	Get the value of feature crFeature, must be builtin type short.
void	setLongValue (Feature const &crFeature, INT64)
	Set the value of feature crFeature, must be builtin type short.
void	setDoubleValue (Feature const &crFeature, double)
	Set the value of feature crFeature, must be builtin type short.
double	getDoubleValue (Feature const &crFeature) const
	Get the value of feature crFeature, must be builtin type short.
BooleanArrayFS	getBooleanArrayFSValue (Feature const &fArray) const
	Return feature structure of type array stored at feature fArray.
ByteArrayFS	getByteArrayFSValue (Feature const &fArray) const
	Return feature structure of type array stored at feature fArray.
ShortArrayFS	getShortArrayFSValue (Feature const &fArray) const
	Return feature structure of type array stored at feature fArray.
LongArrayFS	getLongArrayFSValue (Feature const &fArray) const
	Return feature structure of type array stored at feature fArray.
DoubleArrayFS	getDoubleArrayFSValue (Feature const &fArray) const
	Return feature structure of type array stored at feature fArray.
bool	operator== (FeatureStructure const &) const
bool	operator!= (FeatureStructure const &crFS) const
bool	operator< (FeatureStructure const &crFS) const
Static Public Member Functions
SofaDataStream *	getSofaDataStream (FeatureStructure &fs)
	Get the Sofa Data Stream for the give Sofa FeatureStructure.
Protected Member Functions
void	setSofaMime (icu::UnicodeString const &aString)
	Set the Sofa mime type.
void	checkValidity (TyMessageId) const
void	checkFeature (Feature const &f, TyMessageId) const
void	checkNonBuiltinFeature (Feature const &f, TyMessageId) const
void	checkAppropFeature (Feature const &f, lowlevel::TyFSType aType, TyMessageId) const
void	checkAppropFeature (Feature const &f, FeatureStructure const &anFS, TyMessageId) const
void	checkRangeIsString (Feature const &fList, TyMessageId) const
Protected Attributes
lowlevel::TyFS	iv_tyFS
CAS *	iv_cas

---

Member Typedef Documentation

typedef lowlevel::TyHeapCell uima::FeatureStructure::TyArrayElement [inherited]

---

Constructor & Destructor Documentation

uima::SofaFS::SofaFS (   )  [inline]

Default constructor. Creates an invalid SofaFS.

uima::SofaFS::SofaFS (  FeatureStructure const &  fs  )  [explicit]

Promote a generic FeatureStructure object to an SofaFS. fs must be of type sofa. If fs is not of type sofa the operation will not immediately fail but access to member functions of SofaFS will result in exceptions beeing thrown. This is done by value like all FS API but SofaFS and FS are shallow objects.

---

Member Function Documentation

void uima::SofaFS::setSofaMime (  icu::UnicodeString const &  aString  )  [protected]

Set the Sofa mime type.

void uima::SofaFS::setLocalSofaData (  FeatureStructure  aFS  )

Set the Local Subject of Analysis to be a predefined ArrayFS.

void uima::SofaFS::setLocalSofaData (  UnicodeStringRef const   aString  )

Set the Local Subject of Analysis to be a String.

void uima::SofaFS::setRemoteSofaURI (  const char *  aURI  )

Set the Remote Subject of Analysis URI.

void uima::SofaFS::setRemoteSofaURI (  icu::UnicodeString const &  aString  )

UnicodeStringRef uima::SofaFS::getSofaID (   )

Get the Sofa name. Returns: String

UnicodeStringRef uima::SofaFS::getSofaMime (   )

Get the Sofa mime type. Returns: String

UnicodeStringRef uima::SofaFS::getSofaURI (   )

Get the Sofa URI value. Returns: String or null if not valid

int uima::SofaFS::getSofaRef (   )

Get the Sofa Ref value. Returns: the integer identifier for this Sofa

FeatureStructure uima::SofaFS::getLocalFSData (   )

Get the Sofa FSArray value. Returns: FeatureStructure (invalid FS if not valid)

UnicodeStringRef uima::SofaFS::getLocalStringData (   )

Get the Sofa FSArray value. Returns: String or null if not valid

SofaDataStream* uima::SofaFS::getSofaDataStream (   )

Get the Sofa Data Stream for this SofA fs. Values for one of these features -- sofaString, SofaArray, sofaURI -- must have been set. If the sofaURI has a valid value, a valid SofaDataStream is returned only if there is a stream handler registered for the URI scheme. Returns: a SofaDataStream or null if not valid

SofaDataStream* uima::SofaFS::getSofaDataStream (  FeatureStructure &  fs  )  [static]

Get the Sofa Data Stream for the give Sofa FeatureStructure. Parameters: fs  a valid SofA feature structure with values for one of these feature -- sofaString, sofaArray, or sofaURI -- set. If the sofaURI feature has a valid value, a valid SofaDataStream is returned only if there is a stream handler registered for the URI scheme. Returns: a SofaDataStream or null if not valid

void uima::FeatureStructure::checkValidity (  TyMessageId   )  const [protected, inherited]

void uima::FeatureStructure::checkFeature (  Feature const &  f, TyMessageId  )  const [protected, inherited]

void uima::FeatureStructure::checkNonBuiltinFeature (  Feature const &  f, TyMessageId  )  const [protected, inherited]

void uima::FeatureStructure::checkAppropFeature (  Feature const &  f, lowlevel::TyFSType  aType, TyMessageId  )  const [protected, inherited]

void uima::FeatureStructure::checkAppropFeature (  Feature const &  f, FeatureStructure const &  anFS, TyMessageId  )  const [protected, inherited]

void uima::FeatureStructure::checkRangeIsString (  Feature const &  fList, TyMessageId  )  const [protected, inherited]

CAS& uima::FeatureStructure::getCAS (   )  [inherited]

Returns the CAS object in which this feature structure lives. Reimplemented in uima::AnnotationFS.

CAS const& uima::FeatureStructure::getCAS (   )  const [inherited]

Reimplemented in uima::AnnotationFS.

bool uima::FeatureStructure::isValid (   )  const [inherited]

Check if this FS object is valid, i.e., properly initialized.

Type uima::FeatureStructure::getType (   )  const [inherited]

Returns: the type of this FS. Exceptions: InvalidFSObjectException

FeatureStructure uima::FeatureStructure::clone (   )  [inherited]

Creates a copy of this feature structure. The returned feature structure is a new and separate object but all features of the feature structure which are not of builtin types (integer, float, string) will be shared between the clone and it's source FS. Returns: the cloned copy of this object. Exceptions: InvalidFSObjectException

FeatureStructure uima::FeatureStructure::clone (  Type const &  t  )  [inherited]

creates a feature structure of type t and copies all "common" features of t and this->getType(). A feature is common to two types t1 and t2 if it is defined on the most specific common supertype of t1 and t2.

bool uima::FeatureStructure::isUntouchedFSValue (  Feature const &  crFeature  )  const [inherited]

Check if the value of crFeature was already used via a call to getFSValue() or setFSValue(). Exceptions: InvalidFSObjectException  FeatureNotAppropriateException

FeatureStructure uima::FeatureStructure::getFSValue (  Feature const &  crFeature  )  const [inherited]

Get the value of feature crFeature of this feature structure (must not be a builtin type). Exceptions: InvalidFSObjectException  FeatureNotAppropriateException

FeatureStructure uima::FeatureStructure::getFeatureValue (  Feature const &  crFeature  )  const [inherited]

Get the value of feature crFeature of this feature structure (must not be a builtin type). Exceptions: InvalidFSObjectException  FeatureNotAppropriateException

void uima::FeatureStructure::setFSValue (  Feature const &  crFeature, FeatureStructure const &  anFS )  [inherited]

set the value of feature crFeature of this feature structure (must not be a builtin type). Exceptions: InvalidFSObjectException  FeatureNotAppropriateException  IncompatibleValueTypeException

void uima::FeatureStructure::setFeatureValue (  Feature const &  crFeature, FeatureStructure const &  anFS )  [inherited]

set the value of feature crFeature of this feature structure (must not be a builtin type). Exceptions: InvalidFSObjectException  FeatureNotAppropriateException  IncompatibleValueTypeException

int uima::FeatureStructure::getIntValue (  Feature const &  crFeature  )  const [inherited]

Get the value of feature crFeature, must be builtin type integer. Exceptions: InvalidFSObjectException  FeatureNotAppropriateException  IncompatibleValueTypeException

void uima::FeatureStructure::setIntValue (  Feature const &  crFeature, int  i )  [inherited]

Set the value of feature crFeature, must be builtin type integer. Exceptions: InvalidFSObjectException  FeatureNotAppropriateException  IncompatibleValueTypeException

float uima::FeatureStructure::getFloatValue (  Feature const &  crFeature  )  const [inherited]

Get the value of feature crFeature, must be builtin type float. Exceptions: InvalidFSObjectException  FeatureNotAppropriateException  IncompatibleValueTypeException

void uima::FeatureStructure::setFloatValue (  Feature const &  crFeature, float  )  [inherited]

Set the value of feature crFeature, must be builtin type float. Exceptions: InvalidFSObjectException  FeatureNotAppropriateException  IncompatibleValueTypeException

UnicodeStringRef uima::FeatureStructure::getStringValue (  Feature const &  crFeature  )  const [inherited]

Get the value of feature crFeature, must be of type string. Exceptions: InvalidFSObjectException  FeatureNotAppropriateException  FSIsNotAStringException

void uima::FeatureStructure::setStringValue (  Feature const &  crFeature, UnicodeStringRef  cuStr )  [inherited]

sets the value of feature crFeature of this feature structure to a new string on the heap. Precondition: getFSValue(crFeature) must be of type string. The string is copied to the heap and the string value will point to the copy on the heap and not to cuStr. Exceptions: InvalidFSObjectException  FeatureNotAppropriateException  FSIsNotAStringException

void uima::FeatureStructure::setStringValue (  Feature const &  crFeature, UChar const *  cuStr, size_t  uiLen )  [inline, inherited]

void uima::FeatureStructure::setStringValue (  Feature const &  crFeature, icu::UnicodeString const &  crustr )  [inline, inherited]

void uima::FeatureStructure::setStringValueExternal (  Feature const &  crFeature, UnicodeStringRef  cuStr )  [inherited]

sets the value of feature crFeature of this feature structure to a new string outside of the heap. Precondition: FS must be of type string. The string is not copied to the heap, so the string value will point to cuStr. The caller must make sure that the characters in cuStr have an appropriate live time. For persistency of the CAS to be consistent and complete the caller must make sure that all the string data lives somewhere on the heap. Exceptions: InvalidFSObjectException  FSIsNotAStringException

void uima::FeatureStructure::setStringValueExternal (  Feature const &  crFeature, UChar const *  cuStr, size_t  uiLen )  [inline, inherited]

void uima::FeatureStructure::setStringValueExternal (  Feature const &  crFeature, icu::UnicodeString const &  crustr )  [inline, inherited]

ArrayFS uima::FeatureStructure::getArrayFSValue (  Feature const &  fArray  )  const [inherited]

Return feature structure of type array stored at feature fArray. The return value is guaranteed to be a properly terminated array. Each element in the array is a FeatureStructure. Parameters: fArray  The feature referencing the array to return. fArray must be valid. fArray must be appropriate for this feature strucutre. fArray must be subsumed by type array. Exceptions: InvalidFSObjectException  InvalidFSFeatureObjectException  FeatureNotAppropriateException  FSIsNotArrayException

FloatArrayFS uima::FeatureStructure::getFloatArrayFSValue (  Feature const &  fArray  )  const [inherited]

Return feature structure of type array stored at feature fArray. The return value is guaranteed to be a properly terminated array. Each element in the array is a float. Parameters: fArray  The feature referencing the array to return. fArray must be valid. fArray must be appropriate for this feature strucutre. fArray must be subsumed by type array. Exceptions: InvalidFSObjectException  InvalidFSFeatureObjectException  FeatureNotAppropriateException  FSIsNotArrayException

IntArrayFS uima::FeatureStructure::getIntArrayFSValue (  Feature const &  fArray  )  const [inherited]

Return feature structure of type array stored at feature fArray. The return value is guaranteed to be a properly terminated array. Each element in the array is a int. Parameters: fArray  The feature referencing the array to return. fArray must be valid. fArray must be appropriate for this feature strucutre. fArray must be subsumed by type array. Exceptions: InvalidFSObjectException  InvalidFSFeatureObjectException  FeatureNotAppropriateException  FSIsNotArrayException

StringArrayFS uima::FeatureStructure::getStringArrayFSValue (  Feature const &  fArray  )  const [inherited]

Return feature structure of type array stored at feature fArray. The return value is guaranteed to be a properly terminated array. Each element in the array is a string. Parameters: fArray  The feature referencing the array to return. fArray must be valid. fArray must be appropriate for this feature strucutre. fArray must be subsumed by type array. Exceptions: InvalidFSObjectException  InvalidFSFeatureObjectException  FeatureNotAppropriateException  FSIsNotArrayException

bool uima::FeatureStructure::hasListElements (  Feature const &  fList  )  const [inherited]

Returns true if the list stored at feature fList has elements. Parameters: fList  The feature to check. fList must be of type list Exceptions: InvalidFSObjectException  InvalidFSFeatureObjectException  FeatureNotAppropriateException  FSIsNotListException

ListFS uima::FeatureStructure::getListFSValue (  Feature const &  fList  )  const [inherited]

Return feature structure of type list stored at feature fList. The return value is guaranteed to be a properly terminated list. Each element of the list is a feature structure. Parameters: fList  The feature referencing the list to return. fList must be valid. fList must be appropriate for this feature strucutre. fList must be subsumed by type list. Exceptions: InvalidFSObjectException  InvalidFSFeatureObjectException  FeatureNotAppropriateException  FSIsNotListException

FloatListFS uima::FeatureStructure::getFloatListFSValue (  Feature const &  f  )  const [inherited]

Return feature structure of type list stored at feature fList. The return value is guaranteed to be a properly terminated list. Each element of the list is a float. Parameters: f  The feature referencing the list to return. f must be valid. f must be appropriate for this feature strucutre. f must be subsumed by type list. Exceptions: InvalidFSObjectException  InvalidFSFeatureObjectException  FeatureNotAppropriateException  FSIsNotListException

IntListFS uima::FeatureStructure::getIntListFSValue (  Feature const &  f  )  const [inherited]

Return feature structure of type list stored at feature fList. The return value is guaranteed to be a properly terminated list. Each element of the list is a int. Parameters: f  The feature referencing the list to return. f must be valid. f must be appropriate for this feature strucutre. f must be subsumed by type list. Exceptions: InvalidFSObjectException  InvalidFSFeatureObjectException  FeatureNotAppropriateException  FSIsNotListException

StringListFS uima::FeatureStructure::getStringListFSValue (  Feature const &  f  )  const [inherited]

Return feature structure of type list stored at feature fList. The return value is guaranteed to be a properly terminated list. Each element of the list is a string. Parameters: f  The feature referencing the list to return. f must be valid. f must be appropriate for this feature strucutre. f must be subsumed by type list. Exceptions: InvalidFSObjectException  InvalidFSFeatureObjectException  FeatureNotAppropriateException  FSIsNotListException

bool uima::FeatureStructure::getBooleanValue (  Feature const &  crFeature  )  const [inherited]

Get the value of feature crFeature, must be builtin type byte. Exceptions: InvalidFSObjectException  FeatureNotAppropriateException  IncompatibleValueTypeException

void uima::FeatureStructure::setBooleanValue (  Feature const &  crFeature, bool  )  [inherited]

Set the value of feature crFeature, must be builtin type byte. Exceptions: InvalidFSObjectException  FeatureNotAppropriateException  IncompatibleValueTypeException

char uima::FeatureStructure::getByteValue (  Feature const &  crFeature  )  const [inherited]

Get the value of feature crFeature, must be builtin type byte. Exceptions: InvalidFSObjectException  FeatureNotAppropriateException  IncompatibleValueTypeException

void uima::FeatureStructure::setByteValue (  Feature const &  crFeature, char  )  [inherited]

Set the value of feature crFeature, must be builtin type byte. Exceptions: InvalidFSObjectException  FeatureNotAppropriateException  IncompatibleValueTypeException

short uima::FeatureStructure::getShortValue (  Feature const &  crFeature  )  const [inherited]

Get the value of feature crFeature, must be builtin type short. Exceptions: InvalidFSObjectException  FeatureNotAppropriateException  IncompatibleValueTypeException

void uima::FeatureStructure::setShortValue (  Feature const &  crFeature, short  )  [inherited]

Set the value of feature crFeature, must be builtin type short. Exceptions: InvalidFSObjectException  FeatureNotAppropriateException  IncompatibleValueTypeException

INT64 uima::FeatureStructure::getLongValue (  Feature const &  crFeature  )  const [inherited]

Get the value of feature crFeature, must be builtin type short. Exceptions: InvalidFSObjectException  FeatureNotAppropriateException  IncompatibleValueTypeException

void uima::FeatureStructure::setLongValue (  Feature const &  crFeature, INT64  )  [inherited]

Set the value of feature crFeature, must be builtin type short. Exceptions: InvalidFSObjectException  FeatureNotAppropriateException  IncompatibleValueTypeException

void uima::FeatureStructure::setDoubleValue (  Feature const &  crFeature, double  )  [inherited]

Set the value of feature crFeature, must be builtin type short. Exceptions: InvalidFSObjectException  FeatureNotAppropriateException  IncompatibleValueTypeException

double uima::FeatureStructure::getDoubleValue (  Feature const &  crFeature  )  const [inherited]

Get the value of feature crFeature, must be builtin type short. Exceptions: InvalidFSObjectException  FeatureNotAppropriateException  IncompatibleValueTypeException

BooleanArrayFS uima::FeatureStructure::getBooleanArrayFSValue (  Feature const &  fArray  )  const [inherited]

Return feature structure of type array stored at feature fArray. The return value is guaranteed to be a properly terminated array. Each element in the array is a byte. Parameters: fArray  The feature referencing the array to return. fArray must be valid. fArray must be appropriate for this feature strucutre. fArray must be subsumed by type array. Exceptions: InvalidFSObjectException  InvalidFSFeatureObjectException  FeatureNotAppropriateException  FSIsNotArrayException

ByteArrayFS uima::FeatureStructure::getByteArrayFSValue (  Feature const &  fArray  )  const [inherited]

Return feature structure of type array stored at feature fArray. The return value is guaranteed to be a properly terminated array. Each element in the array is a byte. Parameters: fArray  The feature referencing the array to return. fArray must be valid. fArray must be appropriate for this feature strucutre. fArray must be subsumed by type array. Exceptions: InvalidFSObjectException  InvalidFSFeatureObjectException  FeatureNotAppropriateException  FSIsNotArrayException

ShortArrayFS uima::FeatureStructure::getShortArrayFSValue (  Feature const &  fArray  )  const [inherited]

Return feature structure of type array stored at feature fArray. The return value is guaranteed to be a properly terminated array. Each element in the array is a short. Parameters: fArray  The feature referencing the array to return. fArray must be valid. fArray must be appropriate for this feature strucutre. fArray must be subsumed by type array. Exceptions: InvalidFSObjectException  InvalidFSFeatureObjectException  FeatureNotAppropriateException  FSIsNotArrayException

LongArrayFS uima::FeatureStructure::getLongArrayFSValue (  Feature const &  fArray  )  const [inherited]

Return feature structure of type array stored at feature fArray. The return value is guaranteed to be a properly terminated array. Each element in the array is a lomg (INT64). Parameters: fArray  The feature referencing the array to return. fArray must be valid. fArray must be appropriate for this feature strucutre. fArray must be subsumed by type array. Exceptions: InvalidFSObjectException  InvalidFSFeatureObjectException  FeatureNotAppropriateException  FSIsNotArrayException

DoubleArrayFS uima::FeatureStructure::getDoubleArrayFSValue (  Feature const &  fArray  )  const [inherited]

Return feature structure of type array stored at feature fArray. The return value is guaranteed to be a properly terminated array. Each element in the array is a double (INT64). Parameters: fArray  The feature referencing the array to return. fArray must be valid. fArray must be appropriate for this feature strucutre. fArray must be subsumed by type array. Exceptions: InvalidFSObjectException  InvalidFSFeatureObjectException  FeatureNotAppropriateException  FSIsNotArrayException

bool uima::FeatureStructure::operator== (  FeatureStructure const &   )  const [inherited]

bool uima::FeatureStructure::operator!= (  FeatureStructure const &  crFS  )  const [inline, inherited]

bool uima::FeatureStructure::operator< (  FeatureStructure const &  crFS  )  const [inherited]

---

Member Data Documentation

lowlevel::TyFS uima::FeatureStructure::iv_tyFS [protected, inherited]

CAS* uima::FeatureStructure::iv_cas [protected, inherited]

---

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

• cas.hpp

---