AnalysisEngine can be used for analyzing all kinds of unstructured information.
It is mainly designed to work well with text but it should also work with other kinds of unstructured information like life sciences data.
An analysis engine is a mediator between an application interested in the analysis results for some piece of unstructured input data and the so called annotators that actually produce this analysis result.
All results -intermediate and final- are passed through the Common Analysis Structure (CAS) linking the application and the annotators.
An AnalysisEngine hides the complexities of computing the results and the flow of control between all annotators working on the results from the application.
For text analysis, use uima::TextAnalysisEngine.
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. | |
Public Member Functions | |
| virtual | ~AnalysisEngine () |
| 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. | |
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. | |
|
|
|
|
|
Returns whether this engine will return a new CAS.
|
|
|
Returns a new CAS distinct from the input CAS.
|
|
|
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.
|
|
|
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. |
|
|
Returns true if this is not an aggregate engine.
|
|
|
Returns the AnnotatorContext for this engine.
|
|
|
Returns the AnnotatorContext for this engine const version.
|
|
|
get an uima::AnalysisEngineMetaData describing all kinds of meta data about this engine, e.g., if it is primitive, which annotators it uses, etc.
|
|
|
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. |
|
|
|
|
|
|
|
|
invoke this engine's analysis logic.
|
|
||||||||||||
|
invoke this engine's analysis logic where
|
|
|
trigger a reconfigure call to all annotators of this engine
|
|
|
de-initialize the engine.
|
|
|
Completes the processing of a batch. A collection of artifacts to be analyzed may be divided into one or more batches
|
|
|
Completes the processing of a collection. The CollectionProcessingManager or the application invokes this method when after all artifacts in the collection are processed.
|
|
|
Processes a The application uses the CASIterator interface to step through the output CASes.
If this Analysis Engine does not produce output CASes, then the
Once this method is called, the AnalysisEngine "owns" |
|
|
Return a static pointer to a string representation of the specified error id. Can be used to produce more readable error output |
|
|
Prints a table of ERRID = ERRSTRING to
|
|
|
Return the engine version information.
|
|
|
Return the engine level information.
|
1.3.9.1