---

             

---

uima::ImportDescription Class Reference

Inherits uima::MetaDataObject.

List of all members.

---

Detailed Description

A Import object represents a pointer to a descriptor file to be imported.

These are currently used to import type systems, indexes, and type priorities, delegate analysis engine descriptors. Imports may be by location (relative URL) or name (a Java-style compound name, looked up in the classpath), but not both.

Public Member Functions
	ImportDescription ()
	Constructor.
TyErrorId	setLocation (const icu::UnicodeString &aUri)
	Sets the location of this import's target.
const icu::UnicodeString &	getLocation () const
	Gets the location of this import's target.
TyErrorId	setName (const icu::UnicodeString &aname)
	a Java-style compound name which specifies the target of this import.
const icu::UnicodeString &	getName () const
	a Java-style compound name which specifies the target of this import.
const icu::UnicodeString	findAbsoluteUrl (icu::UnicodeString const &lastFilename)
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

---

Constructor & Destructor Documentation

uima::ImportDescription::ImportDescription (   )  [inline]

Constructor.

---

Member Function Documentation

TyErrorId uima::ImportDescription::setLocation (  const icu::UnicodeString &  aUri  )  [inline]

Sets the location of this import's target. Parameters: aUri  a URI specifying the location of this import's target.

const icu::UnicodeString& uima::ImportDescription::getLocation (   )  const [inline]

Gets the location of this import's target. Returns: a URI specifying the location of this import's target.

TyErrorId uima::ImportDescription::setName (  const icu::UnicodeString &  aname  )  [inline]

a Java-style compound name which specifies the target of this import. This will be located by appending ".xml" to the name and searching the classpath.

const icu::UnicodeString& uima::ImportDescription::getName (  void   )  const [inline]

a Java-style compound name which specifies the target of this import. This will be located by appending ".xml" to the name and searching the classpath.

const icu::UnicodeString uima::ImportDescription::findAbsoluteUrl (  icu::UnicodeString const &  lastFilename  )  [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:

• importdescription.hpp

---