core/org.gnit.lucenekmp.index/TermStates

TermStates

Maintains a IndexReader view over IndexReader instances containing a single term. The TermStates doesn't track if the given TermState objects are valid, neither if the TermState instances refer to the same terms in the associated readers.

Constructors

TermStates

constructor(context: IndexReaderContext?)

Creates an empty TermStates from a IndexReaderContext

constructor(context: IndexReaderContext, state: TermState, ord: Int, docFreq: Int, totalTermFreq: Long)

Creates a TermStates with an initial TermState, IndexReader pair.

Types

Companion

object Companion

Functions

accumulateStatistics

fun accumulateStatistics(docFreq: Int, totalTermFreq: Long)

Expert: Accumulate term statistics.

clear

fun clear()

Clears the TermStates internal state and removes all registered TermStates

docFreq

fun docFreq(): Int

Returns the accumulated document frequency of all TermState instances passed to .register.

get

fun get(ctx: LeafReaderContext): IOSupplier<TermState?>?

Returns a Supplier for a TermState for the given LeafReaderContext. This may return null if some cheap checks help figure out that this term doesn't exist in this leaf. The Supplier may then also return null if the term doesn't exist.

fun register(state: TermState, ord: Int)

Expert: Registers and associates a TermState with an leaf ordinal. The leaf ordinal should be derived from a IndexReaderContext's leaf ord. On the contrary to .register this method does NOT update term statistics.

fun register(state: TermState, ord: Int, docFreq: Int, totalTermFreq: Long)

Registers and associates a TermState with an leaf ordinal. The leaf ordinal should be derived from a IndexReaderContext's leaf ord.

toString

open override fun toString(): String

totalTermFreq

fun totalTermFreq(): Long

Returns the accumulated term frequency of all TermState instances passed to .register.

wasBuiltFor

fun wasBuiltFor(context: IndexReaderContext): Boolean

Expert: Return whether this TermStates was built for the given [ ]. This is typically used for assertions.