org.apache.lucene.codecs

Class BlockTreeTermsWriter

java.lang.Object

org.apache.lucene.codecs.FieldsConsumer

org.apache.lucene.codecs.BlockTreeTermsWriter

All Implemented Interfaces:

Closeable

public class BlockTreeTermsWriter
extends FieldsConsumer

Block-based terms index and dictionary writer.

Writes terms dict and index, block-encoding (column stride) each term's metadata for each set of terms between two index terms.

See Also:

BlockTreeTermsReader

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_BLOCK_SIZE Suggested default value for the maxItemsInBlock parameter to BlockTreeTermsWriter(SegmentWriteState,PostingsWriterBase,int,int).
static int	DEFAULT_MIN_BLOCK_SIZE Suggested default value for the minItemsInBlock parameter to BlockTreeTermsWriter(SegmentWriteState,PostingsWriterBase,int,int).
static int	TERMS_INDEX_VERSION_CURRENT Current index format.
static int	TERMS_INDEX_VERSION_START Initial index format.
static int	TERMS_VERSION_CURRENT Current terms format.
static int	TERMS_VERSION_START Initial terms format.

Constructor Summary

Constructors

Constructor and Description
BlockTreeTermsWriter(SegmentWriteState state, PostingsWriterBase postingsWriter, int minItemsInBlock, int maxItemsInBlock) Create a new writer.

Method Summary

Methods

Modifier and Type	Method and Description
TermsConsumer	addField(FieldInfo field) Add a new field
void	close() Called when we are done adding everything.
protected void	writeHeader(IndexOutput out) Writes the terms file header.
protected void	writeIndexHeader(IndexOutput out) Writes the index file header.
protected void	writeIndexTrailer(IndexOutput indexOut, long dirStart) Writes the index file trailer.
protected void	writeTrailer(IndexOutput out, long dirStart) Writes the terms file trailer.

Methods inherited from class org.apache.lucene.codecs.FieldsConsumer

merge

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MIN_BLOCK_SIZE

public static final int DEFAULT_MIN_BLOCK_SIZE

Suggested default value for the minItemsInBlock parameter to BlockTreeTermsWriter(SegmentWriteState,PostingsWriterBase,int,int).

See Also:

Constant Field Values

DEFAULT_MAX_BLOCK_SIZE

public static final int DEFAULT_MAX_BLOCK_SIZE

Suggested default value for the maxItemsInBlock parameter to BlockTreeTermsWriter(SegmentWriteState,PostingsWriterBase,int,int).

See Also:

Constant Field Values

TERMS_VERSION_START

public static final int TERMS_VERSION_START

Initial terms format.

See Also:

Constant Field Values

TERMS_VERSION_CURRENT

public static final int TERMS_VERSION_CURRENT

Current terms format.

See Also:

Constant Field Values

TERMS_INDEX_VERSION_START

public static final int TERMS_INDEX_VERSION_START

Initial index format.

See Also:

Constant Field Values

TERMS_INDEX_VERSION_CURRENT

public static final int TERMS_INDEX_VERSION_CURRENT

Current index format.

See Also:

Constant Field Values

Constructor Detail

BlockTreeTermsWriter

public BlockTreeTermsWriter(SegmentWriteState state,
                    PostingsWriterBase postingsWriter,
                    int minItemsInBlock,
                    int maxItemsInBlock)
                     throws IOException

Create a new writer. The number of items (terms or sub-blocks) per block will aim to be between minItemsPerBlock and maxItemsPerBlock, though in some cases the blocks may be smaller than the min.

Throws:

IOException

Method Detail

writeHeader

protected void writeHeader(IndexOutput out)
                    throws IOException

Writes the terms file header.

Throws:

IOException

writeIndexHeader

protected void writeIndexHeader(IndexOutput out)
                         throws IOException

Writes the index file header.

Throws:

IOException

writeTrailer

protected void writeTrailer(IndexOutput out,
                long dirStart)
                     throws IOException

Writes the terms file trailer.

Throws:

IOException

writeIndexTrailer

protected void writeIndexTrailer(IndexOutput indexOut,
                     long dirStart)
                          throws IOException

Writes the index file trailer.

Throws:

IOException

addField

public TermsConsumer addField(FieldInfo field)
                       throws IOException

Description copied from class: FieldsConsumer

Add a new field

Specified by:

addField in class FieldsConsumer

Throws:

IOException

close

public void close()
           throws IOException

Description copied from class: FieldsConsumer

Called when we are done adding everything.

Specified by:

close in interface Closeable

Specified by:

close in class FieldsConsumer

Throws:

IOException