---

             

---

uima::FSIndexKeyDescription Class Reference

Inherits uima::MetaDataObject.

List of all members.

---

Detailed Description

Contains the description of an index key, i.e.

the feature name and the comparator that should be used when comparing the feature

Public Types
enum	EnComparatorType { STANDARD, REVERSE }
Public Member Functions
	FSIndexKeyDescription ()
TyErrorId	setFeatureName (const icu::UnicodeString &feature)
const icu::UnicodeString &	getFeatureName () const
TyErrorId	setComparator (EnComparatorType comp)
EnComparatorType	getComparator () const
TyErrorId	setIsTypePriority ()
bool	isTypePriority () const
bool	isModifiable () const
virtual 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#.
Protected Attributes
bool	iv_bIsModifiable

---

Member Enumeration Documentation

enum uima::FSIndexKeyDescription::EnComparatorType

Enumeration values: STANDARD  REVERSE

---

Constructor & Destructor Documentation

uima::FSIndexKeyDescription::FSIndexKeyDescription (   )  [inline]

---

Member Function Documentation

TyErrorId uima::FSIndexKeyDescription::setFeatureName (  const icu::UnicodeString &  feature  )  [inline]

const icu::UnicodeString& uima::FSIndexKeyDescription::getFeatureName (   )  const [inline]

TyErrorId uima::FSIndexKeyDescription::setComparator (  EnComparatorType  comp  )  [inline]

EnComparatorType uima::FSIndexKeyDescription::getComparator (   )  const [inline]

TyErrorId uima::FSIndexKeyDescription::setIsTypePriority (   )  [inline]

bool uima::FSIndexKeyDescription::isTypePriority (   )  const [inline]

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

virtual void uima::MetaDataObject::commit (   )  [inline, virtual, inherited]

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 in uima::NameValuePair, uima::ConfigurationGroup, uima::SettingsForGroup, uima::FSIndexDescription, uima::AnalysisEngineMetaData, uima::AnalysisEngineDescription, uima::TypeDescription, and uima::TypeSystemDescription.

---

Member Data Documentation

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

---

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

• taespecifier.hpp

---