This interface provides methods to set the attributes that define a mapping.
Sofa Name mapping is required to connect the output Sofas from one component to the input Sofa of another component. This mapping enables the uima::UimaConext.mapToSofaID() method to return the SofaID that serves as the handle to a particular Sofa in the CAS.
If the component Sofa Name is not set, it defaults to the Sofa Name of the Default Text Sofa. If no mapping is provided, a Sofa Name maps to itself.
Public Member Functions | |
SofaMapping () | |
Constructor. | |
TyErrorId | setComponentKey (const icu::UnicodeString &componentKey) |
Set the name of the component to which this mapping applies. | |
const icu::UnicodeString & | getComponentKey () const |
Get the name of the component to which this mapping applies. | |
TyErrorId | setComponentSofaName (const icu::UnicodeString &componentSofaName) |
Set the Sofa name as known to the component. | |
const icu::UnicodeString & | getComponentSofaName () const |
Get the Sofa name as known to the component. | |
TyErrorId | setAggregateSofaName (const icu::UnicodeString &aggregateSofaName) |
set the Sofa name assigned by the aggregate. | |
const icu::UnicodeString & | getAggregateSofaName () const |
Get the Sofa name assigned by the aggregate. | |
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 |
uima::SofaMapping::SofaMapping | ( | ) | [inline] |
Constructor.
TyErrorId uima::SofaMapping::setComponentKey | ( | const icu::UnicodeString & | componentKey | ) | [inline] |
Set the name of the component to which this mapping applies.
References UIMA_ERR_CONFIG_OBJECT_COMITTED, and UIMA_ERR_NONE.
const icu::UnicodeString& uima::SofaMapping::getComponentKey | ( | ) | const [inline] |
Get the name of the component to which this mapping applies.
TyErrorId uima::SofaMapping::setComponentSofaName | ( | const icu::UnicodeString & | componentSofaName | ) | [inline] |
Set the Sofa name as known to the component.
References UIMA_ERR_CONFIG_OBJECT_COMITTED, and UIMA_ERR_NONE.
const icu::UnicodeString& uima::SofaMapping::getComponentSofaName | ( | ) | const [inline] |
Get the Sofa name as known to the component.
TyErrorId uima::SofaMapping::setAggregateSofaName | ( | const icu::UnicodeString & | aggregateSofaName | ) | [inline] |
set the Sofa name assigned by the aggregate.
References UIMA_ERR_CONFIG_OBJECT_COMITTED, and UIMA_ERR_NONE.
const icu::UnicodeString& uima::SofaMapping::getAggregateSofaName | ( | ) | const [inline] |
Get the Sofa name assigned by the aggregate.
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.
bool uima::MetaDataObject::iv_bIsModifiable [protected, inherited] |