Class IndexReaderContext

A struct like class that represents a hierarchical relationship between IndexReader instances.

Inheritance
object
IndexReaderContext
AtomicReaderContext
CompositeReaderContext
Inherited Members
Namespace: Lucene.Net.Index
Assembly: Lucene.Net.dll
Syntax
public abstract class IndexReaderContext

Properties

Children

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

Declaration
public abstract IList<IndexReaderContext> Children { get; }
Property Value
Type Description
IList<IndexReaderContext>

DocBaseInParent

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

Declaration
public int DocBaseInParent { get; }
Property Value
Type Description
int

IsTopLevel

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

Declaration
public bool IsTopLevel { get; }
Property Value
Type Description
bool

Leaves

Returns the context's leaves if this context is a top-level context. For convenience, if this is an AtomicReaderContext this returns itself as the only leaf.

Note: this is convenience method since leaves can always be obtained by walking the context tree using Children.
Declaration
public abstract IList<AtomicReaderContext> Leaves { get; }
Property Value
Type Description
IList<AtomicReaderContext>
Exceptions
Type Condition
InvalidOperationException

if this is not a top-level context.
See Also

OrdInParent

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

Declaration
public int OrdInParent { get; }
Property Value
Type Description
int

Parent

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

Declaration
public CompositeReaderContext Parent { get; }
Property Value
Type Description
CompositeReaderContext

Reader

Returns the IndexReader, this context represents.

Declaration
public abstract IndexReader Reader { get; }
Property Value
Type Description
IndexReader