Module org.apache.lucene.sandbox

Package org.apache.lucene.sandbox.codecs.idversion

Class VersionBlockTreeTermsWriter

java.lang.Object

org.apache.lucene.codecs.FieldsConsumer

org.apache.lucene.sandbox.codecs.idversion.VersionBlockTreeTermsWriter

All Implemented Interfaces:

Closeable, AutoCloseable

public final class VersionBlockTreeTermsWriter
extends FieldsConsumer

This is just like Lucene90BlockTreeTermsWriter, except it also stores a version per term, and adds a method to its TermsEnum implementation to seekExact only if the version is >= the specified version. The version is added to the terms index to avoid seeking if no term in the block has a high enough version. The term blocks file is .tiv and the terms index extension is .tipv.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	VersionBlockTreeTermsWriter.FieldMetaData
private static final class	VersionBlockTreeTermsWriter.PendingBlock
private static class	VersionBlockTreeTermsWriter.PendingEntry
private static final class	VersionBlockTreeTermsWriter.PendingTerm
(package private) class	VersionBlockTreeTermsWriter.TermsWriter

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	closed
static final int	DEFAULT_MAX_BLOCK_SIZE	Suggested default value for the maxItemsInBlock parameter to VersionBlockTreeTermsWriter(SegmentWriteState,PostingsWriterBase,int,int).
static final int	DEFAULT_MIN_BLOCK_SIZE	Suggested default value for the minItemsInBlock parameter to VersionBlockTreeTermsWriter(SegmentWriteState,PostingsWriterBase,int,int).
(package private) final FieldInfos	fieldInfos
private final List<VersionBlockTreeTermsWriter.FieldMetaData>	fields
(package private) static final PairOutputs<BytesRef,Long>	FST_OUTPUTS
private final IndexOutput	indexOut
(package private) final int	maxDoc
(package private) final int	maxItemsInBlock
(package private) final int	minItemsInBlock
(package private) static final PairOutputs.Pair<BytesRef,Long>	NO_OUTPUT
private final IndexOutput	out
(package private) static final int	OUTPUT_FLAG_HAS_TERMS
(package private) static final int	OUTPUT_FLAG_IS_FLOOR
(package private) static final int	OUTPUT_FLAGS_MASK
(package private) static final int	OUTPUT_FLAGS_NUM_BITS
(package private) final PostingsWriterBase	postingsWriter
private final ByteBuffersDataOutput	scratchBytes
private final IntsRefBuilder	scratchIntsRef
(package private) static final String	TERMS_CODEC_NAME
(package private) static final String	TERMS_EXTENSION	Extension of terms file
(package private) static final String	TERMS_INDEX_CODEC_NAME
(package private) static final String	TERMS_INDEX_EXTENSION	Extension of terms index file
static final int	VERSION_CURRENT	Current terms format.
static final int	VERSION_START	Initial terms format.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	close()
(package private) static long	encodeOutput(long fp, boolean hasTerms, boolean isFloor)
void	write(Fields fields, NormsProducer norms)	Write all fields, terms and postings.
private static void	writeBytesRef(IndexOutput out, BytesRef bytes)
private void	writeIndexTrailer(IndexOutput indexOut, long dirStart)	Writes the index file trailer.
private 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 Details

FST_OUTPUTS

static final PairOutputs<BytesRef,Long> FST_OUTPUTS

NO_OUTPUT

static final PairOutputs.Pair<BytesRef,Long> NO_OUTPUT

DEFAULT_MIN_BLOCK_SIZE

public static final int DEFAULT_MIN_BLOCK_SIZE

Suggested default value for the minItemsInBlock parameter to VersionBlockTreeTermsWriter(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 VersionBlockTreeTermsWriter(SegmentWriteState,PostingsWriterBase,int,int).

See Also:

• Constant Field Values

OUTPUT_FLAGS_NUM_BITS

static final int OUTPUT_FLAGS_NUM_BITS

See Also:

• Constant Field Values

OUTPUT_FLAGS_MASK

static final int OUTPUT_FLAGS_MASK

See Also:

• Constant Field Values

OUTPUT_FLAG_IS_FLOOR

static final int OUTPUT_FLAG_IS_FLOOR

See Also:

• Constant Field Values

OUTPUT_FLAG_HAS_TERMS

static final int OUTPUT_FLAG_HAS_TERMS

See Also:

• Constant Field Values

TERMS_EXTENSION

static final String TERMS_EXTENSION

Extension of terms file

See Also:

• Constant Field Values

TERMS_CODEC_NAME

static final String TERMS_CODEC_NAME

See Also:

• Constant Field Values

VERSION_START

public static final int VERSION_START

Initial terms format.

See Also:

• Constant Field Values

VERSION_CURRENT

public static final int VERSION_CURRENT

Current terms format.

See Also:

• Constant Field Values

TERMS_INDEX_EXTENSION

static final String TERMS_INDEX_EXTENSION

Extension of terms index file

See Also:

• Constant Field Values

TERMS_INDEX_CODEC_NAME

static final String TERMS_INDEX_CODEC_NAME

See Also:

• Constant Field Values

out

private final IndexOutput out

indexOut

private final IndexOutput indexOut

maxDoc

final int maxDoc

minItemsInBlock

final int minItemsInBlock

maxItemsInBlock

final int maxItemsInBlock

postingsWriter

final PostingsWriterBase postingsWriter

fieldInfos

final FieldInfos fieldInfos

fields

private final List<VersionBlockTreeTermsWriter.FieldMetaData> fields

scratchBytes

private final ByteBuffersDataOutput scratchBytes

scratchIntsRef

private final IntsRefBuilder scratchIntsRef

closed

private boolean closed

Constructor Details

VersionBlockTreeTermsWriter

public VersionBlockTreeTermsWriter(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 Details

writeTrailer

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

Writes the terms file trailer.

Throws:

IOException

writeIndexTrailer

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

Writes the index file trailer.

Throws:

IOException

write

public void write(Fields fields,
 NormsProducer norms)
           throws IOException

Description copied from class: FieldsConsumer

Write all fields, terms and postings. This the "pull" API, allowing you to iterate more than once over the postings, somewhat analogous to using a DOM API to traverse an XML tree.

Notes:

• You must compute index statistics, including each Term's docFreq and totalTermFreq, as well as the summary sumTotalTermFreq, sumTotalDocFreq and docCount.
• You must skip terms that have no docs and fields that have no terms, even though the provided Fields API will expose them; this typically requires lazily writing the field or term until you've actually seen the first term or document.
• The provided Fields instance is limited: you cannot call any methods that return statistics/counts; you cannot pass a non-null live docs when pulling docs/positions enums.

Specified by:

write in class FieldsConsumer

Throws:

IOException

encodeOutput

static long encodeOutput(long fp,
 boolean hasTerms,
 boolean isFloor)

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class FieldsConsumer

Throws:

IOException

writeBytesRef

private static void writeBytesRef(IndexOutput out,
 BytesRef bytes)
                           throws IOException

Throws:

IOException