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

uima::AllowedValue Class Reference

Inherits uima::MetaDataObject.

List of all members.


Detailed Description

If a type can only contain an enumeration of values, there is an AllowedValue object for each value.

The value itself is returned by getName, getDescription returns a description of the value.

Public Member Functions

 AllowedValue ()
 AllowedValue (const AllowedValue &crOther)
TyErrorId setName (const icu::UnicodeString &name)
TyErrorId setDescription (const icu::UnicodeString &description)
const icu::UnicodeString & getName () const
const icu::UnicodeString & getDescription () 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::AllowedValue::AllowedValue (  )  [inline]

uima::AllowedValue::AllowedValue ( const AllowedValue crOther  )  [inline]

References getDescription(), and getName().


Member Function Documentation

TyErrorId uima::AllowedValue::setName ( const icu::UnicodeString &  name  )  [inline]

TyErrorId uima::AllowedValue::setDescription ( const icu::UnicodeString &  description  )  [inline]

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

Referenced by AllowedValue().

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

Referenced by AllowedValue().

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:

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