cat.lump.aq.basics.structure.ir

Class TermFrequencyTuple

java.lang.Object

cat.lump.aq.basics.structure.ir.TermFrequencyTuple

All Implemented Interfaces:

java.lang.Comparable<TermFrequencyTuple>

public class TermFrequencyTuple
extends java.lang.Object
implements java.lang.Comparable<TermFrequencyTuple>

This class provides a term frequency abstraction. A term frequency object has the expression and the number of its occurrences in a set of phrases.

Author:

jboldoba

Constructor Summary

Constructors

Constructor and Description
TermFrequencyTuple(java.lang.String term) Constructor.
TermFrequencyTuple(java.lang.String term, int frequency) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(TermFrequencyTuple tf)
void	decrement() Decrements the number of occurrences of the term in one unit.
boolean	equals(java.lang.Object o)
int	getFrequency() Returns the number of occurrences of the term
java.lang.String	getTerm() Returns the associated term
void	increment() Increments the number of occurrences of the term in one unit.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TermFrequencyTuple

public TermFrequencyTuple(java.lang.String term,
                  int frequency)

Constructor. It initializes an instance with the term and an initial frequency.

Parameters:

term - The term

frequency - Initial frequency

TermFrequencyTuple

public TermFrequencyTuple(java.lang.String term)

Constructor. It initializes an instance with the indicated term and 0 occurrences.

Parameters:

term - The term

Method Detail

increment

public void increment()

Increments the number of occurrences of the term in one unit.

decrement

public void decrement()

Decrements the number of occurrences of the term in one unit.

compareTo

public int compareTo(TermFrequencyTuple tf)

Specified by:

compareTo in interface java.lang.Comparable<TermFrequencyTuple>

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

getTerm

public java.lang.String getTerm()

Returns the associated term

Returns:

The term

getFrequency

public int getFrequency()

Returns the number of occurrences of the term

Returns:

The frequency. (Number of occurrences of the term)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object