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

uima::TextAnalysisEngine Class Reference

Detailed Description

Deprecated:: A TextAnalysisEngine is an AnalysisEngine specialized for Text Analysis. It adds text specific support like language aware processing. It contains a specialized version of the CAS for text analysis, a uima::TCAS.
This class also provides methods to instantiate an AnalysisEngine from an XML descriptor.

Public Member Functions

virtual ~TextAnalysisEngine ()

virtual CAS * newCAS () const =0

create a new CAS which can be used to process documents and other data with this AnalysisEngine.

virtual bool isPrimitive () const =0

Returns true if this is not an aggregate engine.

virtual AnnotatorContext & getAnnotatorContext ()=0

Returns the AnnotatorContext for this engine.

virtual AnnotatorContext const & getAnnotatorContext () const =0

Returns the AnnotatorContext for this engine const version.

virtual AnalysisEngineMetaData
const & getAnalysisEngineMetaData () const

get an uima::AnalysisEngineMetaData describing all kinds of meta data about this engine, e.g., if it is primitive, which annotators it uses, etc.

virtual ResultSpecification
const & getCompleteResultSpecification () const =0

Returns the result specification that is specified in the configuration file for this engine.

virtual TyErrorId initialize (AnalysisEngineDescription const &)=0

virtual bool isInitialized () const =0

virtual TyErrorId process (CAS &cas)=0

invoke this engine's analysis logic.

virtual TyErrorId process (CAS &cas, ResultSpecification const &resultSpec)=0

invoke this engine's analysis logic where resultSpec constrains what kinds on results are needed by the application.

virtual TyErrorId reconfigure ()=0

trigger a reconfigure call to all annotators of this engine

virtual TyErrorId destroy ()=0

de-initialize the engine.

virtual TyErrorId batchProcessComplete ()=0

Completes the processing of a batch.

virtual TyErrorId collectionProcessComplete ()=0

Completes the processing of a collection.

virtual CASIterator processAndOutputNewCASes (CAS &)=0

Processes a CAS, possibly producing multiple CASes as a result.

Static Public Member Functions

Creation functions

TextAnalysisEngine * createTextAnalysisEngine (AnalysisEngineDescription &, ErrorInfo &errorInfo)

TextAnalysisEngine * createTextAnalysisEngine (char const *cpConfigFileName, ErrorInfo &errorInfo)

TextAnalysisEngine * createTextAnalysisEngine (UChar const *cpBuffer, size_t uiLength, ErrorInfo &errorInfo)

TextAnalysisEngine * createTAE (AnnotatorContext &rANC, bool bOwnsANC, bool bOwnsTAESpecifier, uima::internal::CASDefinition &casDefinition, bool ownsCASDefintion, ErrorInfo &)

TextAnalysisEngine * createTAE (bool isFile, icu::UnicodeString const &, ErrorInfo &)

Static Info Functions

const char * getErrorIdAsCString (TyErrorId utErrorId)

Return a static pointer to a string representation of the specified error id.

void printErrorIdTable (std::ostream &rclOutStream)

Prints a table of ERRID = ERRSTRING to rclOutStream.

const char * getVersionInfo (void)

Return the engine version information.

const char * getLevelInfo (void)

Return the engine level information.

Protected Member Functions

virtual bool hasNext ()=0

Returns whether this engine will return a new CAS.

virtual CAS & next ()=0

Returns a new CAS distinct from the input CAS.

virtual int getCasInstancesRequired ()=0

Returns the maximum number of CAS instances that this AnalysisComponent expects to use at the same time.

Constructor & Destructor Documentation

virtual uima::TextAnalysisEngine::~TextAnalysisEngine ( ) [inline, virtual]

Member Function Documentation

TextAnalysisEngine* uima::TextAnalysisEngine::createTextAnalysisEngine ( AnalysisEngineDescription & ,

ErrorInfo & errorInfo

) [static]

Deprecated:
create a TextAnalysisEngine from a TAESpecifier. Returns NULL if creation failed. In such a case, errorInfo contains information about possible errors (output parameter).

TextAnalysisEngine* uima::TextAnalysisEngine::createTextAnalysisEngine ( char const * cpConfigFileName,

ErrorInfo & errorInfo

) [static]

Deprecated:
create a TextAnalysisEngine from the name of configuration file. Returns NULL if creation failed. In such a case, errorInfo contains information about possible errors (output parameter).

TextAnalysisEngine* uima::TextAnalysisEngine::createTextAnalysisEngine ( UChar const * cpBuffer,

size_t uiLength,

ErrorInfo & errorInfo

) [static]

Deprecated:
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).

TextAnalysisEngine* uima::TextAnalysisEngine::createTAE ( AnnotatorContext & rANC,

bool bOwnsANC,

bool bOwnsTAESpecifier,

uima::internal::CASDefinition & casDefinition,

bool ownsCASDefintion,

ErrorInfo &

) [static]

Deprecated:
A lower level API for creating a TextAnalysisEngine

TextAnalysisEngine* uima::TextAnalysisEngine::createTAE ( bool isFile,

icu::UnicodeString const & ,

ErrorInfo &

) [static]

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

virtual bool uima::AnalysisEngine::hasNext ( ) [protected, pure virtual, inherited]

Returns whether this engine will return a new CAS.

Returns:
true or false.

virtual CAS& uima::AnalysisEngine::next ( ) [protected, pure virtual, inherited]

Returns a new CAS distinct from the input CAS.

Returns:
true or false.

virtual int uima::AnalysisEngine::getCasInstancesRequired ( ) [protected, pure virtual, inherited]

Returns the maximum number of CAS instances that this AnalysisComponent expects to use at the same time.
This only applies to CasMultipliers. Most CasMultipliers will only need one CAS at a time. Only if there is a clear need should this be overridden to return something greater than 1.
Returns:
true or false.

virtual CAS* uima::AnalysisEngine::newCAS ( ) const [pure virtual, inherited]

create a new CAS which can be used to process documents and other data with this AnalysisEngine.
Memory ownership is transferred to the caller. The returned CAS is only valid for the lifetime as the engine it was obtained from.

virtual bool uima::AnalysisEngine::isPrimitive ( ) const [pure virtual, inherited]

Returns true if this is not an aggregate engine.

virtual AnnotatorContext& uima::AnalysisEngine::getAnnotatorContext ( ) [pure virtual, inherited]

Returns the AnnotatorContext for this engine.

virtual AnnotatorContext const& uima::AnalysisEngine::getAnnotatorContext ( ) const [pure virtual, inherited]

Returns the AnnotatorContext for this engine const version.

virtual AnalysisEngineMetaData const& uima::AnalysisEngine::getAnalysisEngineMetaData ( ) const [virtual, inherited]

get an uima::AnalysisEngineMetaData describing all kinds of meta data about this engine, e.g., if it is primitive, which annotators it uses, etc.

virtual ResultSpecification const& uima::AnalysisEngine::getCompleteResultSpecification ( ) const [pure virtual, inherited]

Returns the result specification that is specified in the configuration file for this engine.
An application may copy the result of this function, remove some elements from the copy and pass it back to the process function.

virtual TyErrorId uima::AnalysisEngine::initialize ( AnalysisEngineDescription const & ) [pure virtual, inherited]

virtual bool uima::AnalysisEngine::isInitialized ( ) const [pure virtual, inherited]

virtual TyErrorId uima::AnalysisEngine::process ( CAS & cas ) [pure virtual, inherited]

invoke this engine's analysis logic.

Returns:
an error code

virtual TyErrorId uima::AnalysisEngine::process ( CAS & cas,

ResultSpecification const & resultSpec

) [pure virtual, inherited]

invoke this engine's analysis logic where resultSpec constrains what kinds on results are needed by the application.

Returns:
an error code

virtual TyErrorId uima::AnalysisEngine::reconfigure ( ) [pure virtual, inherited]

trigger a reconfigure call to all annotators of this engine

Returns:
an error code

virtual TyErrorId uima::AnalysisEngine::destroy ( ) [pure virtual, inherited]

de-initialize the engine.

Returns:
an error code

virtual TyErrorId uima::AnalysisEngine::batchProcessComplete ( ) [pure virtual, inherited]

Completes the processing of a batch.
A collection of artifacts to be analyzed may be divided into one or more batches

it is up to the CollectionProcessingManager or the application to determine the number and size of batches.
Returns:
an error code

virtual TyErrorId uima::AnalysisEngine::collectionProcessComplete ( ) [pure virtual, inherited]

Completes the processing of a collection.
The CollectionProcessingManager or the application invokes this method when after all artifacts in the collection are processed.
Returns:
an error code

virtual CASIterator uima::AnalysisEngine::processAndOutputNewCASes ( CAS & ) [pure virtual, inherited]

Processes a CAS, possibly producing multiple CASes as a result.
The application uses the CASIterator interface to step through the output CASes.
If this Analysis Engine does not produce output CASes, then the CASIterator will return no elements.
Once this method is called, the AnalysisEngine "owns" aCAS until such time as the CASIterator#hasNext() method returns false. That is, the caller should not attempt to modify or access the input CAS until it has read all of the elements from the CasIterator. If the caller wants to abort the processing before having read all of the output CASes, it may call uima::CASIterator#release(), which will stop further processing from occurring, and ownership of aCAS will revert to the caller.

const char* uima::AnalysisEngine::getErrorIdAsCString ( TyErrorId utErrorId ) [static, inherited]

Return a static pointer to a string representation of the specified error id.
Can be used to produce more readable error output

void uima::AnalysisEngine::printErrorIdTable ( std::ostream & rclOutStream ) [static, inherited]

Prints a table of ERRID = ERRSTRING to rclOutStream.

const char* uima::AnalysisEngine::getVersionInfo ( void ) [static, inherited]

Return the engine version information.

const char* uima::AnalysisEngine::getLevelInfo ( void ) [static, inherited]

Return the engine level information.

The documentation for this class was generated from the following file:

engine.hpp

Generated on Mon Oct 1 16:04:13 2012 for UIMACPP API by

1.3.9.1


Public Member Functions
virtual	~TextAnalysisEngine ()
virtual CAS *	newCAS () const =0
	create a new CAS which can be used to process documents and other data with this AnalysisEngine.
virtual bool	isPrimitive () const =0
	Returns true if this is not an aggregate engine.
virtual AnnotatorContext &	getAnnotatorContext ()=0
	Returns the AnnotatorContext for this engine.
virtual AnnotatorContext const &	getAnnotatorContext () const =0
	Returns the AnnotatorContext for this engine const version.
virtual AnalysisEngineMetaData const &	getAnalysisEngineMetaData () const
	get an uima::AnalysisEngineMetaData describing all kinds of meta data about this engine, e.g., if it is primitive, which annotators it uses, etc.
virtual ResultSpecification const &	getCompleteResultSpecification () const =0
	Returns the result specification that is specified in the configuration file for this engine.
virtual TyErrorId	initialize (AnalysisEngineDescription const &)=0
virtual bool	isInitialized () const =0
virtual TyErrorId	process (CAS &cas)=0
	invoke this engine's analysis logic.
virtual TyErrorId	process (CAS &cas, ResultSpecification const &resultSpec)=0
	invoke this engine's analysis logic where `resultSpec` constrains what kinds on results are needed by the application.
virtual TyErrorId	reconfigure ()=0
	trigger a reconfigure call to all annotators of this engine
virtual TyErrorId	destroy ()=0
	de-initialize the engine.
virtual TyErrorId	batchProcessComplete ()=0
	Completes the processing of a batch.
virtual TyErrorId	collectionProcessComplete ()=0
	Completes the processing of a collection.
virtual CASIterator	processAndOutputNewCASes (CAS &)=0
	Processes a `CAS`, possibly producing multiple CASes as a result.
Static Public Member Functions
Creation functions
TextAnalysisEngine *	createTextAnalysisEngine (AnalysisEngineDescription &, ErrorInfo &errorInfo)
TextAnalysisEngine *	createTextAnalysisEngine (char const *cpConfigFileName, ErrorInfo &errorInfo)
TextAnalysisEngine *	createTextAnalysisEngine (UChar const *cpBuffer, size_t uiLength, ErrorInfo &errorInfo)
TextAnalysisEngine *	createTAE (AnnotatorContext &rANC, bool bOwnsANC, bool bOwnsTAESpecifier, uima::internal::CASDefinition &casDefinition, bool ownsCASDefintion, ErrorInfo &)
TextAnalysisEngine *	createTAE (bool isFile, icu::UnicodeString const &, ErrorInfo &)
Static Info Functions
const char *	getErrorIdAsCString (TyErrorId utErrorId)
	Return a static pointer to a string representation of the specified error id.
void	printErrorIdTable (std::ostream &rclOutStream)
	Prints a table of ERRID = ERRSTRING to `rclOutStream`.
const char *	getVersionInfo (void)
	Return the engine version information.
const char *	getLevelInfo (void)
	Return the engine level information.
Protected Member Functions
virtual bool	hasNext ()=0
	Returns whether this engine will return a new CAS.
virtual CAS &	next ()=0
	Returns a new CAS distinct from the input CAS.
virtual int	getCasInstancesRequired ()=0
	Returns the maximum number of CAS instances that this AnalysisComponent expects to use at the same time.