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

uima::Framework Class Reference

List of all members.

Static Public Member Functions

static AnalysisEnginecreateAnalysisEngine (AnalysisEngineDescription &, ErrorInfo &errorInfo)
 create a AnalysisEngine from an AnalysisEngineDescription.
static AnalysisEnginecreateAnalysisEngine (char const *cpConfigFileName, ErrorInfo &errorInfo)
 create a AnalysisEngine from the name of configuration file.
static AnalysisEnginecreateAnalysisEngine (UChar const *cpBuffer, size_t uiLength, ErrorInfo &errorInfo)
 create a TextAnalysisEngine from an in-memory XML Buffer.
static AnalysisEnginecreateAnalysisEngine (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.
static AnalysisEnginecreateAnalysisEngine (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
static TypeSystemcreateTypeSystem (TypeSystemDescription const &, icu::UnicodeString const &, ErrorInfo &)
 create a TypeSystem from the input specifications.
static TypeSystemcreateTypeSystem (TypeSystemDescription const &, uima::AnalysisEngineMetaData::TyVecpTypePriorities const &, icu::UnicodeString const &, ErrorInfo &)
static TypeSystemcreateTypeSystem (char const *tsSpecFileName, ErrorInfo &)
static TypeSystemcreateTypeSystem (AnalysisEngineMetaData const &ae, ErrorInfo &rErrorInfo)
static TypeSystemcreateTypeSystem (UChar const *cpBuffer, size_t, ErrorInfo &)
 create a TypeSystem object from a null terminated char buffer containing the XML typesystem descriptor.
static TypeSystemcreateTypeSystemFromXMLBuffer (char const *cpBuffer, ErrorInfo &rErrorInfo)
 create a TypeSystem object from a null terminated char buffer containing the XML typesystem descriptor.
static CAScreateCAS (TypeSystem &, ErrorInfo &)
 create a Cas using input TypeSystem and default indices.
static CAScreateCAS (TypeSystem &, AnalysisEngineMetaData &, ErrorInfo &)
 create a CAS with input TypeSystem and indices defined in the descriptor.
static CAScreateCAS (TypeSystem &, AnalysisEngineMetaData::TyVecpFSIndexDescriptions &, AnalysisEngineMetaData::TyVecpTypePriorities &, ErrorInfo &)
 create a CAS from TypeSystem and index definition and type priorities Returns NULL if creation failed.
static CAScreateCAS (uima::internal::CASDefinition &, ErrorInfo &)
 create a CAS from CASDefinition.
static TypeSystemDescriptioncreateTypeSystemDescription (char const *tsSpecFileName)
 Create Description objects from xml.
static TypeSystemDescriptioncreateTypeSystemDescription (UChar const *cpBuffer, size_t uiLength)


Member Function Documentation

static 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.

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

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

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

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.

static 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.

static 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).

static 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).

static 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).

static 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).

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

Create Description objects from xml.

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

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.

static 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.

static 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.

static 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.

static 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 11:15:08 2012 for UIMACPP API by  doxygen 1.5.6