core/org.gnit.lucenekmp.index/Terms

Terms

abstract class Terms

Access to the terms in a specific field. See Fields.

Inheritors

Types

object Companion

Properties

abstract val docCount: Int

open val max: BytesRef?

open val min: BytesRef?

abstract val sumDocFreq: Long

sumTotalTermFreq

abstract val sumTotalTermFreq: Long

Functions

open fun getStats(): Any

Expert: returns additional information about this Terms instance for debugging purposes.

abstract fun hasFreqs(): Boolean

Returns true if documents in this field store per-document term frequency ( ).

abstract fun hasOffsets(): Boolean

Returns true if documents in this field store offsets.

abstract fun hasPayloads(): Boolean

Returns true if documents in this field store payloads.

abstract fun hasPositions(): Boolean

Returns true if documents in this field store positions.

open fun intersect(compiled: CompiledAutomaton, startTerm: BytesRef?): TermsEnum

Returns a TermsEnum that iterates over all terms and documents that are accepted by the provided CompiledAutomaton. If the startTerm is provided then the returned enum will only return terms > startTerm, but you still must call next() first to get to the first term. Note that the provided startTerm must be accepted by the automaton.

abstract fun iterator(): TermsEnum

Returns an iterator that will step through all terms. This method will not return null.

abstract fun size(): Long

Returns the number of terms for this field, or -1 if this measure isn't stored by the codec. Note that, just like other term measures, this measure does not take deleted documents into account.