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

uima::Framework Class Reference

List of all members.

Static Public Member Functions

AnalysisEngine * createAnalysisEngine (AnalysisEngineDescription &, ErrorInfo &errorInfo)
 create a AnalysisEngine from an AnalysisEngineDescription.
AnalysisEngine * createAnalysisEngine (char const *cpConfigFileName, ErrorInfo &errorInfo)
 create a AnalysisEngine from the name of configuration file.
AnalysisEngine * createAnalysisEngine (UChar const *cpBuffer, size_t uiLength, ErrorInfo &errorInfo)
 create a TextAnalysisEngine from an in-memory XML Buffer.
AnalysisEngine * createAnalysisEngine (bool isFile, icu::UnicodeString const &, ErrorInfo &)
 Creates a TAE from a file name if the first argument is true or an XML buffer if false.
AnalysisEngine * createAnalysisEngine (AnnotatorContext &rANC, bool bOwnsANC, bool bOwnsTAESpecifier, uima::internal::CASDefinition &casDefinition, bool ownsCASDefintion, ErrorInfo &)
 A lower level API for creating a TextAnalysisEngine The createAnalysisEngine functions could cause a memory leak if it fails because these methods use auto ptrs which are released prior to engine initialization.
Creation functions
TypeSystem * createTypeSystem (TypeSystemDescription const &, icu::UnicodeString const &, ErrorInfo &)
 create a TypeSystem from the input specifications.
TypeSystem * createTypeSystem (TypeSystemDescription const &, uima::AnalysisEngineMetaData::TyVecpTypePriorities const &, icu::UnicodeString const &, ErrorInfo &)
TypeSystem * createTypeSystem (char const *tsSpecFileName, ErrorInfo &)
TypeSystem * createTypeSystem (AnalysisEngineMetaData const &ae, ErrorInfo &rErrorInfo)
TypeSystem * createTypeSystem (UChar const *cpBuffer, size_t, ErrorInfo &)
 create a TypeSystem object from a null terminated char buffer containing the XML typesystem descriptor.
TypeSystem * createTypeSystemFromXMLBuffer (char const *cpBuffer, ErrorInfo &rErrorInfo)
 create a TypeSystem object from a null terminated char buffer containing the XML typesystem descriptor.
CAS * createCAS (TypeSystem &, ErrorInfo &)
 create a Cas using input TypeSystem and default indices.
CAS * createCAS (TypeSystem &, AnalysisEngineMetaData &, ErrorInfo &)
 create a CAS with input TypeSystem and indices defined in the descriptor.
CAS * createCAS (TypeSystem &, AnalysisEngineMetaData::TyVecpFSIndexDescriptions &, AnalysisEngineMetaData::TyVecpTypePriorities &, ErrorInfo &)
 create a CAS from TypeSystem and index definition and type priorities Returns NULL if creation failed.
CAS * createCAS (uima::internal::CASDefinition &, ErrorInfo &)
 create a CAS from CASDefinition.
TypeSystemDescription * createTypeSystemDescription (char const *tsSpecFileName)
 Create Description objects from xml.
TypeSystemDescription * createTypeSystemDescription (UChar const *cpBuffer, size_t uiLength)

Member Function Documentation

TypeSystem* uima::Framework::createTypeSystem (  TypeSystemDescription const &  ,
icu::UnicodeString const &  ,
ErrorInfo & 
)  [static]
 

create a TypeSystem from the input specifications.

Returns NULL if creation failed. In such a case, errorInfo contains information about possible errors (output parameter). The returned TypeSystem object is committed and cannot be modified.

TypeSystem* uima::Framework::createTypeSystem (  TypeSystemDescription const &  ,
uima::AnalysisEngineMetaData::TyVecpTypePriorities const &  ,
icu::UnicodeString const &  ,
ErrorInfo & 
)  [static]
 

TypeSystem* uima::Framework::createTypeSystem (  char const *  tsSpecFileName,
ErrorInfo & 
)  [static]
 

TypeSystem* uima::Framework::createTypeSystem (  AnalysisEngineMetaData const &  ae,
ErrorInfo &  rErrorInfo
)  [static]
 

TypeSystem* uima::Framework::createTypeSystem (  UChar const *  cpBuffer,
size_t  ,
ErrorInfo & 
)  [static]
 

create a TypeSystem object from a null terminated char buffer containing the XML typesystem descriptor.

TypeSystem* uima::Framework::createTypeSystemFromXMLBuffer (  char const *  cpBuffer,
ErrorInfo &  rErrorInfo
)  [static]
 

create a TypeSystem object from a null terminated char buffer containing the XML typesystem descriptor.

CAS* uima::Framework::createCAS (  TypeSystem &  ,
ErrorInfo & 
)  [static]
 

create a Cas using input TypeSystem and default indices.

Returns NULL if creation failed. In such a case, errorInfo contains information about possible errors (output parameter).

CAS* uima::Framework::createCAS (  TypeSystem &  ,
AnalysisEngineMetaData &  ,
ErrorInfo & 
)  [static]
 

create a CAS with input TypeSystem and indices defined in the descriptor.

Returns NULL if creation failed. In such a case, errorInfo contains information about possible errors (output parameter).

CAS* uima::Framework::createCAS (  TypeSystem &  ,
AnalysisEngineMetaData::TyVecpFSIndexDescriptions &  ,
AnalysisEngineMetaData::TyVecpTypePriorities &  ,
ErrorInfo & 
)  [static]
 

create a CAS from TypeSystem and index definition and type priorities Returns NULL if creation failed.

In such a case, errorInfo contains information about possible errors (output parameter).

CAS* uima::Framework::createCAS (  uima::internal::CASDefinition &  ,
ErrorInfo & 
)  [static]
 

create a CAS from CASDefinition.

Return NULL if creation failed. In such a case, errorInfo contains information about possible errors (output parameter).

TypeSystemDescription* uima::Framework::createTypeSystemDescription (  char const *  tsSpecFileName  )  [static]
 

Create Description objects from xml.

TypeSystemDescription* uima::Framework::createTypeSystemDescription (  UChar const *  cpBuffer,
size_t  uiLength
)  [static]
 

AnalysisEngine* uima::Framework::createAnalysisEngine (  AnalysisEngineDescription &  ,
ErrorInfo &  errorInfo
)  [static]
 

create a AnalysisEngine from an AnalysisEngineDescription.

Returns NULL if creation failed. In such a case, errorInfo contains information about possible errors (output parameter). The createAnalysisEngine functions could cause a memory leak if it fails because these methods use auto ptrs which are released prior to engine initialization.

AnalysisEngine* uima::Framework::createAnalysisEngine (  char const *  cpConfigFileName,
ErrorInfo &  errorInfo
)  [static]
 

create a AnalysisEngine from the name of configuration file.

Returns NULL if creation failed. In such a case, errorInfo contains information about possible errors (output parameter). The createAnalysisEngine functions could cause a memory leak if it fails because these methods use auto ptrs which are released prior to engine initialization.

AnalysisEngine* uima::Framework::createAnalysisEngine (  UChar const *  cpBuffer,
size_t  uiLength,
ErrorInfo &  errorInfo
)  [static]
 

create a TextAnalysisEngine from an in-memory XML Buffer.

Returns NULL if creation failed. In such a case, errorInfo contains information about possible errors (output parameter). The createAnalysisEngine functions could cause a memory leak if it fails because these methods use auto ptrs which are released prior to engine initialization.

AnalysisEngine* uima::Framework::createAnalysisEngine (  bool  isFile,
icu::UnicodeString const &  ,
ErrorInfo & 
)  [static]
 

Creates a TAE from a file name if the first argument is true or an XML buffer if false.

The createAnalysisEngine functions could cause a memory leak if it fails because these methods use auto ptrs which are released prior to engine initialization.

AnalysisEngine* uima::Framework::createAnalysisEngine (  AnnotatorContext &  rANC,
bool  bOwnsANC,
bool  bOwnsTAESpecifier,
uima::internal::CASDefinition &  casDefinition,
bool  ownsCASDefintion,
ErrorInfo & 
)  [static]
 

A lower level API for creating a TextAnalysisEngine The createAnalysisEngine functions could cause a memory leak if it fails because these methods use auto ptrs which are released prior to engine initialization.

The documentation for this class was generated from the following file:
Generated on Mon Oct 1 16:04:13 2012 for UIMACPP API by  doxygen 1.3.9.1