org.sindice.siren.index.codecs.block

Class BlockIndexInput.BlockReader

java.lang.Object

org.sindice.siren.index.codecs.block.BlockIndexInput.BlockReader

Direct Known Subclasses:

DocsFreqBlockIndexInput.DocsFreqBlockReader, NodBlockIndexInput.NodBlockReader, PosBlockIndexInput.PosBlockReader

Enclosing class:

BlockIndexInput

protected abstract class BlockIndexInput.BlockReader
extends Object

Abstraction over the reader of the blocks of the postings file.

The abstraction provides an interface to iterate over the blocks. Subclasses must implement an interface to iterate over the data within a block.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.lucene.store.IndexInput	in Each block reader should have their own clone of the IndexInput

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BlockIndexInput.BlockReader(org.apache.lucene.store.IndexInput in)

Method Summary

Methods

Modifier and Type	Method and Description
protected int	getMinimumBufferSize(int bufferSize, int windowSize) Compute the minimum size of a buffer based on the required size and the decompression window size.
void	init() Init reader
protected abstract void	initBlock() Init reader for new block
abstract boolean	isExhausted()
void	nextBlock() Move to the next block and decode block header
protected abstract void	readHeader() Read and decode block header
void	seek(long fp)
protected abstract void	skipData() Skip remaining data in the block and advance input stream pointer.

Methods inherited from class java.lang.Object

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

Field Detail

in

protected final org.apache.lucene.store.IndexInput in

Each block reader should have their own clone of the IndexInput

Constructor Detail

BlockIndexInput.BlockReader

protected BlockIndexInput.BlockReader(org.apache.lucene.store.IndexInput in)

Method Detail

init

public void init()

Init reader

nextBlock

public void nextBlock()
               throws IOException

Move to the next block and decode block header

Throws:

IOException

initBlock

protected abstract void initBlock()

Init reader for new block

isExhausted

public abstract boolean isExhausted()

readHeader

protected abstract void readHeader()
                            throws IOException

Read and decode block header

Throws:

IOException

skipData

protected abstract void skipData()
                          throws IOException

Skip remaining data in the block and advance input stream pointer.

Throws:

IOException

seek

public void seek(long fp)

getMinimumBufferSize

protected int getMinimumBufferSize(int bufferSize,
                       int windowSize)

Compute the minimum size of a buffer based on the required size and the decompression window size.