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

uima::MetaDataObject Class Reference

Inherited by uima::AllowedValue, uima::AnalysisEngineDescription, uima::AnalysisEngineMetaData, uima::Capability, uima::ConfigurationGroup, uima::ConfigurationParameter, uima::FeatureDescription, uima::FlowConstraints, uima::FSIndexDescription, uima::FSIndexKeyDescription, uima::ImportDescription, uima::NameValuePair, uima::OperationalProperties, uima::SettingsForGroup, uima::SofaMapping, uima::TypeDescription, uima::TypePriority, and uima::TypeSystemDescription.

List of all members.


Detailed Description

The base class of all configuration objects.

Public Member Functions

 MetaDataObject ()
virtual ~MetaDataObject ()
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::MetaDataObject::MetaDataObject (  )  [inline]

virtual uima::MetaDataObject::~MetaDataObject (  )  [inline, virtual]


Member Function Documentation

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

virtual void uima::MetaDataObject::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 in uima::NameValuePair, uima::ConfigurationGroup, uima::SettingsForGroup, uima::FSIndexDescription, uima::AnalysisEngineMetaData, uima::AnalysisEngineDescription, uima::TypeDescription, and uima::TypeSystemDescription.


Member Data Documentation


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