org.terrier.realtime.memory

Class MemoryLexiconEntry

java.lang.Object

org.terrier.structures.LexiconEntry

org.terrier.realtime.memory.MemoryLexiconEntry

All Implemented Interfaces:

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

Direct Known Subclasses:

MemoryFieldsLexiconEntry

public class MemoryLexiconEntry
extends LexiconEntry
implements MemoryPointer, Serializable

A lexicon entry stored in a MemoryLexicon. Implements MemoryPointer such that it can be used to look up posting lists in a MemoryInvertedIndex.

Since:

4.0

Author:

Richard McCreadie, Stuart Mackie

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MemoryLexiconEntry() Constructor.
MemoryLexiconEntry(int termid) Constructor (termid).
MemoryLexiconEntry(int df, int tf) Constructor (df, tf).
MemoryLexiconEntry(int termid, int df, int tf) Constructor (termid, df, tf).

Method Summary

Methods

Modifier and Type	Method and Description
void	add(EntryStatistics es) Increment the statistics of this object by that of another
MemoryLexiconEntry	clone()
int	getDocumentFrequency() The number of documents that the entry (term) occurred in
int	getFrequency() The frequency (total number of occurrences) of the entry (term).
int	getNumberOfEntries() Returns number of "things" that this pointer refers to
int	getPointer() Get pointer value (termid).
int	getTermId() The id of the term
String	pointerToString() Returns a textual representation of the pointer alone
void	readFields(DataInput arg0) Not implemented.
void	setNumberOfEntries(int df) Set the number of "things that the pointer refers to
void	setPointer(Pointer p) Sets the pointer within this object to that represented by the specified pointer
void	setStatistics(int df, int tf) Set the document frequency and term frequency
void	setTermId(int termid) Set the term ID
void	subtract(EntryStatistics es) Decrement the statistics of this object by that of another
void	write(DataOutput out) Not implemented.

Methods inherited from class org.terrier.structures.LexiconEntry

equals, getWritableEntryStatistics, hashCode, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MemoryLexiconEntry

public MemoryLexiconEntry()

Constructor.

MemoryLexiconEntry

public MemoryLexiconEntry(int termid)

Constructor (termid).

MemoryLexiconEntry

public MemoryLexiconEntry(int df,
                  int tf)

Constructor (df, tf).

MemoryLexiconEntry

public MemoryLexiconEntry(int termid,
                  int df,
                  int tf)

Constructor (termid, df, tf).

Method Detail

getTermId

public int getTermId()

The id of the term

Specified by:

getTermId in interface EntryStatistics

setTermId

public void setTermId(int termid)

Set the term ID

Specified by:

setTermId in class LexiconEntry

getDocumentFrequency

public int getDocumentFrequency()

The number of documents that the entry (term) occurred in

Specified by:

getDocumentFrequency in interface EntryStatistics

getFrequency

public int getFrequency()

The frequency (total number of occurrences) of the entry (term).

Specified by:

getFrequency in interface EntryStatistics

setStatistics

public void setStatistics(int df,
                 int tf)

Set the document frequency and term frequency

Specified by:

setStatistics in class LexiconEntry

add

public void add(EntryStatistics es)

Increment the statistics of this object by that of another

Specified by:

add in interface EntryStatistics

subtract

public void subtract(EntryStatistics es)

Decrement the statistics of this object by that of another

Specified by:

subtract in interface EntryStatistics

getNumberOfEntries

public int getNumberOfEntries()

Returns number of "things" that this pointer refers to

Specified by:

getNumberOfEntries in interface Pointer

Overrides:

getNumberOfEntries in class LexiconEntry

setNumberOfEntries

public void setNumberOfEntries(int df)

Set the number of "things that the pointer refers to

Specified by:

setNumberOfEntries in interface Pointer

Overrides:

setNumberOfEntries in class LexiconEntry

getPointer

public int getPointer()

Get pointer value (termid).

Specified by:

getPointer in interface MemoryPointer

setPointer

public void setPointer(Pointer p)

Sets the pointer within this object to that represented by the specified pointer

Specified by:

setPointer in interface Pointer

Overrides:

setPointer in class LexiconEntry

Parameters:

p - other pointer to update the pointer in this object

pointerToString

public String pointerToString()

Returns a textual representation of the pointer alone

Specified by:

pointerToString in interface Pointer

Overrides:

pointerToString in class LexiconEntry

readFields

public void readFields(DataInput arg0)
                throws IOException

Not implemented.

Specified by:

readFields in interface org.apache.hadoop.io.Writable

Throws:

IOException

write

public void write(DataOutput out)
           throws IOException

Not implemented.

Specified by:

write in interface org.apache.hadoop.io.Writable

Throws:

IOException

clone

public MemoryLexiconEntry clone()

Overrides:

clone in class Object