org.apache.lucene.codecs.uniformsplit

Class BlockLine

java.lang.Object

org.apache.lucene.codecs.uniformsplit.BlockLine

All Implemented Interfaces:

Accountable

Direct Known Subclasses:

STBlockLine

public class BlockLine
extends Object
implements Accountable

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(org.apache.lucene.store.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()).

WARNING: This API is experimental and might change in incompatible ways in the next release.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BlockLine.Serializer Reads/writes 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

Fields inherited from interface org.apache.lucene.util.Accountable

NULL_ACCOUNTABLE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BlockLine(TermBytes termBytes, BlockTermState termState) Constructor used for writing a BlockLine.
protected	BlockLine(TermBytes termBytes, int termStateRelativeOffset) Constructor used for reading 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

Methods inherited from interface org.apache.lucene.util.Accountable

getChildResources

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.

BlockLine

protected BlockLine(TermBytes termBytes,
                    int termStateRelativeOffset)

Constructor used for reading 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 TermState bytes in the block, relatively to the term states base offset.

ramBytesUsed

public long ramBytesUsed()

Specified by:

ramBytesUsed in interface Accountable