de.tudarmstadt.ukp.dkpro.core.textnormalizer.casfilter

Class CasFilter_ImplBase

java.lang.Object

org.apache.uima.analysis_component.AnalysisComponent_ImplBase

org.apache.uima.analysis_component.JCasMultiplier_ImplBase

org.apache.uima.fit.component.JCasMultiplier_ImplBase

de.tudarmstadt.ukp.dkpro.core.textnormalizer.casfilter.CasFilter_ImplBase

All Implemented Interfaces:

org.apache.uima.analysis_component.AnalysisComponent

public abstract class CasFilter_ImplBase
extends org.apache.uima.fit.component.JCasMultiplier_ImplBase

This class calls the pass() methods to determine whether a JCas should be filtered out or passed on in a pipeline. Therefore, the pass() method has to be implemented, returning true if a document should be passed on in the pipeline and false if it should be filtered out.

The filter (sub-)classes should be applied within a an AggregateBuilder applying a FlowController as in the createAggregateBuilderDescription(AnalysisEngineDescription...) method.

Note that methods such as SimplePipeline.runPipeline(org.apache.uima.cas.CAS, org.apache.uima.analysis_engine.AnalysisEngine...) and SimplePipeline.iteratePipeline(org.apache.uima.collection.CollectionReaderDescription, AnalysisEngineDescription...) do not allow direct access to the JCas' produced by a JCasMultiplier.

Constructor Summary

Constructors

Constructor and Description
CasFilter_ImplBase()

Method Summary

Modifier and Type	Method and Description
static org.apache.uima.analysis_engine.AnalysisEngineDescription	createAggregateBuilderDescription(org.apache.uima.analysis_engine.AnalysisEngineDescription... aEngines) Creates a new AnalysisEngineDescription from an Aggregrator that contains all input AnalysisEngineDescriptions in given order.
static org.apache.uima.analysis_engine.AnalysisEngineDescription	createAggregateBuilderDescription(List<org.apache.uima.analysis_engine.AnalysisEngineDescription> aEngines)
boolean	hasNext()
org.apache.uima.cas.AbstractCas	next()
protected abstract boolean	pass(org.apache.uima.jcas.JCas aJCas) This method determines whether a document / JCas is removed or retained.
void	process(org.apache.uima.jcas.JCas aJCas)

Methods inherited from class org.apache.uima.fit.component.JCasMultiplier_ImplBase

getLogger, initialize

Methods inherited from class org.apache.uima.analysis_component.JCasMultiplier_ImplBase

getCasInstancesRequired, getEmptyJCas, getRequiredCasInterface, process

Methods inherited from class org.apache.uima.analysis_component.AnalysisComponent_ImplBase

batchProcessComplete, collectionProcessComplete, destroy, getContext, getResultSpecification, reconfigure, setResultSpecification

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CasFilter_ImplBase

public CasFilter_ImplBase()

Method Detail

hasNext

public boolean hasNext()
                throws org.apache.uima.analysis_engine.AnalysisEngineProcessException

Throws:

org.apache.uima.analysis_engine.AnalysisEngineProcessException

next

public org.apache.uima.cas.AbstractCas next()
                                     throws org.apache.uima.analysis_engine.AnalysisEngineProcessException

Throws:

org.apache.uima.analysis_engine.AnalysisEngineProcessException

process

public void process(org.apache.uima.jcas.JCas aJCas)
             throws org.apache.uima.analysis_engine.AnalysisEngineProcessException

Specified by:

process in class org.apache.uima.analysis_component.JCasMultiplier_ImplBase

Throws:

org.apache.uima.analysis_engine.AnalysisEngineProcessException

pass

protected abstract boolean pass(org.apache.uima.jcas.JCas aJCas)

This method determines whether a document / JCas is removed or retained. If this method returns true, the document is retained, if it returns false, it is removed.

Parameters:

aJCas - the currently processed JCas

Returns:

true if the document is to be retained, false if it is to be removed

createAggregateBuilderDescription

public static org.apache.uima.analysis_engine.AnalysisEngineDescription createAggregateBuilderDescription(org.apache.uima.analysis_engine.AnalysisEngineDescription... aEngines)
                                                                                                   throws org.apache.uima.resource.ResourceInitializationException

Creates a new AnalysisEngineDescription from an Aggregrator that contains all input AnalysisEngineDescriptions in given order. This is intended for the use of a filter like CasFilter_ImplBase; all subsequent analysis engines will only see the documents that have passed the filter.

Parameters:

aEngines - AnalysisEngineDescriptions that should be aggregated.

Returns:

a single AnalysisEngineDescription aggregating all the input engines.

Throws:

org.apache.uima.resource.ResourceInitializationException - if any input analysis engine cannot be initialized

createAggregateBuilderDescription

public static org.apache.uima.analysis_engine.AnalysisEngineDescription createAggregateBuilderDescription(List<org.apache.uima.analysis_engine.AnalysisEngineDescription> aEngines)
                                                                                                   throws org.apache.uima.resource.ResourceInitializationException

Parameters:

aEngines - a list of AnalysisEngineDescriptions

Returns:

a single AnalysisEngineDescription aggregating all the input engines.

Throws:

org.apache.uima.resource.ResourceInitializationException - if any input analysis engine cannot be initialized

See Also:

createAggregateBuilderDescription(AnalysisEngineDescription...)