---

             

---

uima::FeatureDescription Class Reference

Inherits uima::MetaDataObject.

List of all members.

---

Detailed Description

Defines a feature by its name and the range type that its values can assume.

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

---

Constructor & Destructor Documentation

uima::FeatureDescription::FeatureDescription (   )  [inline]

uima::FeatureDescription::FeatureDescription (  const FeatureDescription &  crOther  )  [inline]

---

Member Function Documentation

TyErrorId uima::FeatureDescription::setName (  const icu::UnicodeString &  featName  )  [inline]

const icu::UnicodeString& uima::FeatureDescription::getName (  void   )  const [inline]

TyErrorId uima::FeatureDescription::setRangeTypeName (  const icu::UnicodeString &  rangeName  )  [inline]

const icu::UnicodeString& uima::FeatureDescription::getRangeTypeName (   )  const [inline]

TyErrorId uima::FeatureDescription::setElementType (  const icu::UnicodeString &  elementName  )  [inline]

const icu::UnicodeString& uima::FeatureDescription::getElementType (   )  const [inline]

TyErrorId uima::FeatureDescription::setDescription (  const icu::UnicodeString &  desc  )  [inline]

const icu::UnicodeString& uima::FeatureDescription::getDescription (   )  const [inline]

TyErrorId uima::FeatureDescription::setMultipleReferencesAllowed (  bool  allowed  )  [inline]

const bool uima::FeatureDescription::isMultipleReferencesAllowed (   )  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:

• typesystemdescription.hpp

---