de.tudarmstadt.ukp.dkpro.core.frequency.phrasedetection

Class PhraseAnnotator

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.phrasedetection.PhraseAnnotator

All Implemented Interfaces:

org.apache.uima.analysis_component.AnalysisComponent

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

Annotate phrases in a sentence. Depending on the provided unigrams and the threshold, these comprise either one or two annotations (tokens, lemmas, ...).

In order to identify longer phrases, run the FrequencyCounter and this annotator multiple times, each time taking the results of the previous run as input. From the second run on, set phrases in the feature path parameter PARAM_FEATURE_PATH.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_COVERING_TYPE Set this parameter if bigrams should only be counted when occurring within a covering type, e.g.
static String	PARAM_DISCOUNT The discount in order to prevent too many phrases consisting of very infrequent words to be formed.
static String	PARAM_FEATURE_PATH The feature path to use for building bigrams.
static String	PARAM_FILTER_REGEX
static String	PARAM_LOWERCASE If true, lowercase everything.
static String	PARAM_MODEL_LOCATION The file providing the unigram and bigram unigrams to use.
static String	PARAM_REGEX_REPLACEMENT
static String	PARAM_STOPWORDS_FILE
static String	PARAM_STOPWORDS_REPLACEMENT
static String	PARAM_THRESHOLD The threshold score for phrase construction.

Constructor Summary

Constructors

Constructor and Description
PhraseAnnotator()

Method Summary

Modifier and Type	Method and Description
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, 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

The feature path to use for building bigrams. Default: tokens.

See Also:

Constant Field Values

PARAM_LOWERCASE

public static final String PARAM_LOWERCASE

If true, lowercase everything.

See Also:

Constant Field Values

PARAM_MODEL_LOCATION

public static final String PARAM_MODEL_LOCATION

The file providing the unigram and bigram unigrams to use.

See Also:

Constant Field Values

PARAM_DISCOUNT

public static final String PARAM_DISCOUNT

The discount in order to prevent too many phrases consisting of very infrequent words to be formed. A typical value is the minimum count set during model creation (FrequencyCounter.PARAM_MIN_COUNT), which is by default set to 5.

See Also:

Constant Field Values

PARAM_THRESHOLD

public static final String PARAM_THRESHOLD

The threshold score for phrase construction. Default is 100. Lower values result in fewer phrases. The value strongly depends on the size of the corpus and the token unigrams.

See Also:

Constant Field Values

PARAM_STOPWORDS_FILE

public static final String PARAM_STOPWORDS_FILE

See Also:

Constant Field Values

PARAM_STOPWORDS_REPLACEMENT

public static final String PARAM_STOPWORDS_REPLACEMENT

See Also:

Constant Field Values

PARAM_FILTER_REGEX

public static final String PARAM_FILTER_REGEX

See Also:

Constant Field Values

PARAM_REGEX_REPLACEMENT

public static final String PARAM_REGEX_REPLACEMENT

See Also:

Constant Field Values

PARAM_COVERING_TYPE

public static final String PARAM_COVERING_TYPE

Set this parameter if bigrams should only be counted when occurring within a covering type, e.g. sentences.

See Also:

Constant Field Values

Constructor Detail

PhraseAnnotator

public PhraseAnnotator()

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