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

uima::Capability Class Reference

Inherits uima::MetaDataObject.

List of all members.


Detailed Description

Defines the capability of a TextAnalysisEngine in terms of the required input and output types and features and the supported languages.

A TextAnalysisEngine can be described by more than one Capability, for example, if the input and output types/features differ, depending on the language. The Capability is expressed in terms of input and output type, feature and Sofa names.

Public Types

enum  EnTypeStyle { INPUT, OUTPUT, INPUTSOFA, OUTPUTSOFA }
typedef std::vector
< icu::UnicodeString > 
TyVecCapabilityTofs
typedef std::vector
< icu::UnicodeString > 
TyVecCapabilityLanguages
typedef std::vector
< icu::UnicodeString > 
TyVecCapabilitySofas

Public Member Functions

 Capability ()
TyErrorId addCapabilityType (const icu::UnicodeString &type, EnTypeStyle typeStyle)
TyErrorId addCapabilityFeature (const icu::UnicodeString &feature, EnTypeStyle typeStyle)
TyErrorId addCapabilitySofa (const icu::UnicodeString &sofa, EnTypeStyle typeStyle)
 Set the input or output Sofa name.
const TyVecCapabilityTofsgetCapabilityTypes (EnTypeStyle typeStyle) const
 Get input/output Types.
const TyVecCapabilityTofsgetCapabilityFeatures (EnTypeStyle typeStyle) const
 Get the input/output features.
const TyVecCapabilitySofasgetCapabilitySofas (EnTypeStyle typeStyle) const
 Get the input/output Sofas.
TyErrorId addSupportedLanguage (const icu::UnicodeString &language)
const TyVecCapabilityLanguagesgetSupportedLanguages () 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 Typedef Documentation

typedef std::vector<icu::UnicodeString > uima::Capability::TyVecCapabilityTofs

typedef std::vector<icu::UnicodeString > uima::Capability::TyVecCapabilityLanguages

typedef std::vector<icu::UnicodeString > uima::Capability::TyVecCapabilitySofas


Member Enumeration Documentation

Enumerator:
INPUT 
OUTPUT 
INPUTSOFA 
OUTPUTSOFA 


Constructor & Destructor Documentation

uima::Capability::Capability (  )  [inline]


Member Function Documentation

TyErrorId uima::Capability::addCapabilityType ( const icu::UnicodeString &  type,
EnTypeStyle  typeStyle 
) [inline]

Parameters:
type The name of the type to be added
typeStyle Determines whether it's an input or output type

References UIMA_ERR_CONFIG_OBJECT_COMITTED, and UIMA_ERR_NONE.

TyErrorId uima::Capability::addCapabilityFeature ( const icu::UnicodeString &  feature,
EnTypeStyle  typeStyle 
) [inline]

Parameters:
feature The name of the feature to be added
typeStyle Determines whether it's an input or output feature

References UIMA_ERR_CONFIG_OBJECT_COMITTED, and UIMA_ERR_NONE.

TyErrorId uima::Capability::addCapabilitySofa ( const icu::UnicodeString &  sofa,
EnTypeStyle  typeStyle 
) [inline]

Set the input or output Sofa name.

Parameters:
sofa The name of the sofa to be added
typeStyle Determines whether it's an input or output sofa

References UIMA_ERR_CONFIG_OBJECT_COMITTED, and UIMA_ERR_NONE.

const TyVecCapabilityTofs& uima::Capability::getCapabilityTypes ( EnTypeStyle  typeStyle  )  const [inline]

Get input/output Types.

const TyVecCapabilityTofs& uima::Capability::getCapabilityFeatures ( EnTypeStyle  typeStyle  )  const [inline]

Get the input/output features.

const TyVecCapabilitySofas& uima::Capability::getCapabilitySofas ( EnTypeStyle  typeStyle  )  const [inline]

Get the input/output Sofas.

TyErrorId uima::Capability::addSupportedLanguage ( const icu::UnicodeString &  language  )  [inline]

const TyVecCapabilityLanguages& uima::Capability::getSupportedLanguages (  )  const [inline]

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