---

             

---

uima::internal::CASDefinition Class Reference

List of all members.

---

Detailed Description

This class contains all information about CASs which live longer than a document, in particular the type system and the index definition.

An AnalysisEngine holds a reference to a CASDefinition object which is used when newCAS() is called.

Public Member Functions
virtual	~CASDefinition ()
void	init ()
void	commit ()
uima::lowlevel::TypeSystem &	getTypeSystem ()
uima::lowlevel::TypeSystem const &	getTypeSystem () const
uima::lowlevel::IndexDefinition &	getIndexDefinition ()
uima::lowlevel::IndexDefinition const &	getIndexDefinition () const
Static Public Member Functions
CASDefinition *	createCASDefinition (AnnotatorContext const &)
CASDefinition *	createCASDefinition (AnalysisEngineDescription const &)
	Construct a CASDefinition from the TextAnalysisSpecifier.
CASDefinition *	createCASDefinition (AnalysisEngineMetaData const &)
	Construct a CASDefinition from AnalysisEngineMetaData.
CASDefinition *	createCASDefinition (uima::TypeSystem &)
	Construct a CASDefinition with specified TypeSystem and built in indices.
CASDefinition *	createCASDefinition (uima::TypeSystem &, AnalysisEngineMetaData const &)
	Construct a CASDefinition from the TypeSystem with indices define in the AnalysisEngineMetaData.
CASDefinition *	createCASDefinition (TypeSystem &, AnalysisEngineMetaData::TyVecpFSIndexDescriptions const &, AnalysisEngineMetaData::TyVecpTypePriorities const &)
	Construct a CASDefinition from the TypeSystem, index and type priority descriptions.
CASDefinition *	createCASDefinition (TypeSystem &, AnalysisEngineMetaData::TyVecpFSIndexDescriptions const &)
	Construct a CASDefinition from the TypeSystem, index and type priority descriptions.
uima::lowlevel::TypeSystem *	createTypeSystem (AnalysisEngineMetaData const &)
	Construct a TypeSystem object from the type system definition and type priorities defined in the AnalysisEngineMetaData object Returns a committed typesystem.
uima::lowlevel::TypeSystem *	createTypeSystem (TypeSystemDescription const &, icu::UnicodeString const &)
	Construct a TypeSystem from the TypeSystemDescription Return a committed TypeSystem object.
uima::lowlevel::TypeSystem *	createTypeSystem (TypeSystemDescription const &, AnalysisEngineMetaData::TyVecpTypePriorities const &, icu::UnicodeString const &)
	Construct a TypeSystem object given the typesystem description and type priorities.
Protected Member Functions
void	mergeTypeSystem (AnalysisEngineDescription const &)
void	createIndexesFromANC (AnnotatorContext const &)
void	addTypePriorities (AnalysisEngineDescription const &)
virtual void	createTypes ()
virtual void	createIndexes ()
void	createPredefinedCASTypes ()
void	createPredefinedCASIndexes ()
void	commitTypeSystem ()
void	commitIndexDefinition ()
void	createIndexesFromSpecifier (AnalysisEngineMetaData::TyVecpFSIndexDescriptions const &)
void	addTypePriorities (AnalysisEngineMetaData::TyVecpTypePriorities const &)
void	mergeTypeSystem (TypeSystemDescription const &, icu::UnicodeString const &)
void	commitTypeSystemOnly ()
	CASDefinition (AnnotatorContext const *)
	CASDefinition (AnalysisEngineDescription const &)
	CASDefinition (uima::TypeSystem &)
	CASDefinition ()
Protected Attributes
uima::lowlevel::TypeSystem *	iv_typeSystem
uima::lowlevel::IndexDefinition *	iv_indexDefinition
AnnotatorContext const *	iv_annotatorContext
bool	bOwnsTypeSystem

---

Constructor & Destructor Documentation

uima::internal::CASDefinition::CASDefinition (  AnnotatorContext const *   )  [protected]

uima::internal::CASDefinition::CASDefinition (  AnalysisEngineDescription const &   )  [protected]

uima::internal::CASDefinition::CASDefinition (  uima::TypeSystem &   )  [protected]

uima::internal::CASDefinition::CASDefinition (   )  [protected]

virtual uima::internal::CASDefinition::~CASDefinition (   )  [virtual]

---

Member Function Documentation

void uima::internal::CASDefinition::mergeTypeSystem (  AnalysisEngineDescription const &   )  [protected]

void uima::internal::CASDefinition::createIndexesFromANC (  AnnotatorContext const &   )  [protected]

void uima::internal::CASDefinition::addTypePriorities (  AnalysisEngineDescription const &   )  [protected]

virtual void uima::internal::CASDefinition::createTypes (   )  [protected, virtual]

virtual void uima::internal::CASDefinition::createIndexes (   )  [protected, virtual]

void uima::internal::CASDefinition::createPredefinedCASTypes (   )  [protected]

void uima::internal::CASDefinition::createPredefinedCASIndexes (   )  [protected]

void uima::internal::CASDefinition::commitTypeSystem (   )  [protected]

void uima::internal::CASDefinition::commitIndexDefinition (   )  [protected]

void uima::internal::CASDefinition::createIndexesFromSpecifier (  AnalysisEngineMetaData::TyVecpFSIndexDescriptions const &   )  [protected]

void uima::internal::CASDefinition::addTypePriorities (  AnalysisEngineMetaData::TyVecpTypePriorities const &   )  [protected]

void uima::internal::CASDefinition::mergeTypeSystem (  TypeSystemDescription const &  , icu::UnicodeString const &  )  [protected]

void uima::internal::CASDefinition::commitTypeSystemOnly (   )  [protected]

CASDefinition* uima::internal::CASDefinition::createCASDefinition (  AnnotatorContext const &   )  [static]

CASDefinition* uima::internal::CASDefinition::createCASDefinition (  AnalysisEngineDescription const &   )  [static]

Construct a CASDefinition from the TextAnalysisSpecifier.

CASDefinition* uima::internal::CASDefinition::createCASDefinition (  AnalysisEngineMetaData const &   )  [static]

Construct a CASDefinition from AnalysisEngineMetaData.

CASDefinition* uima::internal::CASDefinition::createCASDefinition (  uima::TypeSystem &   )  [static]

Construct a CASDefinition with specified TypeSystem and built in indices.

CASDefinition* uima::internal::CASDefinition::createCASDefinition (  uima::TypeSystem &  , AnalysisEngineMetaData const &  )  [static]

Construct a CASDefinition from the TypeSystem with indices define in the AnalysisEngineMetaData.

CASDefinition* uima::internal::CASDefinition::createCASDefinition (  TypeSystem &  , AnalysisEngineMetaData::TyVecpFSIndexDescriptions const &  , AnalysisEngineMetaData::TyVecpTypePriorities const &  )  [static]

Construct a CASDefinition from the TypeSystem, index and type priority descriptions.

CASDefinition* uima::internal::CASDefinition::createCASDefinition (  TypeSystem &  , AnalysisEngineMetaData::TyVecpFSIndexDescriptions const &  )  [static]

Construct a CASDefinition from the TypeSystem, index and type priority descriptions.

uima::lowlevel::TypeSystem* uima::internal::CASDefinition::createTypeSystem (  AnalysisEngineMetaData const &   )  [static]

Construct a TypeSystem object from the type system definition and type priorities defined in the AnalysisEngineMetaData object Returns a committed typesystem.

uima::lowlevel::TypeSystem* uima::internal::CASDefinition::createTypeSystem (  TypeSystemDescription const &  , icu::UnicodeString const &  )  [static]

Construct a TypeSystem from the TypeSystemDescription Return a committed TypeSystem object.

uima::lowlevel::TypeSystem* uima::internal::CASDefinition::createTypeSystem (  TypeSystemDescription const &  , AnalysisEngineMetaData::TyVecpTypePriorities const &  , icu::UnicodeString const &  )  [static]

Construct a TypeSystem object given the typesystem description and type priorities. Returns a committed TypeSystem object.

void uima::internal::CASDefinition::init (   )

void uima::internal::CASDefinition::commit (   )

uima::lowlevel::TypeSystem& uima::internal::CASDefinition::getTypeSystem (   )

uima::lowlevel::TypeSystem const& uima::internal::CASDefinition::getTypeSystem (   )  const

uima::lowlevel::IndexDefinition& uima::internal::CASDefinition::getIndexDefinition (   )

uima::lowlevel::IndexDefinition const& uima::internal::CASDefinition::getIndexDefinition (   )  const

---

Member Data Documentation

uima::lowlevel::TypeSystem* uima::internal::CASDefinition::iv_typeSystem [protected]

uima::lowlevel::IndexDefinition* uima::internal::CASDefinition::iv_indexDefinition [protected]

AnnotatorContext const* uima::internal::CASDefinition::iv_annotatorContext [protected]

bool uima::internal::CASDefinition::bOwnsTypeSystem [protected]

---

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

• casdefinition.hpp

---