org.sindice.siren.index.codecs.siren10

Class DocsFreqBlockIndexOutput.DocsFreqBlockWriter

java.lang.Object

org.sindice.siren.index.codecs.block.BlockIndexOutput.BlockWriter

org.sindice.siren.index.codecs.siren10.DocsFreqBlockIndexOutput.DocsFreqBlockWriter

Enclosing class:

DocsFreqBlockIndexOutput

public class DocsFreqBlockIndexOutput.DocsFreqBlockWriter
extends BlockIndexOutput.BlockWriter

Implementation of the BlockWriter for the .doc file.

Encode and write blocks containing the document identifiers and the node frequencies. It also encodes the pointers of the associated blocks from the .nod and .pos files into the block header.

This class must be associated to the Indexs of the NodBlockIndexOutput.NodBlockWriter and PosBlockIndexOutput.PosBlockWriter using #setNodeBlockIndex(Index) and #setPosBlockIndex(Index).

Constructor Summary

Constructors

Constructor and Description
DocsFreqBlockIndexOutput.DocsFreqBlockWriter()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	compress() Compress the data block
int	getFirstDocId()
int	getMaxBlockSize()
protected void	initBlock() Init writer for new block
boolean	isEmpty()
boolean	isFull()
void	setNodeBlockIndex(BlockIndexOutput.Index index) Set the Index of the NodBlockIndexOutput.
void	setPosBlockIndex(BlockIndexOutput.Index index) Set the Index of the PosBlockIndexOutput.
void	write(int docId) Add a document identifier to the buffer.
protected void	writeData() Write compressed data block to the output file
protected void	writeHeader() Write block header to the output file
void	writeNodeFreq(int nodeFreqInDoc) Add a node frenquency to the buffer.

Methods inherited from class org.sindice.siren.index.codecs.block.BlockIndexOutput.BlockWriter

flush, getMinimumBufferSize, writeBlock

Methods inherited from class java.lang.Object

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

Constructor Detail

DocsFreqBlockIndexOutput.DocsFreqBlockWriter

public DocsFreqBlockIndexOutput.DocsFreqBlockWriter()

Method Detail

getMaxBlockSize

public int getMaxBlockSize()

getFirstDocId

public int getFirstDocId()

setNodeBlockIndex

public void setNodeBlockIndex(BlockIndexOutput.Index index)
                       throws IOException

Set the Index of the NodBlockIndexOutput. The Index is used to read the current file pointer of the NodBlockIndexOutput when flushing a block.

Throws:

IOException

setPosBlockIndex

public void setPosBlockIndex(BlockIndexOutput.Index index)
                      throws IOException

Set the Index of the PosBlockIndexOutput. The Index is used to read the current file pointer of the PosBlockIndexOutput when flushing a block.

Throws:

IOException

write

public void write(int docId)
           throws IOException

Add a document identifier to the buffer.

Throws:

IOException

writeNodeFreq

public void writeNodeFreq(int nodeFreqInDoc)

Add a node frenquency to the buffer.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in class BlockIndexOutput.BlockWriter

isFull

public boolean isFull()

Specified by:

isFull in class BlockIndexOutput.BlockWriter

compress

protected void compress()

Description copied from class: BlockIndexOutput.BlockWriter

Compress the data block

Specified by:

compress in class BlockIndexOutput.BlockWriter

writeHeader

protected void writeHeader()
                    throws IOException

Description copied from class: BlockIndexOutput.BlockWriter

Write block header to the output file

Specified by:

writeHeader in class BlockIndexOutput.BlockWriter

Throws:

IOException

writeData

protected void writeData()
                  throws IOException

Description copied from class: BlockIndexOutput.BlockWriter

Write compressed data block to the output file

Specified by:

writeData in class BlockIndexOutput.BlockWriter

Throws:

IOException

initBlock

protected void initBlock()

Description copied from class: BlockIndexOutput.BlockWriter

Init writer for new block

Specified by:

initBlock in class BlockIndexOutput.BlockWriter