eu.project.ttc.engines.cleaner

Class AbstractTermIndexCleaner

java.lang.Object

org.apache.uima.analysis_component.AnalysisComponent_ImplBase

org.apache.uima.analysis_component.Annotator_ImplBase

org.apache.uima.analysis_component.JCasAnnotator_ImplBase

org.apache.uima.fit.component.JCasAnnotator_ImplBase

eu.project.ttc.engines.cleaner.AbstractTermIndexCleaner

All Implemented Interfaces:

org.apache.uima.analysis_component.AnalysisComponent

Direct Known Subclasses:

MaxSizeThresholdCleaner, TermIndexThresholdCleaner, TermIndexTopNCleaner

public abstract class AbstractTermIndexCleaner
extends org.apache.uima.fit.component.JCasAnnotator_ImplBase

An abstract AE for TermIndex post-processing cleaning based on a property.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLEANING_PERIOD
static java.lang.String	CLEANING_PROPERTY
protected int	cleaningPeriod
static java.lang.String	KEEP_VARIANTS
protected boolean	keepVariants
static java.lang.String	NUM_TERMS_CLEANING_TRIGGER
protected int	numTermsCleaningTrigger
static java.lang.String	PERIODIC_CAS_CLEAN_ON
protected boolean	periodicCasClean
protected TermProperty	property
protected TermIndexResource	termIndexResource

Constructor Summary

Constructors

Constructor and Description
AbstractTermIndexCleaner()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	clean()
void	collectionProcessComplete()
protected abstract void	doCleaningPartition(java.util.Set<Term> keptTerms, java.util.Set<Term> removedTerms) Does the specialized cleaning job (on which the logic for variant keeping will apply)
void	initialize(org.apache.uima.UimaContext context)
void	process(org.apache.uima.jcas.JCas aJCas)

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

getLogger

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, destroy, getContext, getResultSpecification, reconfigure, setResultSpecification

Methods inherited from class java.lang.Object

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

Field Detail

termIndexResource

protected TermIndexResource termIndexResource

CLEANING_PROPERTY

public static final java.lang.String CLEANING_PROPERTY

See Also:

Constant Field Values

property

protected TermProperty property

KEEP_VARIANTS

public static final java.lang.String KEEP_VARIANTS

See Also:

Constant Field Values

keepVariants

protected boolean keepVariants

PERIODIC_CAS_CLEAN_ON

public static final java.lang.String PERIODIC_CAS_CLEAN_ON

See Also:

Constant Field Values

periodicCasClean

protected boolean periodicCasClean

CLEANING_PERIOD

public static final java.lang.String CLEANING_PERIOD

See Also:

Constant Field Values

cleaningPeriod

protected int cleaningPeriod

NUM_TERMS_CLEANING_TRIGGER

public static final java.lang.String NUM_TERMS_CLEANING_TRIGGER

See Also:

Constant Field Values

numTermsCleaningTrigger

protected int numTermsCleaningTrigger

Constructor Detail

AbstractTermIndexCleaner

public AbstractTermIndexCleaner()

Method Detail

initialize

public void initialize(org.apache.uima.UimaContext context)
                throws org.apache.uima.resource.ResourceInitializationException

Specified by:

initialize in interface org.apache.uima.analysis_component.AnalysisComponent

Overrides:

initialize in class org.apache.uima.fit.component.JCasAnnotator_ImplBase

Throws:

org.apache.uima.resource.ResourceInitializationException

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.JCasAnnotator_ImplBase

Throws:

org.apache.uima.analysis_engine.AnalysisEngineProcessException

collectionProcessComplete

public void collectionProcessComplete()
                               throws org.apache.uima.analysis_engine.AnalysisEngineProcessException

Specified by:

collectionProcessComplete in interface org.apache.uima.analysis_component.AnalysisComponent

Overrides:

collectionProcessComplete in class org.apache.uima.analysis_component.AnalysisComponent_ImplBase

Throws:

org.apache.uima.analysis_engine.AnalysisEngineProcessException

clean

protected void clean()

doCleaningPartition

protected abstract void doCleaningPartition(java.util.Set<Term> keptTerms,
                       java.util.Set<Term> removedTerms)

Does the specialized cleaning job (on which the logic for variant keeping will apply)

Parameters:

keptTerms - The set of terms to keep in index (to be fill by implementor)

removedTerms - The set of terms to remove index (to be fill by implementor)