Package org.apache.lucene.index
Class IndexReaderContext
java.lang.Object
org.apache.lucene.index.IndexReaderContext
- Direct Known Subclasses:
AtomicReaderContext
,CompositeReaderContext
A struct like class that represents a hierarchical relationship between
IndexReader
instances.-
Field Summary
FieldsModifier and TypeFieldDescriptionfinal int
the doc base for this reader in the parent, 0 if parent is nullfinal boolean
true
if this context struct represents the top level reader within the hierarchical contextfinal int
the ord for this reader in the parent, 0 if parent is nullfinal CompositeReaderContext
The reader context for this reader's immediate parent, or null if none -
Method Summary
Modifier and TypeMethodDescriptionabstract List<IndexReaderContext>
children()
Returns the context's children iff this context is a composite context otherwisenull
.abstract List<AtomicReaderContext>
leaves()
Returns the context's leaves if this context is a top-level context.abstract IndexReader
reader()
Returns theIndexReader
, this context represents.
-
Field Details
-
parent
The reader context for this reader's immediate parent, or null if none -
isTopLevel
public final boolean isTopLeveltrue
if this context struct represents the top level reader within the hierarchical context -
docBaseInParent
public final int docBaseInParentthe doc base for this reader in the parent, 0 if parent is null -
ordInParent
public final int ordInParentthe ord for this reader in the parent, 0 if parent is null
-
-
Method Details
-
reader
Returns theIndexReader
, this context represents. -
leaves
Returns the context's leaves if this context is a top-level context. For convenience, if this is anAtomicReaderContext
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()
.- Throws:
UnsupportedOperationException
- if this is not a top-level context.- See Also:
-
children
Returns the context's children iff this context is a composite context otherwisenull
.
-