org.apache.lucene.codecs.uniformsplit

Class BlockLine

java.lang.Object

org.apache.lucene.codecs.uniformsplit.BlockLine

Direct Known Subclasses:

STBlockLine

public class BlockLine
extends java.lang.Object

One term block line.

Contains a term and its details as a BlockTermState.

The line is written to the block file in two parts. The first part is the term followed by an offset to the details region. The second part is the term BlockTermState, written in the details region, after all the terms of the block.

The separate details region allows fast scan of the terms without having to decode the details for each term. At read time, the BlockLine.Serializer.readLine(DataInput, boolean, org.apache.lucene.codecs.uniformsplit.BlockLine) only reads the term and its offset to the details. The corresponding BlockTermState is decoded on demand in the BlockReader (see BlockReader.readTermStateIfNotRead()).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BlockLine.Serializer Reads block lines with terms encoded incrementally inside a block.

Field Summary

Fields

Modifier and Type	Field and Description
protected TermBytes	termBytes
protected BlockTermState	termState Only used for writing.
protected int	termStateRelativeOffset

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BlockLine(TermBytes termBytes, BlockTermState termState) Constructor used for writing a BlockLine.

Method Summary

Modifier and Type	Method and Description
TermBytes	getTermBytes()
int	getTermStateRelativeOffset()
long	ramBytesUsed()
protected BlockLine	reset(TermBytes termBytes, int termStateRelativeOffset) Resets this BlockLine to reuse it when reading.

Methods inherited from class java.lang.Object

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

Field Detail

termBytes

protected TermBytes termBytes

termStateRelativeOffset

protected int termStateRelativeOffset

termState

protected final BlockTermState termState

Only used for writing.

Constructor Detail

BlockLine

protected BlockLine(TermBytes termBytes,
                    BlockTermState termState)

Constructor used for writing a BlockLine.

Method Detail

reset

protected BlockLine reset(TermBytes termBytes,
                          int termStateRelativeOffset)

Resets this BlockLine to reuse it when reading.

getTermBytes

public TermBytes getTermBytes()

getTermStateRelativeOffset

public int getTermStateRelativeOffset()

Returns:

The offset of the org.apache.lucene.index.TermState bytes in the block, relatively to the term states base offset.

ramBytesUsed

public long ramBytesUsed()