de.tudarmstadt.ukp.dkpro.core.frequency.tfidf

Class TfidfAnnotator

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

de.tudarmstadt.ukp.dkpro.core.frequency.tfidf.TfidfAnnotator

All Implemented Interfaces:

org.apache.uima.analysis_component.AnalysisComponent

public class TfidfAnnotator
extends org.apache.uima.fit.component.JCasAnnotator_ImplBase

This component adds Tfidf annotations consisting of a term and a tfidf weight.
The annotator is type agnostic concerning the input annotation, so you have to specify the annotation type and string representation. It uses a pre-serialized DfStore, which can be created using the TfidfConsumer.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TfidfAnnotator.WeightingModeIdf Available modes for inverse document frequency
static class	TfidfAnnotator.WeightingModeTf Available modes for term frequency

Field Summary

Fields

Modifier and Type	Field and Description
protected String	featurePath
protected boolean	lowercase
static String	PARAM_FEATURE_PATH This annotator is type agnostic, so it is mandatory to specify the type of the working annotation and how to obtain the string representation with the feature path.
static String	PARAM_IDF_MODE The model for inverse document frequency weighting. Invoke toString() on an enum of TfidfAnnotator.WeightingModeIdf for setup.
static String	PARAM_LOWERCASE If set to true, the whole text is handled in lower case.
static String	PARAM_TF_MODE The model for term frequency weighting. Invoke toString() on an enum of TfidfAnnotator.WeightingModeTf for setup.
static String	PARAM_TFDF_PATH Provide the path to the Df-Model.

Constructor Summary

Constructors

Constructor and Description
TfidfAnnotator()

Method Summary

Modifier and Type	Method and Description
protected FreqDist<String>	getTermFrequencies(org.apache.uima.jcas.JCas jcas)
void	initialize(org.apache.uima.UimaContext context)
void	process(org.apache.uima.jcas.JCas jcas)

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, collectionProcessComplete, 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

PARAM_FEATURE_PATH

public static final String PARAM_FEATURE_PATH

This annotator is type agnostic, so it is mandatory to specify the type of the working annotation and how to obtain the string representation with the feature path.

See Also:

Constant Field Values

featurePath

protected String featurePath

PARAM_TFDF_PATH

public static final String PARAM_TFDF_PATH

Provide the path to the Df-Model. When a shared SharedDfModel is bound to this annotator, this is ignored.

See Also:

Constant Field Values

PARAM_LOWERCASE

public static final String PARAM_LOWERCASE

If set to true, the whole text is handled in lower case.

See Also:

Constant Field Values

lowercase

protected boolean lowercase

PARAM_TF_MODE

public static final String PARAM_TF_MODE

The model for term frequency weighting.
Invoke toString() on an enum of TfidfAnnotator.WeightingModeTf for setup.

Default value is "NORMAL" yielding an unweighted tf.

See Also:

Constant Field Values

PARAM_IDF_MODE

public static final String PARAM_IDF_MODE

The model for inverse document frequency weighting.
Invoke toString() on an enum of TfidfAnnotator.WeightingModeIdf for setup.

Default value is "NORMAL" yielding an unweighted idf.

See Also:

Constant Field Values

Constructor Detail

TfidfAnnotator

public TfidfAnnotator()

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

getTermFrequencies

protected FreqDist<String> getTermFrequencies(org.apache.uima.jcas.JCas jcas)
                                       throws org.apache.uima.analysis_engine.AnalysisEngineProcessException

Throws:

org.apache.uima.analysis_engine.AnalysisEngineProcessException