org.terrier.structures
Class LexiconEntry

java.lang.Object
  org.terrier.structures.LexiconEntry

All Implemented Interfaces:

java.io.Serializable, org.apache.hadoop.io.Writable, EntryStatistics, Pointer

Direct Known Subclasses:

BasicLexiconEntry, BasicTermStatsLexiconEntry

public abstract class LexiconEntry
extends java.lang.Object
implements EntryStatistics, Pointer, org.apache.hadoop.io.Writable

Represents the statistics of a term in the Lexicon, and a pointer to the term's location in the InvertedIndex. For these reasons, this class implements Pointer and EntryStatistics.

Author:

Craig Macdonald

See Also:

Lexicon, Pointer, EntryStatistics, Serialized Form

Constructor Summary

LexiconEntry()

Method Summary

boolean	equals(java.lang.Object obj)
int	hashCode()
abstract void	setStatistics(int n_t, int TF) Set the document frequency and term frequency
abstract void	setTermId(int newTermId) Set the term ID
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.terrier.structures.EntryStatistics

add, getDocumentFrequency, getFrequency, getTermId, subtract

Methods inherited from interface org.terrier.structures.Pointer

getNumberOfEntries, pointerToString, setNumberOfEntries, setPointer

Methods inherited from interface org.apache.hadoop.io.Writable

readFields, write

Constructor Detail

LexiconEntry

public LexiconEntry()

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setTermId

public abstract void setTermId(int newTermId)

Set the term ID

setStatistics

public abstract void setStatistics(int n_t,
                                   int TF)

Set the document frequency and term frequency

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object