core/org.gnit.lucenekmp.index/LeafReaderContext

LeafReaderContext

class LeafReaderContext : IndexReaderContext

IndexReaderContext for LeafReader instances.

Properties

var docBase: Int

The reader's absolute doc base

docBaseInParent

val docBaseInParent: Int

the doc base for this reader in the parent, 0 if parent is null

val identity: Any

val isTopLevel: Boolean

true if this context struct represents the top level reader within the hierarchical context

var ord: Int

The reader's ord in the top-level's leaves array

val ordInParent: Int

the ord for this reader in the parent, 0 if parent is null

val parent: CompositeReaderContext?

The reader context for this reader's immediate parent, or null if none

Functions

open override fun children(): MutableList<IndexReaderContext>?

Returns the context's children iff this context is a composite context otherwise null * .

fun id(): Any

Expert: Return an Object that uniquely identifies this context. The returned object does neither reference this IndexReaderContext nor the wrapped IndexReader.

open override fun leaves(): MutableList<LeafReaderContext>

Returns the context's leaves if this context is a top-level context. For convenience, if this is an LeafReaderContext this returns itself as the only leaf, and it will never return a null value.

open override fun reader(): LeafReader

Returns the IndexReader, this context represents.

open override fun toString(): String