org.terrier.structures
Class FieldLexiconEntry

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

All Implemented Interfaces:

java.io.Serializable, org.apache.hadoop.io.Writable, BitFilePosition, BitIndexPointer, EntryStatistics, FieldEntryStatistics, Pointer

public class FieldLexiconEntry
extends BasicLexiconEntry
implements FieldEntryStatistics

A LexiconEntry with field support

See Also:

Serialized Form

Nested Class Summary

static class

FieldLexiconEntry.Factory Factory for a LexiconEntry

Field Summary

protected int[]

fieldFrequencies

Fields inherited from class org.terrier.structures.BasicLexiconEntry

n_t, startBitOffset, startOffset, termId, TF

Fields inherited from interface org.terrier.structures.BitIndexPointer

BIT_MASK, FILE_SHIFT, MAX_FILE_ID

Constructor Summary

FieldLexiconEntry(int fieldCount)
Construct an instance of the class with

FieldLexiconEntry(int[] _fieldFrequencies)
Construct an instance of the class with

Method Summary

void	add(EntryStatistics le) increment this lexicon entry by another
int[]	getFieldFrequencies() Get the frequencies for each field
void	readFields(java.io.DataInput in)
void	setFieldFrequencies(int[] _fieldFrequencices) Set the frequencies for each field
java.lang.String	toString() returns a string representation of this lexicon entry
void	write(java.io.DataOutput out)

Methods inherited from class org.terrier.structures.BasicLexiconEntry

getDocumentFrequency, getFileNumber, getFrequency, getNumberOfEntries, getOffset, getOffsetBits, getTermId, pointerToString, setBitIndexPointer, setFileNumber, setNumberOfEntries, setOffset, setOffset, setPointer, setStatistics, setTermId, subtract

Methods inherited from class org.terrier.structures.LexiconEntry

equals, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.terrier.structures.EntryStatistics

getDocumentFrequency, getFrequency, getTermId, subtract

Field Detail

fieldFrequencies

protected final int[] fieldFrequencies

Constructor Detail

FieldLexiconEntry

public FieldLexiconEntry(int fieldCount)

Construct an instance of the class with

Parameters:

fieldCount -

FieldLexiconEntry

public FieldLexiconEntry(int[] _fieldFrequencies)

Construct an instance of the class with

Parameters:

_fieldFrequencies -

Method Detail

getFieldFrequencies

public int[] getFieldFrequencies()

Get the frequencies for each field

Specified by:

getFieldFrequencies in interface FieldEntryStatistics

setFieldFrequencies

public void setFieldFrequencies(int[] _fieldFrequencices)

Set the frequencies for each field

readFields

public void readFields(java.io.DataInput in)
                throws java.io.IOException

Description copied from class: BasicLexiconEntry

Specified by:

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

Overrides:

readFields in class BasicLexiconEntry

Throws:

java.io.IOException

write

public void write(java.io.DataOutput out)
           throws java.io.IOException

Description copied from class: BasicLexiconEntry

Specified by:

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

Overrides:

write in class BasicLexiconEntry

Throws:

java.io.IOException

toString

public java.lang.String toString()

Description copied from class: BasicLexiconEntry

returns a string representation of this lexicon entry

Overrides:

toString in class BasicLexiconEntry

add

public void add(EntryStatistics le)

Description copied from class: BasicLexiconEntry

increment this lexicon entry by another

Specified by:

add in interface EntryStatistics

Overrides:

add in class BasicLexiconEntry