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

uima::Type Class Reference

List of all members.


Detailed Description

This class represents a type in the type hierarchy of the type system.

Public Member Functions

 Type ()
 Default constructor.
bool isValid () const
bool operator== (Type const &crOther) const
bool operator!= (Type const &crOther) const
bool operator< (Type const &other) const
UnicodeStringRef getName () const
 get the name of the type.
UnicodeStringRef getCreatorID () const
 get the creator ID of the type.
void getAppropriateFeatures (std::vector< Feature > &result) const
 get the list of all features appropriate for this type.
bool isAppropriateFeature (Feature const &f) const
 return true if a feature f is appropriate for this type.
void getDirectSubTypes (std::vector< Type > &rResult) const
 Get all the direct subtypes of this type;.
void getSubTypes (std::vector< Type > &rResult) const
 Get all the subtypes of this type;.
Feature getFeatureByBaseName (icu::UnicodeString const &crBaseName) const
 Get the feature with base name crBaseName.
bool subsumes (Type const &crType) const
uima::TypeSystem const & getTypeSystem () const
 get the type system this type lives in.
bool isStringSubType () const

Constructor & Destructor Documentation

uima::Type::Type (  ) 

Default constructor.

Creates an invalid FSType object.


Member Function Documentation

bool uima::Type::isValid (  )  const

Returns:
true if the object is valid

bool uima::Type::operator== ( Type const &  crOther  )  const

bool uima::Type::operator!= ( Type const &  crOther  )  const

bool uima::Type::operator< ( Type const &  other  )  const

UnicodeStringRef uima::Type::getName (  )  const

get the name of the type.

Exceptions:
InvalidFSTypeObjectException 

UnicodeStringRef uima::Type::getCreatorID (  )  const

get the creator ID of the type.

See separate section for details

Exceptions:
InvalidFSFeatureObjectException 

void uima::Type::getAppropriateFeatures ( std::vector< Feature > &  result  )  const

get the list of all features appropriate for this type.

Parameters:
result output parameter
Exceptions:
InvalidFSTypeObjectException 

bool uima::Type::isAppropriateFeature ( Feature const &  f  )  const

return true if a feature f is appropriate for this type.

Parameters:
f feature to check
Exceptions:
InvalidFSTypeObjectException 

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

Get all the direct subtypes of this type;.

Exceptions:
InvalidFSTypeObjectException 

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

Get all the subtypes of this type;.

Exceptions:
InvalidFSTypeObjectException 

Feature uima::Type::getFeatureByBaseName ( icu::UnicodeString const &  crBaseName  )  const

Get the feature with base name crBaseName.

Returns an invalid FSFeature object if no feature with the specified base name is appropriate for this type.

Parameters:
crBaseName the base name of the feature to be found
Exceptions:
InvalidFSTypeObjectException 

bool uima::Type::subsumes ( Type const &  crType  )  const

Returns:
true if this object subsumes crType.
Exceptions:
InvalidFSTypeObjectException 

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

get the type system this type lives in.

Exceptions:
InvalidFSFeatureObjectException 

bool uima::Type::isStringSubType (  )  const


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