Package org.terrier.structures

Class SimpleBitIndexPointer

java.lang.Object

org.terrier.structures.SimpleBitIndexPointer

All Implemented Interfaces:

org.apache.hadoop.io.Writable, BitFilePosition, BitIndexPointer, Pointer

public class SimpleBitIndexPointer
extends java.lang.Object
implements BitIndexPointer, org.apache.hadoop.io.Writable

An implementation of a BitIndexPointer. Records a pointer in a BitIndex structure - i.e. a file number (0-31), a byte offset (long), a bit offset (0-8), and a number of entries (positive int).

Since:

3.0

Author:

Craig Macdonald

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SimpleBitIndexPointer.Factory	Factory class for SimpleBitIndexPointer.

Field Summary

Fields inherited from interface org.terrier.structures.BitIndexPointer

BIT_MASK, FILE_SHIFT, MAX_FILE_ID

Constructor Summary

Constructors

Constructor	Description
SimpleBitIndexPointer()	Construct an instance of the class.
SimpleBitIndexPointer(byte fileId, long byteOffset, byte bitOffset, int numEntries)	Construct an instance of the class with
SimpleBitIndexPointer(long byteOffset, byte bitOffset, int numEntries)	Construct an instance of the class with

Method Summary

Modifier and Type	Method	Description
byte	getFileNumber()
int	getNumberOfEntries()
long	getOffset()
byte	getOffsetBits()
java.lang.String	pointerToString()
void	readFields(java.io.DataInput arg0)	Populate this pointer from DataInput source
void	setBitIndexPointer(BitIndexPointer pointer)
void	setFileNumber(byte fileId)
void	setNumberOfEntries(int count)
void	setOffset(long _bytes, byte _bits)
void	setOffset(BitFilePosition pos)
void	setPointer(Pointer p)
java.lang.String	toString()	Debug friendly output of this pointer
void	write(java.io.DataOutput arg0)	Write this pointer to DataOutput

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

SimpleBitIndexPointer

public SimpleBitIndexPointer()

Construct an instance of the class.

SimpleBitIndexPointer

public SimpleBitIndexPointer(byte fileId, long byteOffset, byte bitOffset, int numEntries)

Construct an instance of the class with

Parameters:

fileId -

byteOffset -

bitOffset -

numEntries -

SimpleBitIndexPointer

public SimpleBitIndexPointer(long byteOffset, byte bitOffset, int numEntries)

Construct an instance of the class with

Parameters:

byteOffset -

bitOffset -

numEntries -

Method Details

getNumberOfEntries

public int getNumberOfEntries()

Specified by:

getNumberOfEntries in interface Pointer

setNumberOfEntries

public void setNumberOfEntries(int count)

Specified by:

setNumberOfEntries in interface Pointer

getOffsetBits

public byte getOffsetBits()

Specified by:

getOffsetBits in interface BitFilePosition

getFileNumber

public byte getFileNumber()

Specified by:

getFileNumber in interface BitIndexPointer

setFileNumber

public void setFileNumber(byte fileId)

Specified by:

setFileNumber in interface BitIndexPointer

getOffset

public long getOffset()

Specified by:

getOffset in interface BitFilePosition

setOffset

public void setOffset(long _bytes, byte _bits)

Specified by:

setOffset in interface BitFilePosition

setBitIndexPointer

public void setBitIndexPointer(BitIndexPointer pointer)

Specified by:

setBitIndexPointer in interface BitIndexPointer

setOffset

public void setOffset(BitFilePosition pos)

Specified by:

setOffset in interface BitFilePosition

readFields

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

Populate this pointer from DataInput source

Specified by:

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

Throws:

java.io.IOException

write

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

Write this pointer to DataOutput

Specified by:

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

Throws:

java.io.IOException

toString

public java.lang.String toString()

Debug friendly output of this pointer

Overrides:

toString in class java.lang.Object

pointerToString

public java.lang.String pointerToString()

Specified by:

pointerToString in interface Pointer

setPointer

public void setPointer(Pointer p)

Specified by:

setPointer in interface Pointer