---

             

---

uima::TextAnalysisEngineSpecifier Class Reference

Inherits uima::AnalysisEngineDescription.

List of all members.

Public Types
typedef std::map< icu::UnicodeString, AnalysisEngineDescription * >	TyMapDelegateSpecs
typedef std::vector< SofaMapping * >	TyVecpSofaMappings
enum	EnFrameworkImplName { CPLUSPLUS, JAVA }
Public Member Functions
	TextAnalysisEngineSpecifier ()
void	validate ()
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#.
TyErrorId	setAnalysisEngineMetaData (AnalysisEngineMetaData *metaData)
	NOTE: This object will assume memory ownership of metaData, i.e.
AnalysisEngineMetaData *	getAnalysisEngineMetaData ()
AnalysisEngineMetaData const *	getAnalysisEngineMetaData () const
AnalysisEngineMetaData::EnSearchStrategy	getSearchStrategy () const
	return the search strategy that is applied when looking for configuration parameter values
TyErrorId	setPrimitive (bool primitive)
bool	isPrimitive () const
EnFrameworkImplName	getFrameworkImplName () const
const icu::UnicodeString &	getAnnotatorImpName () const
	Returns a meaningful value only if isPrimitive() == true.
void	setXmlFileLocation (const icu::UnicodeString xmlLoc)
const icu::UnicodeString &	getXmlFileLocation () const
void	setXmlRootTag (const icu::UnicodeString xmlTag)
const icu::UnicodeString &	getXmlRootTag () const
TyErrorId	addDelegate (const icu::UnicodeString &key, AnalysisEngineDescription *taeSpec)
	NOTE: This object will assume memory ownership of taeSpec, i.e.
const TyMapDelegateSpecs &	getDelegates () const
	Note: This object will still assume memory ownership of the AnalysisEngineDescription that are returned.
const TyVecpSofaMappings &	getSofaMappings () const
	BSI Note: This object will still assume memory ownership of the returned SofAMapping objects that are returned.
TyErrorId	setSofaMappings (TyVecpSofaMappings *pSofaMappings)
	BSI NOTE: This object will assume memory ownership of pSofaMappings, i.e.
TyErrorId	addSofaMapping (SofaMapping *pSofaMapping)
	NOTE: This object will assume memory ownership of SofaMapping, i.e.
AnalysisEngineDescription *	getDelegate (const icu::UnicodeString &key) const
	Note: This object will still assume memory ownership of the AnalysisEngineDescription that is returned.
AnalysisEngineDescription *	extractDelegate (const icu::UnicodeString &key)
	Note: This object will delete the AnalysisEngineDescription returned from its map of delegate specifiers.
NameValuePair *	getNameValuePair (const icu::UnicodeString &paramName, const icu::UnicodeString &ancKey="")
	returns a reference to the NameValuePair whose name is paramName iff a) there are no configuration groups defined or there is a default group defined.
NameValuePair *	getNameValuePair (const icu::UnicodeString &groupName, const icu::UnicodeString &paramName, AnalysisEngineMetaData::EnSearchStrategy strategy, const icu::UnicodeString &ancKey="")
	returns a reference to the NameValuePair whose name is paramName iff a) there are configuration groups defined b) a NameValuePair with the name exists in the configuration settings of the 'appropriate' group.
TyErrorId	setNameValuePair (const NameValuePair &nvPair)
	TyErrorId == UIMA_ERR_NONE iff a) there are groups: the name of nvPair is a configuration parameter defined in the common parameters or in the default group b) there are no groups: the name of nvPair is a configuration parameter If above conditions hold true, nvPair will be added to a) the settings of the default group b) the configuration settings.
TyErrorId	setNameValuePair (const icu::UnicodeString &groupName, const NameValuePair &nvPair)
	TyErrorId == UIMA_ERR_NONE iff a) there is a group groupName in the configuration parameters b) the name of nvPair is a configuration parameter defined in groupName.
void	toXMLBuffer (icu::UnicodeString &) const
	converts this specifier to an XML buffer.
void	toXMLBuffer (AnalysisEngineMetaData const &md, bool isCasConsumer, icu::UnicodeString &s) const
void	appendConfigParamsAndSettingsToXMLBuffer (UnicodeString &s) const
TyErrorId	setFrameworkImplName (EnFrameworkImplName impl)
TyErrorId	setAnnotatorImpName (const icu::UnicodeString &anName)
bool	isModifiable () const
Protected Member Functions
void	appendToXMLBuffer (AnalysisEngineMetaData::TyVecpFSIndexDescriptions const &fsDesc, icu::UnicodeString &s)
void	appendToXMLBuffer (AnalysisEngineMetaData::TyVecpTypePriorities const &prioDesc, icu::UnicodeString &s)
void	appendToXMLBuffer (TyVecpSofaMappings const &sofaMapDesc, icu::UnicodeString &s)
Protected Attributes
bool	iv_bIsModifiable

---

Member Typedef Documentation

typedef std::map<icu::UnicodeString, AnalysisEngineDescription *> uima::AnalysisEngineDescription::TyMapDelegateSpecs [inherited]

typedef std::vector<SofaMapping *> uima::AnalysisEngineDescription::TyVecpSofaMappings [inherited]

---

Member Enumeration Documentation

enum uima::AnalysisEngineDescription::EnFrameworkImplName [inherited]

Enumeration values: CPLUSPLUS  JAVA

---

Constructor & Destructor Documentation

uima::TextAnalysisEngineSpecifier::TextAnalysisEngineSpecifier (   )  [inline]

---

Member Function Documentation

void uima::AnalysisEngineDescription::validate (   )  [inherited]

void uima::AnalysisEngineDescription::commit (   )  [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 from uima::MetaDataObject.

TyErrorId uima::AnalysisEngineDescription::setAnalysisEngineMetaData (  AnalysisEngineMetaData *  metaData  )  [inline, inherited]

NOTE: This object will assume memory ownership of metaData, i.e. it will be deleted when this object's destructor is called !

AnalysisEngineMetaData* uima::AnalysisEngineDescription::getAnalysisEngineMetaData (   )  [inline, inherited]

AnalysisEngineMetaData const* uima::AnalysisEngineDescription::getAnalysisEngineMetaData (   )  const [inline, inherited]

AnalysisEngineMetaData::EnSearchStrategy uima::AnalysisEngineDescription::getSearchStrategy (   )  const [inline, inherited]

return the search strategy that is applied when looking for configuration parameter values

TyErrorId uima::AnalysisEngineDescription::setPrimitive (  bool  primitive  )  [inline, inherited]

bool uima::AnalysisEngineDescription::isPrimitive (   )  const [inline, inherited]

EnFrameworkImplName uima::AnalysisEngineDescription::getFrameworkImplName (   )  const [inline, inherited]

const icu::UnicodeString& uima::AnalysisEngineDescription::getAnnotatorImpName (   )  const [inline, inherited]

Returns a meaningful value only if isPrimitive() == true.

void uima::AnalysisEngineDescription::setXmlFileLocation (  const icu::UnicodeString  xmlLoc  )  [inline, inherited]

const icu::UnicodeString& uima::AnalysisEngineDescription::getXmlFileLocation (   )  const [inline, inherited]

Returns: The full path name of the XML file used to build up this AnalysisEngineDescription. If it was built from a memory buffer, returns some buffer ID generated by Xerces

void uima::AnalysisEngineDescription::setXmlRootTag (  const icu::UnicodeString  xmlTag  )  [inline, inherited]

const icu::UnicodeString& uima::AnalysisEngineDescription::getXmlRootTag (   )  const [inline, inherited]

Returns: The full path name of the XML file used to build up this AnalysisEngineDescription. If it was built from a memory buffer, returns some buffer ID generated by Xerces

TyErrorId uima::AnalysisEngineDescription::addDelegate (  const icu::UnicodeString &  key, AnalysisEngineDescription *  taeSpec )  [inline, inherited]

NOTE: This object will assume memory ownership of taeSpec, i.e. it will be deleted when this object's destructor is called !

const TyMapDelegateSpecs& uima::AnalysisEngineDescription::getDelegates (   )  const [inline, inherited]

Note: This object will still assume memory ownership of the AnalysisEngineDescription that are returned.

const TyVecpSofaMappings& uima::AnalysisEngineDescription::getSofaMappings (   )  const [inline, inherited]

BSI Note: This object will still assume memory ownership of the returned SofAMapping objects that are returned.

TyErrorId uima::AnalysisEngineDescription::setSofaMappings (  TyVecpSofaMappings *  pSofaMappings  )  [inline, inherited]

BSI NOTE: This object will assume memory ownership of pSofaMappings, i.e. it will be deleted when this object's destructor is called !

TyErrorId uima::AnalysisEngineDescription::addSofaMapping (  SofaMapping *  pSofaMapping  )  [inline, inherited]

NOTE: This object will assume memory ownership of SofaMapping, i.e. it will be deleted when this object's destructor is called !

AnalysisEngineDescription* uima::AnalysisEngineDescription::getDelegate (  const icu::UnicodeString &  key  )  const [inherited]

Note: This object will still assume memory ownership of the AnalysisEngineDescription that is returned. Returns NULL if no delegate can be found for key

AnalysisEngineDescription* uima::AnalysisEngineDescription::extractDelegate (  const icu::UnicodeString &  key  )  [inherited]

Note: This object will delete the AnalysisEngineDescription returned from its map of delegate specifiers. Memory ownership is transferred to the caller of this method ! Returns NULL if no delegate can be found for key

NameValuePair* uima::AnalysisEngineDescription::getNameValuePair (  const icu::UnicodeString &  paramName, const icu::UnicodeString &  ancKey = "" )  [inline, inherited]

returns a reference to the NameValuePair whose name is paramName iff a) there are no configuration groups defined or there is a default group defined. b) a NameValuePair with the name exists in the configuration settings of this taespecifier Otherwise, returns NULL.

NameValuePair* uima::AnalysisEngineDescription::getNameValuePair (  const icu::UnicodeString &  groupName, const icu::UnicodeString &  paramName, AnalysisEngineMetaData::EnSearchStrategy  strategy, const icu::UnicodeString &  ancKey = "" )  [inline, inherited]

returns a reference to the NameValuePair whose name is paramName iff a) there are configuration groups defined b) a NameValuePair with the name exists in the configuration settings of the 'appropriate' group. This group may either be groupName or one of the fallback groups specified by the strategy OR a) groupName == CONFIG_GROUP_NAME_WHEN_NO_GROUPS b) a NameValuePair with the name exists in the configuration settings Throws an exception if a value is found, but the parameter is not defined. Throws an exception if no groups are defined and groupName != CONFIG_GROUP_NAME_WHEN_NO_GROUPS Otherwise, returns NULL.

TyErrorId uima::AnalysisEngineDescription::setNameValuePair (  const NameValuePair &  nvPair  )  [inline, inherited]

TyErrorId == UIMA_ERR_NONE iff a) there are groups: the name of nvPair is a configuration parameter defined in the common parameters or in the default group b) there are no groups: the name of nvPair is a configuration parameter If above conditions hold true, nvPair will be added to a) the settings of the default group b) the configuration settings.

TyErrorId uima::AnalysisEngineDescription::setNameValuePair (  const icu::UnicodeString &  groupName, const NameValuePair &  nvPair )  [inline, inherited]

TyErrorId == UIMA_ERR_NONE iff a) there is a group groupName in the configuration parameters b) the name of nvPair is a configuration parameter defined in groupName.

void uima::AnalysisEngineDescription::toXMLBuffer (  icu::UnicodeString &   )  const [inherited]

converts this specifier to an XML buffer.

void uima::AnalysisEngineDescription::toXMLBuffer (  AnalysisEngineMetaData const &  md, bool  isCasConsumer, icu::UnicodeString &  s )  const [inherited]

void uima::AnalysisEngineDescription::appendConfigParamsAndSettingsToXMLBuffer (  UnicodeString &  s  )  const [inherited]

TyErrorId uima::AnalysisEngineDescription::setFrameworkImplName (  EnFrameworkImplName  impl  )  [inline, inherited]

TyErrorId uima::AnalysisEngineDescription::setAnnotatorImpName (  const icu::UnicodeString &  anName  )  [inline, inherited]

void uima::AnalysisEngineDescription::appendToXMLBuffer (  AnalysisEngineMetaData::TyVecpFSIndexDescriptions const &  fsDesc, icu::UnicodeString &  s )  [protected, inherited]

void uima::AnalysisEngineDescription::appendToXMLBuffer (  AnalysisEngineMetaData::TyVecpTypePriorities const &  prioDesc, icu::UnicodeString &  s )  [protected, inherited]

void uima::AnalysisEngineDescription::appendToXMLBuffer (  TyVecpSofaMappings const &  sofaMapDesc, icu::UnicodeString &  s )  [protected, inherited]

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

---

Member Data Documentation

bool uima::MetaDataObject::iv_bIsModifiable [protected, inherited]

---

The documentation for this class was generated from the following file:

• taespecifier.hpp

---