Logo Search packages:      
Sourcecode: uimaj version File versions  Download package

Public Member Functions | Static Public Attributes

org::apache::uima::analysis_engine::AnalysisEngine Interface Reference

Inheritance diagram for org::apache::uima::analysis_engine::AnalysisEngine:
Inheritance graph
[legend]
Collaboration diagram for org::apache::uima::analysis_engine::AnalysisEngine:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void batchProcessComplete () throws AnalysisEngineProcessException
void batchProcessComplete (ProcessTrace aTrace) throws ResourceProcessException, IOException
void collectionProcessComplete (ProcessTrace aTrace) throws ResourceProcessException, IOException
void collectionProcessComplete () throws AnalysisEngineProcessException
ResultSpecification createResultSpecification (TypeSystem aTypeSystem)
ResultSpecification createResultSpecification ()
void destroy ()
AnalysisEngineMetaData getAnalysisEngineMetaData ()
Object getConfigParameterValue (String aParamName)
Object getConfigParameterValue (String aGroupName, String aParamName)
String[] getFeatureNamesForType (String aTypeName)
Logger getLogger ()
AnalysisEngineManagement getManagementInterface ()
ResourceMetaData getMetaData ()
Properties getPerformanceTuningSettings ()
ProcessingResourceMetaData getProcessingResourceMetaData ()
ResourceManager getResourceManager ()
UimaContext getUimaContext ()
UimaContextAdmin getUimaContextAdmin ()
boolean initialize (ResourceSpecifier aSpecifier, Map< String, Object > aAdditionalParams) throws ResourceInitializationException
boolean isReadOnly ()
boolean isStateless ()
CAS newCAS () throws ResourceInitializationException
JCas newJCas () throws ResourceInitializationException
void process (JCas aJCas, ResultSpecification aResultSpec, ProcessTrace aTrace) throws ResultNotSupportedException, AnalysisEngineProcessException
ProcessTrace process (JCas aJCas, ResultSpecification aResultSpec) throws ResultNotSupportedException, AnalysisEngineProcessException
ProcessTrace process (CAS aCAS, ResultSpecification aResultSpec) throws ResultNotSupportedException, AnalysisEngineProcessException
void process (AnalysisProcessData aProcessData, ResultSpecification aResultSpec) throws ResultNotSupportedException, AnalysisEngineProcessException
void process (CAS aCAS, ResultSpecification aResultSpec, ProcessTrace aTrace) throws ResultNotSupportedException, AnalysisEngineProcessException
ProcessTrace process (CAS aCAS) throws AnalysisEngineProcessException
ProcessTrace process (JCas aJCas) throws AnalysisEngineProcessException
CasIterator processAndOutputNewCASes (CAS aCAS) throws AnalysisEngineProcessException
JCasIterator processAndOutputNewCASes (JCas aJCAS) throws AnalysisEngineProcessException
void processCas (CAS[] aCASes) throws ResourceProcessException
void processCas (CAS aCAS) throws ResourceProcessException
void reconfigure () throws ResourceConfigurationException
void setConfigParameterValue (String aGroupName, String aParamName, Object aValue)
void setConfigParameterValue (String aParamName, Object aValue)
void setLogger (Logger aLogger)
void setResultSpecification (ResultSpecification aResultSpec)
void typeSystemInit (TypeSystem aTypeSystem) throws ResourceInitializationException

Static Public Attributes

static final String PARAM_AGGREGATE_SOFA_MAPPINGS = "AGGREGATE_SOFA_MAPPINGS"
static final String PARAM_CONFIG_PARAM_SETTINGS = "CONFIG_PARAM_SETTINGS"
static final String PARAM_MBEAN_NAME_PREFIX = "MBEAN_NAME_PREFIX"
static final String PARAM_MBEAN_SERVER = "MBEAN_SERVER"
static final String PARAM_NUM_SIMULTANEOUS_REQUESTS = "NUM_SIMULTANEOUS_REQUESTS"
static final String PARAM_PERFORMANCE_TUNING_SETTINGS = "PERFORMANCE_TUNING_SETTINGS"
static final String PARAM_RESOURCE_MANAGER = "RESOURCE_MANAGER"
static final String PARAM_TIMEOUT_PERIOD = "TIMEOUT_PERIOD"
static final String PARAM_UIMA_CONTEXT = "UIMA_CONTEXT"

Detailed Description

An Analysis Engine is a component responsible for analyzing unstructured information, discovering and representing semantic content. Unstructured information includes, but is not restricted to, text documents.

An AnalysisEngine operates on an "analysis structure" (implemented by org.apache.uima.cas.CAS). The CAS contains the artifact to be processed as well as semantic information already inferred from that artifact. The AnalysisEngine analyzes this information and adds new information to the CAS.

To create an instance of an Analysis Engine, an application should call org.apache.uima.UIMAFramework#produceAnalysisEngine(ResourceSpecifier).

A typical application interacts with the Analysis Engine interface as follows:

  1. Call newCAS() to create a new Common Analysis System appropriate for this AnalysisEngine.
  2. Use the CAS interface to populate the CAS with the artifact to be analyzed any information known about this docuemnt (e.g. the language of a text document).
  3. Optionally, create a org.apache.uima.analysis_engine.ResultSpecification that identifies the results you would like this AnalysisEngine to generate (e.g. people, places, and dates), and call the {link setResultSpecification(ResultSpecification) method.
  4. Call process(CAS) - the AnalysisEngine will perform its analysis.
  5. Retrieve the results from the CAS.
  6. Call CAS#reset() to clear out the CAS and prepare for processing a new artifact.
  7. Repeat steps 2 through 6 for each artifact to be processed.

Important: It is highly recommended that you reuse CAS objects rather than calling newCAS() prior to each analysis. This is because CAS objects may be expensive to create and may consume a significant amount of memory.

Instead of using the CAS interface, applications may wish to use the Java-object-based JCas interface. In that case, the call to newCAS from step 1 above would be replaced by newJCas(), and the process(JCas) method would be used.

Analysis Engine implementations may or may not be capable of simultaneously processing multiple documents in a multithreaded environment. See the documentation associated with the implementation or factory method (e.g. (org.apache.uima.UIMAFramework#produceAnalysisEngine(ResourceSpecifier)) that you are using.

Definition at line 83 of file AnalysisEngine.java.


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

Generated by  Doxygen 1.6.0   Back to index