org.terrier.realtime.multi

Class MultiLexiconEntry

java.lang.Object

org.terrier.structures.LexiconEntry

org.terrier.realtime.multi.MultiLexiconEntry

All Implemented Interfaces:

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

public class MultiLexiconEntry
extends LexiconEntry

A Lexicon entry that spans multiple index shards. It wraps around multiple lexicon entries from different index shards.

Since:

4.0

Author:

Richard McCreadie, Stuart Mackie

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MultiLexiconEntry(LexiconEntry[] le) Constructor.

Method Summary

Modifier and Type	Method and Description
void	add(EntryStatistics e) Not implemented.
LexiconEntry[]	getChildren() Return LexiconEntry's.
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	getMaxFrequencyInDocuments()
int	getNumberOfEntries() Returns number of "things" that this pointer refers to
int	getTermId() Not implemented.
String	pointerToString() Not implemented.
void	readFields(DataInput arg0) Not implemented.
void	setDocumentFrequency(int nt)
void	setFrequency(int F)
void	setMaxFrequencyInDocuments(int max)
void	setNumberOfEntries(int n) Not implemented.
void	setPointer(Pointer p) Not implemented.
void	setStatistics(int n_t, int TF) Not implemented.
void	setTermId(int newTermId) Not implemented.
void	subtract(EntryStatistics e) Not implemented.
void	write(DataOutput arg0) Not implemented.

Methods inherited from class org.terrier.structures.LexiconEntry

equals, getWritableEntryStatistics, hashCode, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiLexiconEntry

public MultiLexiconEntry(LexiconEntry[] le)

Constructor.

Method Detail

getChildren

public LexiconEntry[] getChildren()

Return LexiconEntry's.

getFrequency

public int getFrequency()

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

getDocumentFrequency

public int getDocumentFrequency()

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

getNumberOfEntries

public int getNumberOfEntries()

Returns number of "things" that this pointer refers to

Specified by:

getNumberOfEntries in interface Pointer

Overrides:

getNumberOfEntries in class LexiconEntry

getTermId

public int getTermId()

Not implemented.

add

public void add(EntryStatistics e)

Not implemented.

subtract

public void subtract(EntryStatistics e)

Not implemented.

setNumberOfEntries

public void setNumberOfEntries(int n)

Not implemented.

Specified by:

setNumberOfEntries in interface Pointer

Overrides:

setNumberOfEntries in class LexiconEntry

pointerToString

public String pointerToString()

Not implemented.

Specified by:

pointerToString in interface Pointer

Overrides:

pointerToString in class LexiconEntry

setPointer

public void setPointer(Pointer p)

Not implemented.

Specified by:

setPointer in interface Pointer

Overrides:

setPointer in class LexiconEntry

Parameters:

p - other pointer to update the pointer in this object

readFields

public void readFields(DataInput arg0)
                throws IOException

Not implemented.

Throws:

IOException

write

public void write(DataOutput arg0)
           throws IOException

Not implemented.

Throws:

IOException

setTermId

public void setTermId(int newTermId)

Not implemented.

Specified by:

setTermId in class LexiconEntry

setStatistics

public void setStatistics(int n_t,
                          int TF)

Not implemented.

Specified by:

setStatistics in class LexiconEntry

getMaxFrequencyInDocuments

public int getMaxFrequencyInDocuments()

setMaxFrequencyInDocuments

public void setMaxFrequencyInDocuments(int max)

setFrequency

public void setFrequency(int F)

setDocumentFrequency

public void setDocumentFrequency(int nt)