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

uima::ConfigurationGroup Class Reference

Inherits uima::MetaDataObject.

List of all members.


Detailed Description

Contains allConfigurationParameterobjects for a certain configuration group.

Public Member Functions

 ConfigurationGroup ()
 ~ConfigurationGroup ()
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#.
TyErrorId addConfigurationParameter (ConfigurationParameter *param)
 Note: This object will assume memory ownership ofparamand will delete it in its destructor !
bool hasConfigurationParameter (const icu::UnicodeString &paramName) const
 returns TRUE iff a configuration parameterparamNameexists in this group.
const ConfigurationParametergetConfigurationParameter (const icu::UnicodeString &paramName) const
 returns the ConfigurationParameter with name paramName or NULL if no such parameter is found.
const std::vector< const
ConfigurationParameter * > 
getConfigurationParameters () const
bool isModifiable () const

Protected Attributes

bool iv_bIsModifiable

Constructor & Destructor Documentation

uima::ConfigurationGroup::ConfigurationGroup (  )  [inline]

uima::ConfigurationGroup::~ConfigurationGroup (  ) 


Member Function Documentation

void uima::ConfigurationGroup::commit (  )  [inline, virtual]

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 from uima::MetaDataObject.

TyErrorId uima::ConfigurationGroup::addConfigurationParameter ( ConfigurationParameter param  )  [inline]

Note: This object will assume memory ownership ofparamand will delete it in its destructor !

References uima::ConfigurationParameter::getName(), UIMA_ERR_CONFIG_OBJECT_COMITTED, and UIMA_ERR_NONE.

bool uima::ConfigurationGroup::hasConfigurationParameter ( const icu::UnicodeString &  paramName  )  const [inline]

returns TRUE iff a configuration parameterparamNameexists in this group.

const ConfigurationParameter* uima::ConfigurationGroup::getConfigurationParameter ( const icu::UnicodeString &  paramName  )  const [inline]

returns the ConfigurationParameter with name paramName or NULL if no such parameter is found.

const std::vector<const ConfigurationParameter *> uima::ConfigurationGroup::getConfigurationParameters (  )  const

bool uima::MetaDataObject::isModifiable (  )  const [inline, inherited]


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