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

uima::DocumentFS Class Reference

Inherits uima::AnnotationFS.

List of all members.

Detailed Description

Class DocumentFS derives from AnnotationFS and extends with convenience functions specific for the single feature structures of type Document-Annotation that is present for each input document.

The most important additional functions deal with access to the features document language and the document text. To get an easy access to this annotation just call the function CAS::getDocumentAnnotation()


Public Types

typedef lowlevel::TyHeapCell TyArrayElement

Public Member Functions

 DocumentFS ()
 Default constructor.
 DocumentFS (FeatureStructure const &fs)
 Promote a generic FeatureStructure object to an DocumentFS.
Language getLanguage () const
 Returns the language of the current document.
void setLanguage (Language const &)
 Set the language of the current document.
CAS & getCAS ()
 Returns the CAS object in which this feature structure lives.
CAS const & getCAS () const
CAS * getView ()
 Gets the CAS view associated with the Sofa that this Annotation is over.
size_t getBeginPosition (void) const
 Get the start position of this annotation feature structure.
size_t getEndPosition (void) const
 Get the end position of this annotation feature structure.
size_t getLength (void) const
 Get the number of characters covered by this annotation feature structure.
UnicodeStringRef getCoveredText (void) const
 Get a reference to the text spanned by this annotation feature structure.
AnnotationFS getFirstCoveringAnnotation (Type ofType) const
 Get the first annotation A that covers this annotation, i.e.
ANIterator subIterator (Type const &crType, EnIteratorAmbiguity enAmbiguous=enAmbiguous) const
 create an iterator over an index of annoations of type crType only returning Annotations with begin position >= this.getBeginPosition() and begin positon < this.getEndPosition()
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 lowlevel::TyHeapCell uima::FeatureStructure::TyArrayElement [inherited]
 

Constructor & Destructor Documentation

uima::DocumentFS::DocumentFS (   )  [inline]
 

Default constructor.

Creates an invalid DocumentFS.

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

Promote a generic FeatureStructure object to an DocumentFS.

fs must be of document annotation. If fs is not of document annotation the operation will not immediately fail but access to member functions of AnnotationFS will result in exceptions beeing thrown.

Member Function Documentation

Language uima::DocumentFS::getLanguage (   )  const
 

Returns the language of the current document.

The return value may be invalid (!Language.isValid()) if this function is called when no valid document is present. The return value may be unspecified (== CosEnLanguage_Unspecified) If no language was specified for the document and no language detection annotator has run.

void uima::DocumentFS::setLanguage (  Language const &   ) 
 

Set the language of the current document.

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

Returns the CAS object in which this feature structure lives.

This just saves a cast over the methode CAS::getCAS() inherited from uima::CAS

Reimplemented from uima::FeatureStructure.

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

Reimplemented from uima::FeatureStructure.

CAS* uima::AnnotationFS::getView (   )  [inherited]
 

Gets the CAS view associated with the Sofa that this Annotation is over.

Returns:
the CAS view associated with the Annotation's Sofa

size_t uima::AnnotationFS::getBeginPosition (  void   )  const [inherited]
 

Get the start position of this annotation feature structure.

size_t uima::AnnotationFS::getEndPosition (  void   )  const [inherited]
 

Get the end position of this annotation feature structure.

size_t uima::AnnotationFS::getLength (  void   )  const [inline, inherited]
 

Get the number of characters covered by this annotation feature structure.

This is just a shortcut for getEndPosition()-getBeginPosition()

UnicodeStringRef uima::AnnotationFS::getCoveredText (  void   )  const [inherited]
 

Get a reference to the text spanned by this annotation feature structure.

Exceptions:
CASException if FS is not a valid annotation.

AnnotationFS uima::AnnotationFS::getFirstCoveringAnnotation (  Type  ofType  )  const [inherited]
 

Get the first annotation A that covers this annotation, i.e.

that has a begin position(A) <= begin position(this) and an end position(A) >= end position(this).

Note that the covering relation here is reflexive: getFirstCoveringAnnotation(x, t) == x if t is the type of x

If several annotations fulfill these conditions, the one with the starting position nearest begin position relative to this annotation is returned. Of covering annotations with the same starting positions, the one with the biggest end position relative to to this annotation is chosen.

Returns:
The next covering features structure as defined above (!isValid() if none found)

ANIterator uima::AnnotationFS::subIterator (  Type const &  crType,
EnIteratorAmbiguity  enAmbiguous = enAmbiguous
)  const [inherited]
 

create an iterator over an index of annoations of type crType only returning Annotations with begin position >= this.getBeginPosition() and begin positon < this.getEndPosition()

Parameters:
crType The type of annotation over which to iterate. crType must be subsumed by type annotation.
enAmbiguous If set to CAS::enAmbiguous calling moveToNext/moveToPrevious will alway move the resulting interator to an annotation that is no longer covered by the current annotation. This means that: moveToNext will always return an annotation with a begin position > than the current end position. moveToPrevious will always return an annotation with a end position < than the current begin position. In a situation like this:
|--------- Name1 ------||-------- Name2 -------|
|-- Tok1 --||-- Tok2 --||-- Tok3 --||-- Tok4 --|
A normal iterator starting out with Name1 would return: Name1, Tok1, Tok2, Name2, Tok3, Tok4 A unambibous iterator starting out with Name1 would return: Name1, Name2 (This assumes that the types Name and Tok are subsumed by crType and no other subusumed annotations cover the area.)
Exceptions:
InvalidIndexObjectException 

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]
 

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