---

             

---

uima::FlowConstraints Class Reference

Inherits uima::MetaDataObject.

Inherited by uima::CapabilityLanguageFlow, and uima::FixedFlow.

List of all members.

---

Detailed Description

Specifies the order in which Annotators are invoked.

The sequence is given by the order in which addNode was called.

Public Types
enum	EnFlowType { FIXED, CAPABILITYLANGUAGE }
Public Member Functions
virtual EnFlowType const &	getFlowConstraintsType ()=0
	node must uniquely identify an annotator.
virtual std::vector< icu::UnicodeString > const &	getNodes () const =0
virtual TyErrorId	addNode (const icu::UnicodeString &node)=0
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

enum uima::FlowConstraints::EnFlowType

Enumeration values: FIXED  CAPABILITYLANGUAGE

---

Member Function Documentation

virtual EnFlowType const& uima::FlowConstraints::getFlowConstraintsType (   )  [pure virtual]

node must uniquely identify an annotator. Implemented in uima::FixedFlow, and uima::CapabilityLanguageFlow.

virtual std::vector< icu::UnicodeString > const& uima::FlowConstraints::getNodes (   )  const [pure virtual]

Implemented in uima::FixedFlow, and uima::CapabilityLanguageFlow.

virtual TyErrorId uima::FlowConstraints::addNode (  const icu::UnicodeString &  node  )  [pure virtual]

Implemented in uima::FixedFlow, and uima::CapabilityLanguageFlow.

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:

• taespecifier.hpp

---