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

Class DfStore

java.lang.Object

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

All Implemented Interfaces:

DfModel, Serializable

public class DfStore
extends Object
implements DfModel, Serializable

Container that stores the document frequency and additional data in a collection of documents. To be filled and serialized by TfIdfWriter and deserialized and used by TfIdfAnnotator.

See Also:

Serialized Form

Field Summary

Fields inherited from interface de.tudarmstadt.ukp.dkpro.core.frequency.tfidf.model.DfModel

FILE_NAME

Constructor Summary

Constructors

Constructor and Description
DfStore()
DfStore(String featurePath, boolean convertToLowercase)

Method Summary

Modifier and Type	Method and Description
void	closeCurrentDocument() Call this method when processing of document is over.
void	countTerm(String term)
int	getDf(String term) Returns the number of documents, in which the term appears.
int	getDocumentCount()
String	getFeaturePath()
boolean	getLowercase()
void	registerNewDocument() Call this method when starting processing a new document.

Methods inherited from class java.lang.Object

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

Constructor Detail

DfStore

public DfStore()

DfStore

public DfStore(String featurePath,
               boolean convertToLowercase)

Method Detail

registerNewDocument

public void registerNewDocument()

Call this method when starting processing a new document.

countTerm

public void countTerm(String term)

closeCurrentDocument

public void closeCurrentDocument()

Call this method when processing of document is over.

getDf

public int getDf(String term)

Description copied from interface: DfModel

Returns the number of documents, in which the term appears.

Specified by:

getDf in interface DfModel

Parameters:

term - a term.

Returns:

document frequency

getDocumentCount

public int getDocumentCount()

Specified by:

getDocumentCount in interface DfModel

Returns:

the total number of documents taken into account in this model.

getFeaturePath

public String getFeaturePath()

Specified by:

getFeaturePath in interface DfModel

Returns:

the feature path of the type which was used to create the df_model.

getLowercase

public boolean getLowercase()

Specified by:

getLowercase in interface DfModel

Returns:

if the model was created using strings converted to lowercase