de.tudarmstadt.ukp.dkpro.core.api.frequency.provider

Class FrequencyCountProviderBase

java.lang.Object

de.tudarmstadt.ukp.dkpro.core.api.frequency.provider.FrequencyCountProviderBase

All Implemented Interfaces:

FrequencyCountProvider

Direct Known Subclasses:

TestFrequencyCountProvider, Web1TProviderBase

public abstract class FrequencyCountProviderBase
extends Object
implements FrequencyCountProvider

Constructor Summary

Constructors

Constructor and Description
FrequencyCountProviderBase()

Method Summary

Modifier and Type	Method and Description
long	getFrequency(String phrase) Get frequency for a phrase
protected abstract long	getFrequencyFromProvider(String phrase)
String	getID() Returns an ID that identifies the frequency provider
double	getLogLikelihood(int termFrequency, int sizeOfCorpus, String term)
double	getLogProbability(String phrase) Get the log probability for a phrase
double	getProbability(String phrase) Get the probability (=normalized frequency) for a phrase. The frequency count is normalized by the number of phrases in the corpus.
int	getScaleDownFactor()
void	setScaleDownFactor(int scaleDownFactor)

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.tudarmstadt.ukp.dkpro.core.api.frequency.provider.FrequencyCountProvider

getLanguage, getNgramIterator, getNrOfDistinctNgrams, getNrOfNgrams, getNrOfTokens

Constructor Detail

FrequencyCountProviderBase

public FrequencyCountProviderBase()

Method Detail

getProbability

public double getProbability(String phrase)
                      throws IOException

Description copied from interface: FrequencyCountProvider

Get the probability (=normalized frequency) for a phrase.
The frequency count is normalized by the number of phrases in the corpus.

Specified by:

getProbability in interface FrequencyCountProvider

Parameters:

phrase - phrase to search

Returns:

probability (=normalized frequency) of the phrase. Returns null if the phrase does not exist in the corpus.

Throws:

IOException - if the information cannot be retrieved.

getLogProbability

public double getLogProbability(String phrase)
                         throws IOException

Description copied from interface: FrequencyCountProvider

Get the log probability for a phrase

Specified by:

getLogProbability in interface FrequencyCountProvider

Parameters:

phrase - phrase to search

Returns:

The log probability of the. Returns 0 if the phrase does not exist in the corpus.

Throws:

IOException - if the information cannot be retrieved.

getFrequency

public long getFrequency(String phrase)
                  throws IOException

Description copied from interface: FrequencyCountProvider

Get frequency for a phrase

Specified by:

getFrequency in interface FrequencyCountProvider

Parameters:

phrase - phrase to search

Returns:

frequency of the phrase. Returns 0 if the phrase does not exist in the corpus.

Throws:

IOException - if the information cannot be retrieved.

getFrequencyFromProvider

protected abstract long getFrequencyFromProvider(String phrase)
                                          throws IOException

Throws:

IOException

getLogLikelihood

public double getLogLikelihood(int termFrequency,
                               int sizeOfCorpus,
                               String term)
                        throws IOException

Throws:

IOException

getScaleDownFactor

public int getScaleDownFactor()

setScaleDownFactor

public void setScaleDownFactor(int scaleDownFactor)

getID

public String getID()
             throws IllegalArgumentException

Description copied from interface: FrequencyCountProvider

Returns an ID that identifies the frequency provider

Specified by:

getID in interface FrequencyCountProvider

Returns:

the ID.

Throws:

IllegalArgumentException