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

uima::FixedFlow Class Reference

Inherits uima::FlowConstraints.

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

 FixedFlow ()
EnFlowType const & getFlowConstraintsType ()
 node must uniquely identify an annotator.
TyErrorId addNode (const icu::UnicodeString &node)
 node must uniquely identify an annotator.
std::vector< icu::UnicodeString
> const & 
getNodes () 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

enum uima::FlowConstraints::EnFlowType [inherited]
 

Enumeration values:
FIXED 
CAPABILITYLANGUAGE 


Constructor & Destructor Documentation

uima::FixedFlow::FixedFlow  )  [inline]
 


Member Function Documentation

EnFlowType const& uima::FixedFlow::getFlowConstraintsType  )  [inline, virtual]
 

node must uniquely identify an annotator.

Implements uima::FlowConstraints.

TyErrorId uima::FixedFlow::addNode const icu::UnicodeString &  node  )  [inline, virtual]
 

node must uniquely identify an annotator.

Implements uima::FlowConstraints.

std::vector< icu::UnicodeString > const& uima::FixedFlow::getNodes  )  const [inline, virtual]
 

Implements uima::FlowConstraints.

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 16:04:13 2012 for UIMACPP API by  doxygen 1.3.9.1