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

uima::ConfigurationParameter Class Reference

Inherits uima::MetaDataObject.

List of all members.


Detailed Description

Contains the definition of a configuration parameter, for example its name and its type.

Public Types

enum  EnParameterType { STRING, INTEGER, FLOAT, BOOLEAN }
enum  EnParameterAggregation { SINGLE_VALUE = false, MULTIPLE_VALUES = true }

Public Member Functions

 ConfigurationParameter ()
TyErrorId setName (const icu::UnicodeString &name)
const icu::UnicodeString & getName () const
TyErrorId setDescription (const icu::UnicodeString &description)
const icu::UnicodeString & getDescription () const
TyErrorId setType (EnParameterType enParamType)
EnParameterType getType () const
TyErrorId setMultiValued (EnParameterAggregation enMode)
bool isMultiValued () const
TyErrorId setMandatory (bool man)
bool isMandatory () const
TyErrorId addRestriction (const icu::UnicodeString &delegateName)
 Returns true iff settings for this configuration parameter will only be visible to certain delegate TAEs.
bool isDefinedForAnnotatorContext (const icu::UnicodeString &ancKey) 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

Enumerator:
STRING 
INTEGER 
FLOAT 
BOOLEAN 

Enumerator:
SINGLE_VALUE 
MULTIPLE_VALUES 


Constructor & Destructor Documentation

uima::ConfigurationParameter::ConfigurationParameter (  )  [inline]


Member Function Documentation

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

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

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

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

TyErrorId uima::ConfigurationParameter::setType ( EnParameterType  enParamType  )  [inline]

EnParameterType uima::ConfigurationParameter::getType (  )  const [inline]

TyErrorId uima::ConfigurationParameter::setMultiValued ( EnParameterAggregation  enMode  )  [inline]

bool uima::ConfigurationParameter::isMultiValued (  )  const [inline]

TyErrorId uima::ConfigurationParameter::setMandatory ( bool  man  )  [inline]

bool uima::ConfigurationParameter::isMandatory (  )  const [inline]

TyErrorId uima::ConfigurationParameter::addRestriction ( const icu::UnicodeString &  delegateName  )  [inline]

Returns true iff settings for this configuration parameter will only be visible to certain delegate TAEs.

Settings for this configuration parameter will only be visible for the delegate AnC delegateName

References UIMA_ERR_CONFIG_OBJECT_COMITTED, and UIMA_ERR_NONE.

bool uima::ConfigurationParameter::isDefinedForAnnotatorContext ( const icu::UnicodeString &  ancKey  )  const

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:08 2012 for UIMACPP API by  doxygen 1.5.6