org.apache.lucene.codecs.blockterms

Class FixedGapTermsIndexWriter

java.lang.Object

org.apache.lucene.codecs.blockterms.TermsIndexWriterBase

org.apache.lucene.codecs.blockterms.FixedGapTermsIndexWriter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class FixedGapTermsIndexWriter
extends TermsIndexWriterBase

Selects every Nth term as and index term, and hold term bytes (mostly) fully expanded in memory. This terms index supports seeking by ord. See VariableGapTermsIndexWriter for a more memory efficient terms index that does not support seeking by ord.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	FixedGapTermsIndexWriter.SimpleFieldWriter

Nested classes/interfaces inherited from class org.apache.lucene.codecs.blockterms.TermsIndexWriterBase

TermsIndexWriterBase.FieldWriter

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static int	BLOCKSIZE
(package private) static java.lang.String	CODEC_NAME
static int	DEFAULT_TERM_INDEX_INTERVAL
private java.util.List<FixedGapTermsIndexWriter.SimpleFieldWriter>	fields
protected IndexOutput	out
private int	termIndexInterval
(package private) static java.lang.String	TERMS_INDEX_EXTENSION Extension of terms index file
(package private) static int	VERSION_CURRENT
(package private) static int	VERSION_START

Constructor Summary

Constructors

Constructor and Description
FixedGapTermsIndexWriter(SegmentWriteState state)
FixedGapTermsIndexWriter(SegmentWriteState state, int termIndexInterval)

Method Summary

Modifier and Type	Method and Description
TermsIndexWriterBase.FieldWriter	addField(FieldInfo field, long termsFilePointer)
void	close()
protected int	indexedTermPrefixLength(BytesRef priorTerm, BytesRef indexedTerm) NOTE: if your codec does not sort in unicode code point order, you must override this method, to simply return indexedTerm.length.
private void	writeTrailer(long dirStart)

Methods inherited from class java.lang.Object

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

Field Detail

out

protected IndexOutput out

TERMS_INDEX_EXTENSION

static final java.lang.String TERMS_INDEX_EXTENSION

Extension of terms index file

See Also:

Constant Field Values

CODEC_NAME

static final java.lang.String CODEC_NAME

See Also:

Constant Field Values

VERSION_START

static final int VERSION_START

See Also:

Constant Field Values

VERSION_CURRENT

static final int VERSION_CURRENT

See Also:

Constant Field Values

BLOCKSIZE

static final int BLOCKSIZE

See Also:

Constant Field Values

termIndexInterval

private final int termIndexInterval

DEFAULT_TERM_INDEX_INTERVAL

public static final int DEFAULT_TERM_INDEX_INTERVAL

See Also:

Constant Field Values

fields

private final java.util.List<FixedGapTermsIndexWriter.SimpleFieldWriter> fields

Constructor Detail

FixedGapTermsIndexWriter

public FixedGapTermsIndexWriter(SegmentWriteState state)
                         throws java.io.IOException

Throws:

java.io.IOException

FixedGapTermsIndexWriter

public FixedGapTermsIndexWriter(SegmentWriteState state,
                                int termIndexInterval)
                         throws java.io.IOException

Throws:

java.io.IOException

Method Detail

addField

public TermsIndexWriterBase.FieldWriter addField(FieldInfo field,
                                                 long termsFilePointer)

Specified by:

addField in class TermsIndexWriterBase

indexedTermPrefixLength

protected int indexedTermPrefixLength(BytesRef priorTerm,
                                      BytesRef indexedTerm)

NOTE: if your codec does not sort in unicode code point order, you must override this method, to simply return indexedTerm.length.

close

public void close()
           throws java.io.IOException

Throws:

java.io.IOException

writeTrailer

private void writeTrailer(long dirStart)
                   throws java.io.IOException

Throws:

java.io.IOException