org.terrier.structures
Class BlockLexiconEntry

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

All Implemented Interfaces:

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

public class BlockLexiconEntry
extends BasicLexiconEntry
implements BlockEntryStatistics

Blocks lexicon entry. A basic lexicon entry with block statistics.

See Also:

Serialized Form

Nested Class Summary

static class

BlockLexiconEntry.Factory Factory for creating block lexicon entries

Field Summary

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

BlockLexiconEntry()
Construct an instance of the class.

BlockLexiconEntry(int tid, int n_t, int TF, byte fileId, BitFilePosition offset, int _blockCount)
Construct an instance of the class with

BlockLexiconEntry(int tid, int n_t, int TF, byte fileId, long _startOffset, byte _startBitOffset, int _blockCount)
Construct an instance of the class with

BlockLexiconEntry(int tid, int n_t, int TF, int _blockCount)
Construct an instance of the class with

Method Summary

void	add(EntryStatistics le) increment this lexicon entry by another
int	getBlockCount() The number of blocks that this term has.
void	readFields(java.io.DataInput in)
void	subtract(EntryStatistics le) alter this lexicon entry to subtract another 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, toString

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

Constructor Detail

BlockLexiconEntry

public BlockLexiconEntry()

Construct an instance of the class.

BlockLexiconEntry

public BlockLexiconEntry(int tid,
                         int n_t,
                         int TF,
                         byte fileId,
                         BitFilePosition offset,
                         int _blockCount)

Construct an instance of the class with

Parameters:

tid -

n_t -

TF -

fileId -

offset -

_blockCount -

BlockLexiconEntry

public BlockLexiconEntry(int tid,
                         int n_t,
                         int TF,
                         byte fileId,
                         long _startOffset,
                         byte _startBitOffset,
                         int _blockCount)

Construct an instance of the class with

Parameters:

tid -

n_t -

TF -

fileId -

_startOffset -

_startBitOffset -

_blockCount -

BlockLexiconEntry

public BlockLexiconEntry(int tid,
                         int n_t,
                         int TF,
                         int _blockCount)

Construct an instance of the class with

Parameters:

tid -

n_t -

TF -

_blockCount -

Method Detail

getBlockCount

public int getBlockCount()

The number of blocks that this term has. Needed by the BlockInvertedIndexBuilder.

Specified by:

getBlockCount in interface BlockEntryStatistics

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

add

public void add(EntryStatistics le)

increment this lexicon entry by another

Specified by:

add in interface EntryStatistics

Overrides:

add in class BasicLexiconEntry

subtract

public void subtract(EntryStatistics le)

alter this lexicon entry to subtract another lexicon entry

Specified by:

subtract in interface EntryStatistics

Overrides:

subtract in class BasicLexiconEntry