---

             

---

uima::FeatureStructure Class Reference

Inherited by uima::AnnotationFS, uima::BasicArrayFS, uima::BasicListFS, and uima::SofaFS.

List of all members.

---

Detailed Description

Our feature structure.

All methods may throw an InvalidFSObjectException if the feature structure object is not valid.

Public Types
typedef lowlevel::TyHeapCell	TyArrayElement
Public Member Functions
	FeatureStructure ()
	Default constructor: Creates an invalid 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
Protected Member Functions
	FeatureStructure (lowlevel::TyFS anFS, uima::CAS &)
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

---

Constructor & Destructor Documentation

uima::FeatureStructure::FeatureStructure (  lowlevel::TyFS  anFS, uima::CAS &  )  [protected]

uima::FeatureStructure::FeatureStructure (   )

Default constructor: Creates an invalid FS.

---

Member Function Documentation

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

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

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

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

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

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

CAS& uima::FeatureStructure::getCAS (   )

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

CAS const& uima::FeatureStructure::getCAS (   )  const

Reimplemented in uima::AnnotationFS.

bool uima::FeatureStructure::isValid (   )  const

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

Type uima::FeatureStructure::getType (   )  const

Returns: the type of this FS. Exceptions: InvalidFSObjectException

FeatureStructure uima::FeatureStructure::clone (   )

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  )

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

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

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

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 )

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 )

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

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

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

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

float uima::FeatureStructure::getFloatValue (  Feature const &  crFeature  )  const

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

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

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

UnicodeStringRef uima::FeatureStructure::getStringValue (  Feature const &  crFeature  )  const

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

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

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]

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

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

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]

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

ArrayFS uima::FeatureStructure::getArrayFSValue (  Feature const &  fArray  )  const

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

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

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

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

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

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

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

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

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

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

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

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

char uima::FeatureStructure::getByteValue (  Feature const &  crFeature  )  const

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

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

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

short uima::FeatureStructure::getShortValue (  Feature const &  crFeature  )  const

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

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

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

INT64 uima::FeatureStructure::getLongValue (  Feature const &  crFeature  )  const

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

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

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

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

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

double uima::FeatureStructure::getDoubleValue (  Feature const &  crFeature  )  const

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

BooleanArrayFS uima::FeatureStructure::getBooleanArrayFSValue (  Feature const &  fArray  )  const

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

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

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

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

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

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

bool uima::FeatureStructure::operator< (  FeatureStructure const &  crFS  )  const

---

Member Data Documentation

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

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

---

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

• featurestructure.hpp

---