Overview   Class List   Class Hierarchy   Class Members   Functions & Constants   Defines   Header Files  

uima::BasicListFS Class Reference

Inherits uima::FeatureStructure.

Inherited by uima::FloatListFS, uima::IntListFS, uima::ListFS, and uima::StringListFS.

List of all members.

Detailed Description

A on object representing a list of elements from the CAS.

(e.g. they are of type empty list or of type non-empty list). An element can be either a FeatureStructure or a float or an int or a string. For each such element type there is a sub-class of BasicListFS implementing this template interface with type specific methods. ListFS, IntListFS, FloatListFS, StringListFS.

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

Creating a list can be done like this: 

     // store elements of a vector of strings in a list feature
     FeatureStructure fsNewString;           // re-used for each new string
     StringListFS fsNewList = tcas.createListFS(); // create an empty list
     // build up a fs list from our vector
     for (size_t i = 0; i < vecStrings.size(); ++i) {
        // create a string feature structure
        fsNewList.addLast(vecStrings[i]);
     }
     // now that the list is complete, set the feature value to the list
     fsWithListFeature.setFSValue(fListFeature, fsNewList);
Accessing a list can be done like this: 
     // check if we need to touch our element
     if (fsWithListFeature.hasListElements(fListFeature) ) {
        // get list
        StringListFS fsList = fsWithListFeature.getStringListFSValue(fListFeature);
        // iterate list
        while (!fsList.isEmpty()) {
           cout << fsList.getHead() << " "; // print the string
           fsList.moveToNext();
        }
     }

The example uses StringListFS to show the usage of the interfaces with strings. Usage of FeatureStructure, int or float values is analogous.

See also:
ListFS

IntListFS

FloatListFS

StringListFS


Public Types

typedef T HeadType
 internal
typedef lowlevel::TyHeapCell TyArrayElement

Public Member Functions

 BasicListFS ()
 Default CTOR: Creates an invalid BasicListFS (use CAS::createListFS() instead).
 BasicListFS (FeatureStructure const &fs)
 Upgrade/Conversion CTOR: Creates an BasicListFS from an existing FeatureStructure.
bool isEmpty () const
 Return true if this element is not valid or of type empty list.
T getHead () const
 Get the value of the head feature of this list element.
void setHead (T const &fs)
 Set the value of the head feature of this list element.
BasicListFS getTail () const
 Get the value of the tail feature of this list element.
void setTail (BasicListFS fs)
 Set the value of the tail feature of this list element.
size_t getLength () const
 Get the length of this list.
BasicListFS addFirst (T const &fs)
 Adds the value fs to the begin of this list.
BasicListFS addLast (T const &fs)
 Adds the value fs to the end of this list.
BasicListFS append (BasicListFS l)
 Appends the list l to the end of this list.
BasicListFS prepend (BasicListFS l)
 Appends the list l to the begin of this list.
void moveToNext ()
 Advance this list element to the next element in the list.
BasicListFS removeElement (T const &element)
 Removes the first occurrence of element from this list.
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

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 T uima::BasicListFS::HeadType
 

internal

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

Constructor & Destructor Documentation

uima::BasicListFS::BasicListFS (   ) 
 

Default CTOR: Creates an invalid BasicListFS (use CAS::createListFS() instead).

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

Upgrade/Conversion CTOR: Creates an BasicListFS from an existing FeatureStructure.

fs must be of type List.

Exceptions:
FSIsNotListException 

Member Function Documentation

bool uima::BasicListFS::isEmpty (   )  const
 

Return true if this element is not valid or of type empty list.

Exceptions:
InvalidFSObjectException 

T uima::BasicListFS::getHead (   )  const
 

Get the value of the head feature of this list element.

Exceptions:
InvalidFSObjectException 
ListIsEmptyException 

void uima::BasicListFS::setHead (  T const &  fs  ) 
 

Set the value of the head feature of this list element.

Exceptions:
InvalidFSObjectException 
ListIsEmptyException 

BasicListFS uima::BasicListFS::getTail (   )  const
 

Get the value of the tail feature of this list element.

Exceptions:
InvalidFSObjectException 
ListIsEmptyException 

void uima::BasicListFS::setTail (  BasicListFS  fs  ) 
 

Set the value of the tail feature of this list element.

Exceptions:
InvalidFSObjectException 
ListIsEmptyException 

size_t uima::BasicListFS::getLength (   )  const
 

Get the length of this list.

Exceptions:
InvalidFSObjectException 

BasicListFS uima::BasicListFS::addFirst (  T const &  fs  ) 
 

Adds the value fs to the begin of this list.

addFirst takes constant time with the length of this list

Returns:
The list starting with the newly added element. (i.e. the first element of the full list)
Exceptions:
InvalidFSObjectException 

BasicListFS uima::BasicListFS::addLast (  T const &  fs  ) 
 

Adds the value fs to the end of this list.

addLast takes linear time with the length of this list

Returns:
The list starting with the newly added element (i.e. the last element of the full list)
Exceptions:
InvalidFSObjectException 

BasicListFS uima::BasicListFS::append (  BasicListFS  l  ) 
 

Appends the list l to the end of this list.

append takes linear time with the length of this list

Returns:
The new list.
Exceptions:
InvalidFSObjectException 

BasicListFS uima::BasicListFS::prepend (  BasicListFS  l  ) 
 

Appends the list l to the begin of this list.

prepend takes linear time with the length of list l

Returns:
The new list.
Exceptions:
InvalidFSObjectException 

void uima::BasicListFS::moveToNext (   ) 
 

Advance this list element to the next element in the list.

Equivalent to this = this.getTailFS(); Assumes that the list is not empty.

Exceptions:
InvalidFSObjectException 
ListIsEmptyException 

BasicListFS uima::BasicListFS::removeElement (  T const &  element  ) 
 

Removes the first occurrence of element from this list.

Returns:
The singleton list containing the removed element.
Exceptions:
InvalidFSObjectException 

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:
Generated on Mon Oct 1 16:04:13 2012 for UIMACPP API by  doxygen 1.3.9.1