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

uima::TypeNameSpace Class Reference

List of all members.


Detailed Description

An accessor object that gives access to all types that share a common namespace.

For example if a TypeNameSpace object is created for the namespace "uima.tt" ( TypeNameSpace ttNameSpace(ts, "uima.tt");) you can then use this object to get type objects from types names by using only short names e.g. Type t = ttNameSpace.getType("Lemma"); would be equivalent to Type t = ts.getType("uima.tt.Lemma);

Public Member Functions

 TypeNameSpace (uima::TypeSystem const &crTypeSystem, icu::UnicodeString const &crName)
 Construct a TypeNameSpace object by passing it a reference the type system it lives in and the name of the namespace it should represent.
Type getType (icu::UnicodeString const &crTypeBaseName) const
 Find a type object by it's short name.
icu::UnicodeString const & getName () const
 Return the name of this namespace object.
void getAllTypes (std::vector< Type > &rResult) const
 Return a container with type objects for all types in this namespace.
TypeSystem const & getTypeSystem () const
 Return the typesystem this namespace lives in.


Constructor & Destructor Documentation

uima::TypeNameSpace::TypeNameSpace ( uima::TypeSystem const &  crTypeSystem,
icu::UnicodeString const &  crName 
)

Construct a TypeNameSpace object by passing it a reference the type system it lives in and the name of the namespace it should represent.


Member Function Documentation

Type uima::TypeNameSpace::getType ( icu::UnicodeString const &  crTypeBaseName  )  const

Find a type object by it's short name.

Implicitly this just prepends the namespace name to crTypeBaseName

icu::UnicodeString const& uima::TypeNameSpace::getName (  )  const

Return the name of this namespace object.

void uima::TypeNameSpace::getAllTypes ( std::vector< Type > &  rResult  )  const

Return a container with type objects for all types in this namespace.

TypeSystem const& uima::TypeNameSpace::getTypeSystem (  )  const

Return the typesystem this namespace lives in.


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