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

uima::FSIndexDescription Class Reference

Inherits uima::MetaDataObject.

List of all members.


Detailed Description

Defines an index for a specific type.

Is identified by its unique label. Contains a vector of index keys that define the features of the type that should be used in the index

See also:
FSIndexKeyDescription

Public Types

enum  EnIndexKind { SORTED, BAG, SET }
typedef std::vector
< FSIndexKeyDescription * > 
TyVecpFSIndexKeys

Public Member Functions

 FSIndexDescription ()
 ~FSIndexDescription ()
TyErrorId setLabel (const icu::UnicodeString &name)
const icu::UnicodeString & getLabel () const
TyErrorId setTypeName (const icu::UnicodeString &name)
const icu::UnicodeString & getTypeName () const
TyErrorId setIndexKind (EnIndexKind kind)
EnIndexKind getIndexKind () const
TyErrorId addFSIndexKey (FSIndexKeyDescription *desc)
 NOTE: This object will assume memory ownership of desc, i.e.
const TyVecpFSIndexKeysgetFSIndexKeys () const
void commit ()
 When this method is called on a MetaDataObject# that must not be reconfigured after the engine is created, isModifiable()# will return false and all subsequent calls to setter methods will return UIMA_ERR_CONFIG_OBJECT_COMMITED#.
bool isModifiable () const

Protected Attributes

bool iv_bIsModifiable

Member Typedef Documentation


Member Enumeration Documentation

Enumerator:
SORTED 
BAG 
SET 


Constructor & Destructor Documentation

uima::FSIndexDescription::FSIndexDescription (  )  [inline]

uima::FSIndexDescription::~FSIndexDescription (  )  [inline]


Member Function Documentation

TyErrorId uima::FSIndexDescription::setLabel ( const icu::UnicodeString &  name  )  [inline]

const icu::UnicodeString& uima::FSIndexDescription::getLabel (  )  const [inline]

TyErrorId uima::FSIndexDescription::setTypeName ( const icu::UnicodeString &  name  )  [inline]

const icu::UnicodeString& uima::FSIndexDescription::getTypeName (  )  const [inline]

TyErrorId uima::FSIndexDescription::setIndexKind ( EnIndexKind  kind  )  [inline]

EnIndexKind uima::FSIndexDescription::getIndexKind (  )  const [inline]

TyErrorId uima::FSIndexDescription::addFSIndexKey ( FSIndexKeyDescription desc  )  [inline]

NOTE: This object will assume memory ownership of desc, i.e.

it will delete it when destroyed!

References UIMA_ERR_CONFIG_OBJECT_COMITTED, and UIMA_ERR_NONE.

const TyVecpFSIndexKeys& uima::FSIndexDescription::getFSIndexKeys (  )  const [inline]

void uima::FSIndexDescription::commit (  )  [inline, virtual]

When this method is called on a MetaDataObject# that must not be reconfigured after the engine is created, isModifiable()# will return false and all subsequent calls to setter methods will return UIMA_ERR_CONFIG_OBJECT_COMMITED#.

Subclasses of such MetaDataObjects must override this method to ensure that commit is propagated to its members. Note that configuration parameter values can be reconfigured after the engine is created. Hence, the extractValue# methods of the AnnotatorContext# can be called anytime.

Reimplemented from uima::MetaDataObject.

bool uima::MetaDataObject::isModifiable (  )  const [inline, inherited]


Member Data Documentation

bool uima::MetaDataObject::iv_bIsModifiable [protected, inherited]


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

Generated on Mon Oct 1 11:15:08 2012 for UIMACPP API by  doxygen 1.5.6