core/org.gnit.lucenekmp.codecs.blockterms

Package-level declarations

Types

class BlockTermsReader(indexReader: TermsIndexReaderBase, postingsReader: PostingsReaderBase, state: SegmentReadState) : FieldsProducer

Handles a terms dict, but decouples all details of doc/freqs/positions reading to an instance of PostingsReaderBase. This class is reusable for codecs that use a different format for docs/freqs/positions (though codecs are also free to make their own terms dict impl).

BlockTermsWriter

class BlockTermsWriter(termsIndexWriter: TermsIndexWriterBase, state: SegmentWriteState, postingsWriter: PostingsWriterBase) : FieldsConsumer

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

FixedGapTermsIndexReader

class FixedGapTermsIndexReader(state: SegmentReadState) : TermsIndexReaderBase

TermsIndexReader for simple every Nth terms indexes.

FixedGapTermsIndexWriter

class FixedGapTermsIndexWriter(state: SegmentWriteState, termIndexInterval: Int = DEFAULT_TERM_INDEX_INTERVAL) : 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.

TermsIndexReaderBase

abstract class TermsIndexReaderBase : AutoCloseable

BlockTermsReader interacts with an instance of this class to manage its terms index. The writer must accept indexed terms (many pairs of BytesRef text + long fileOffset), and then this reader must be able to retrieve the nearest index term to a provided term text.

TermsIndexWriterBase

abstract class TermsIndexWriterBase : AutoCloseable

Base class for terms index implementations to plug into BlockTermsWriter.

VariableGapTermsIndexReader

class VariableGapTermsIndexReader(state: SegmentReadState) : TermsIndexReaderBase

See VariableGapTermsIndexWriter

VariableGapTermsIndexWriter

class VariableGapTermsIndexWriter(state: SegmentWriteState, policy: VariableGapTermsIndexWriter.IndexTermSelector) : TermsIndexWriterBase

Selects index terms according to provided pluggable IndexTermSelector, and stores them in a prefix trie that's loaded entirely in RAM stored as an FST. This terms index only supports unsigned byte term sort order (unicode codepoint order when the bytes are UTF8).