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

Class SharedDfModel

java.lang.Object

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

All Implemented Interfaces:

DfModel, Serializable, org.apache.uima.resource.SharedResourceObject

public class SharedDfModel
extends Object
implements DfModel, org.apache.uima.resource.SharedResourceObject

Shared DfModel.

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
SharedDfModel()

Method Summary

Modifier and Type	Method and Description
static void	bindTo(org.apache.uima.analysis_engine.AnalysisEngineDescription aaed, String pathToResource, Object... params) Binds a DfModel to the given AnalysisEngineDescription.
int	getDf(String term) Returns the number of documents, in which the term appears.
int	getDocumentCount()
String	getFeaturePath()
boolean	getLowercase()
void	load(org.apache.uima.resource.DataResource aData)

Methods inherited from class java.lang.Object

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

Constructor Detail

SharedDfModel

public SharedDfModel()

Method Detail

bindTo

public static void bindTo(org.apache.uima.analysis_engine.AnalysisEngineDescription aaed,
                          String pathToResource,
                          Object... params)
                   throws org.apache.uima.util.InvalidXMLException,
                          MalformedURLException

Binds a DfModel to the given AnalysisEngineDescription. The model is deserialized from file stream.

Parameters:

aaed - An aggregate AnalysisEngineDescription. The binding does not work with primitive descriptions.

pathToResource - The path from where the resource is loaded.

params - Optional parameters.

Throws:

org.apache.uima.util.InvalidXMLException - if import resolution failed

MalformedURLException - if the specified path is invalid.

load

public void load(org.apache.uima.resource.DataResource aData)
          throws org.apache.uima.resource.ResourceInitializationException

Specified by:

load in interface org.apache.uima.resource.SharedResourceObject

Throws:

org.apache.uima.resource.ResourceInitializationException

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