de.gwdg.metadataqa.api.uniqueness

Class TfIdf

java.lang.Object

de.gwdg.metadataqa.api.uniqueness.TfIdf

public class TfIdf
extends Object

A value object holding information about TF-IDF elements.

Author:

Péter Király

Constructor Summary

Constructors

Constructor and Description
TfIdf(String term, int tf, int df, double tfIdf) Creates the TF-IDF object.

Method Summary

Modifier and Type	Method and Description
int	getDf() Returns the document frequency (the number of documents the term occurs in).
String	getTerm() Returns the indexed term.
int	getTf() Returns term frequency (the number of times the term occurs in the field).
double	getTfIdf() Returns the TF-IDF number read from Apache Solr.
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

TfIdf

public TfIdf(String term,
             int tf,
             int df,
             double tfIdf)

Creates the TF-IDF object.

Parameters:

term - The indexed term

tf - Term frequency (the number of times the term occurs in the field).

df - Document frequency (the number of documents the term occurs in).

tfIdf - The TF-IDF number read from Apache Solr.

Method Detail

getTerm

public String getTerm()

Returns the indexed term.

Returns:

The indexed term

getTf

public int getTf()

Returns term frequency (the number of times the term occurs in the field).

Returns:

Term frequency (the number of times the term occurs in the field).

getDf

public int getDf()

Returns the document frequency (the number of documents the term occurs in).

Returns:

Document frequency (the number of documents the term occurs in).

getTfIdf

public double getTfIdf()

Returns the TF-IDF number read from Apache Solr.

Returns:

The TF-IDF number read from Apache Solr.

toString

public String toString()

Returns a string representation of the object.

Overrides:

toString in class Object

Returns:

The string representation