getDescription
returns a textual description of the feature.
Public Member Functions | |
FeatureDescription () | |
FeatureDescription (const FeatureDescription &crOther) | |
TyErrorId | setName (const icu::UnicodeString &featName) |
const icu::UnicodeString & | getName () const |
TyErrorId | setRangeTypeName (const icu::UnicodeString &rangeName) |
const icu::UnicodeString & | getRangeTypeName () const |
TyErrorId | setElementType (const icu::UnicodeString &elementName) |
const icu::UnicodeString & | getElementType () const |
TyErrorId | setDescription (const icu::UnicodeString &desc) |
const icu::UnicodeString & | getDescription () const |
TyErrorId | setMultipleReferencesAllowed (bool allowed) |
const bool | isMultipleReferencesAllowed () 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::FeatureDescription::FeatureDescription | ( | ) | [inline] |
uima::FeatureDescription::FeatureDescription | ( | const FeatureDescription & | crOther | ) | [inline] |
References getDescription(), getElementType(), getName(), getRangeTypeName(), and isMultipleReferencesAllowed().
TyErrorId uima::FeatureDescription::setName | ( | const icu::UnicodeString & | featName | ) | [inline] |
References UIMA_ERR_CONFIG_OBJECT_COMITTED, and UIMA_ERR_NONE.
const icu::UnicodeString& uima::FeatureDescription::getName | ( | void | ) | const [inline] |
Referenced by FeatureDescription().
TyErrorId uima::FeatureDescription::setRangeTypeName | ( | const icu::UnicodeString & | rangeName | ) | [inline] |
References UIMA_ERR_CONFIG_OBJECT_COMITTED, and UIMA_ERR_NONE.
const icu::UnicodeString& uima::FeatureDescription::getRangeTypeName | ( | ) | const [inline] |
Referenced by FeatureDescription().
TyErrorId uima::FeatureDescription::setElementType | ( | const icu::UnicodeString & | elementName | ) | [inline] |
References UIMA_ERR_CONFIG_OBJECT_COMITTED, and UIMA_ERR_NONE.
const icu::UnicodeString& uima::FeatureDescription::getElementType | ( | ) | const [inline] |
Referenced by FeatureDescription().
TyErrorId uima::FeatureDescription::setDescription | ( | const icu::UnicodeString & | desc | ) | [inline] |
References UIMA_ERR_CONFIG_OBJECT_COMITTED, and UIMA_ERR_NONE.
const icu::UnicodeString& uima::FeatureDescription::getDescription | ( | ) | const [inline] |
Referenced by FeatureDescription().
TyErrorId uima::FeatureDescription::setMultipleReferencesAllowed | ( | bool | allowed | ) | [inline] |
References UIMA_ERR_CONFIG_OBJECT_COMITTED, and UIMA_ERR_NONE.
const bool uima::FeatureDescription::isMultipleReferencesAllowed | ( | ) | const [inline] |
Referenced by FeatureDescription().
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] |