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

uima::TypeSystem Class Reference

List of all members.


Detailed Description

Class TypeSystem represents all knowledge about types in the FeatureStructure system.

Public Member Functions

virtual ~TypeSystem ()
Type getTopType () const
 get the TOP type.
Feature getFeatureByFullName (icu::UnicodeString const &crName) const
 find a feature by its fully qualified name, i.e., "<Type>:<FeatureBaseName>"
Type getType (icu::UnicodeString const &crName) const
 find a type by its name
void getAllTypes (std::vector< Type > &rResult) const
 get all the types in this FSSystem.
void getAllFeatures (std::vector< Feature > &rResult) const
 get all the features in this FSSystem.
bool isPrimitive (lowlevel::TyFSType tyType) const
bool isStringSubType (lowlevel::TyFSType tyType) const

Static Public Member Functions

Static methods.
The following static methods can be called on the TypeSystem class directly.

static void release (std::vector< uima::Type > &rResult)
 Release contents of vector container allocated by get methods Useful when caller and callee use different heaps, e.g.
static void release (std::vector< uima::Feature > &rResult)
 Release contents of vector container allocated by get methods Useful when caller and callee use different heaps, e.g.

Static Public Attributes

static const char FEATURE_SEPARATOR
static const char NAMESPACE_SEPARATOR

Protected Member Functions

virtual
uima::lowlevel::TypeSystem
const & 
getLowlevelTypeSystem () const =0
 TypeSystem ()
bool isFSArrayType (lowlevel::TyFSType tyType) const
bool isArrayType (lowlevel::TyFSType tyType) const
bool isListType (lowlevel::TyFSType tyType) const
bool isFSType (lowlevel::TyFSType tyType) const

Constructor & Destructor Documentation

uima::TypeSystem::TypeSystem (  )  [protected]

virtual uima::TypeSystem::~TypeSystem (  )  [virtual]


Member Function Documentation

virtual uima::lowlevel::TypeSystem const& uima::TypeSystem::getLowlevelTypeSystem (  )  const [protected, pure virtual]

bool uima::TypeSystem::isFSArrayType ( lowlevel::TyFSType  tyType  )  const [inline, protected]

bool uima::TypeSystem::isArrayType ( lowlevel::TyFSType  tyType  )  const [inline, protected]

bool uima::TypeSystem::isListType ( lowlevel::TyFSType  tyType  )  const [inline, protected]

bool uima::TypeSystem::isFSType ( lowlevel::TyFSType  tyType  )  const [inline, protected]

Type uima::TypeSystem::getTopType (  )  const

get the TOP type.

Feature uima::TypeSystem::getFeatureByFullName ( icu::UnicodeString const &  crName  )  const

find a feature by its fully qualified name, i.e., "&lt;Type>:&lt;FeatureBaseName>"

Returns:
the found feature, if a feature with that name could not be found, the returned object is not valid

Type uima::TypeSystem::getType ( icu::UnicodeString const &  crName  )  const

find a type by its name

Returns:
the found type, if a type with that name could not be found, the returned object is not valid

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

get all the types in this FSSystem.

void uima::TypeSystem::getAllFeatures ( std::vector< Feature > &  rResult  )  const

get all the features in this FSSystem.

bool uima::TypeSystem::isPrimitive ( lowlevel::TyFSType  tyType  )  const

bool uima::TypeSystem::isStringSubType ( lowlevel::TyFSType  tyType  )  const

static void uima::TypeSystem::release ( std::vector< uima::Type > &  rResult  )  [static]

Release contents of vector container allocated by get methods Useful when caller and callee use different heaps, e.g.

when debug code uses a release library.

static void uima::TypeSystem::release ( std::vector< uima::Feature > &  rResult  )  [static]

Release contents of vector container allocated by get methods Useful when caller and callee use different heaps, e.g.

when debug code uses a release library.


Member Data Documentation


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