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

uima::TypeSystemDescription Class Reference

Inherits uima::MetaDataObject.

List of all members.


Detailed Description

Contains all TypeDescription and TypePriority objects for a TextAnalysisEngine.

Public Types

typedef std::vector
< TypeDescription * > 
TyVecpTypeDescriptions
typedef std::vector
< ImportDescription * > 
TyVecpImportDescriptions

Public Member Functions

 TypeSystemDescription ()
 ~TypeSystemDescription ()
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#.
void mergeTypeDescriptions (const TyVecpTypeDescriptions &descs)
 Adds all type descriptions in descs to this type system description.
TyErrorId addTypeDescription (TypeDescription *desc, bool &takesMemoryOwnerShip)
 NOTE: This object will assume memory ownership of desc, i.e.
const TyVecpTypeDescriptionsgetTypeDescriptions () const
TypeDescriptiongetTypeDescription (const icu::UnicodeString &typeName) const
const TypeDescriptiongetTypeDescriptionConst (const icu::UnicodeString &typeName) const
bool hasTypeDescription (const icu::UnicodeString &typeName) const
void setXmlFileLocation (const icu::UnicodeString xmlLoc)
const icu::UnicodeString & getXmlFileLocation () const
TyErrorId addImportDescription (ImportDescription *pDesc, bool &takesMemoryOwnerShip)
const TyVecpImportDescriptionsgetImportDescriptions () const
TyErrorId resolveImports (std::vector< icu::UnicodeString > &alreadyImportedTypeSystemLocations)
TyErrorId resolveImport (const icu::UnicodeString &fileLocation, std::vector< icu::UnicodeString > &alreadyImportedTypeSystemLocations, TyVecpTypeDescriptions &result)
void validate ()
bool isModifiable () const

Protected Attributes

bool iv_bIsModifiable

Member Typedef Documentation


Constructor & Destructor Documentation

uima::TypeSystemDescription::TypeSystemDescription (  )  [inline]

uima::TypeSystemDescription::~TypeSystemDescription (  )  [inline]


Member Function Documentation

void uima::TypeSystemDescription::commit (  )  [inline, virtual]

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.

void uima::TypeSystemDescription::mergeTypeDescriptions ( const TyVecpTypeDescriptions descs  ) 

Adds all type descriptions in descs to this type system description.

If there are two type descriptions with the same name and same supertype, their features are merged into one TypeDescription. If two descriptions have the same name, but different supertype names (which is not allowed), the TypeSystemDescription will contain both entries. The error will be identified when validating the TextAnalysisEngineSpecifier TypeDescription objects contained in descs will be copied, hence, the memory ownership of the objects in descs will remain with the caller of this method.

See also:
validate()

TyErrorId uima::TypeSystemDescription::addTypeDescription ( TypeDescription desc,
bool &  takesMemoryOwnerShip 
)

NOTE: This object will assume memory ownership of desc, i.e.

it will delete it when destroyed !

const TyVecpTypeDescriptions& uima::TypeSystemDescription::getTypeDescriptions (  )  const [inline]

TypeDescription* uima::TypeSystemDescription::getTypeDescription ( const icu::UnicodeString &  typeName  )  const

const TypeDescription* uima::TypeSystemDescription::getTypeDescriptionConst ( const icu::UnicodeString &  typeName  )  const [inline]

bool uima::TypeSystemDescription::hasTypeDescription ( const icu::UnicodeString &  typeName  )  const [inline]

References EXISTS.

void uima::TypeSystemDescription::setXmlFileLocation ( const icu::UnicodeString  xmlLoc  )  [inline]

const icu::UnicodeString& uima::TypeSystemDescription::getXmlFileLocation (  )  const [inline]

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

TyErrorId uima::TypeSystemDescription::addImportDescription ( ImportDescription pDesc,
bool &  takesMemoryOwnerShip 
)

const TyVecpImportDescriptions& uima::TypeSystemDescription::getImportDescriptions (  )  const [inline]

TyErrorId uima::TypeSystemDescription::resolveImports ( std::vector< icu::UnicodeString > &  alreadyImportedTypeSystemLocations  ) 

TyErrorId uima::TypeSystemDescription::resolveImport ( const icu::UnicodeString &  fileLocation,
std::vector< icu::UnicodeString > &  alreadyImportedTypeSystemLocations,
TyVecpTypeDescriptions result 
)

void uima::TypeSystemDescription::validate (  ) 

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:

Generated on Mon Oct 1 11:15:09 2012 for UIMACPP API by  doxygen 1.5.6