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 |
uima::FSIndexKeyDescription::FSIndexKeyDescription | ( | ) | [inline] |
TyErrorId uima::FSIndexKeyDescription::setFeatureName | ( | const icu::UnicodeString & | feature | ) | [inline] |
References UIMA_ERR_CONFIG_OBJECT_COMITTED, and UIMA_ERR_NONE.
const icu::UnicodeString& uima::FSIndexKeyDescription::getFeatureName | ( | ) | const [inline] |
TyErrorId uima::FSIndexKeyDescription::setComparator | ( | EnComparatorType | comp | ) | [inline] |
References UIMA_ERR_CONFIG_OBJECT_COMITTED, and UIMA_ERR_NONE.
EnComparatorType uima::FSIndexKeyDescription::getComparator | ( | ) | const [inline] |
TyErrorId uima::FSIndexKeyDescription::setIsTypePriority | ( | ) | [inline] |
References UIMA_ERR_CONFIG_OBJECT_COMITTED, and UIMA_ERR_NONE.
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.
bool uima::MetaDataObject::iv_bIsModifiable [protected, inherited] |