efxtools.filtering
Class FilteringAnalysisEngine

java.lang.Object
  extended by org.apache.uima.analysis_component.AnalysisComponent_ImplBase
      extended by org.apache.uima.analysis_component.Annotator_ImplBase
          extended by org.apache.uima.analysis_component.JCasAnnotator_ImplBase
              extended by efxtools.filtering.FilteringAnalysisEngine
All Implemented Interfaces:
org.apache.uima.analysis_component.AnalysisComponent
Direct Known Subclasses:
EfXFinancialExtractor, EfXForecastDetector, EfXFoundedExtractor, EfXMoneyRecognizer, EfXParagraphSplitter, EfXRBSentenceSplitter, EFXRBTokenizer, EfXTimeRecognizer, StanfordNER, TT4jChunker, TT4jTagger, UIMAWhitespaceTokenizer

public abstract class FilteringAnalysisEngine
extends org.apache.uima.analysis_component.JCasAnnotator_ImplBase

This class represents a primitive UIMA analysis engine (also called annotator) that restricts its analysis to a defined Scope. Any primitive analysis engine that shall be used within the filtering framework should inherit from this class.

The concept of filtering analysis engines was designed in order to minimize the additional effort of a developer of analysis engines when using the filtering framework. The only adaptation to be performed for an analysis engine is that the analysis engines should not implement the superclass method process(JCas), but the abstract method process(JCas, Scope) of this class. This method has a parameter that defines the scope to be analyzed, i.e., the portions of text that are relevant with respect to the output annotation types and features of the analysis engine.

Internally, the scope to be analyzed is requested from the ScopeTMS prior to analyis. The scope depends on the output annotation types and features of the analysis engine, which are automatically determined from the engine's ResultSpecification. After analysis, all scopes of the current query (see AScopedQuery) the output annotation types and features are relevant for are updated according to the obtained analysis results.

Author:
Author of EfXTools

Constructor Summary
FilteringAnalysisEngine()
           
 
Method Summary
 void process(org.apache.uima.jcas.JCas jcas)
           
 void setResultSpecification(org.apache.uima.analysis_engine.ResultSpecification aResultSpec)
           
 
Methods inherited from class org.apache.uima.analysis_component.JCasAnnotator_ImplBase
getRequiredCasInterface, process
 
Methods inherited from class org.apache.uima.analysis_component.Annotator_ImplBase
getCasInstancesRequired, hasNext, next
 
Methods inherited from class org.apache.uima.analysis_component.AnalysisComponent_ImplBase
batchProcessComplete, collectionProcessComplete, destroy, initialize, reconfigure
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FilteringAnalysisEngine

public FilteringAnalysisEngine()
Method Detail

setResultSpecification

public void setResultSpecification(org.apache.uima.analysis_engine.ResultSpecification aResultSpec)
Specified by:
setResultSpecification in interface org.apache.uima.analysis_component.AnalysisComponent
Overrides:
setResultSpecification in class org.apache.uima.analysis_component.AnalysisComponent_ImplBase

process

public final void process(org.apache.uima.jcas.JCas jcas)
                   throws org.apache.uima.analysis_engine.AnalysisEngineProcessException
Specified by:
process in class org.apache.uima.analysis_component.JCasAnnotator_ImplBase
Throws:
org.apache.uima.analysis_engine.AnalysisEngineProcessException