Package org.apache.lucene.index
Class IndexReaderContext
- java.lang.Object
-
- org.apache.lucene.index.IndexReaderContext
-
- Direct Known Subclasses:
CompositeReaderContext
,LeafReaderContext
public abstract class IndexReaderContext extends Object
A struct like class that represents a hierarchical relationship betweenIndexReader
instances.
-
-
Field Summary
Fields Modifier and Type Field Description int
docBaseInParent
the doc base for this reader in the parent, 0 if parent is nullboolean
isTopLevel
true
if this context struct represents the top level reader within the hierarchical contextint
ordInParent
the ord for this reader in the parent, 0 if parent is nullCompositeReaderContext
parent
The reader context for this reader's immediate parent, or null if none
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract List<IndexReaderContext>
children()
Returns the context's children iff this context is a composite context otherwisenull
.Object
id()
Expert: Return anObject
that uniquely identifies this context.abstract List<LeafReaderContext>
leaves()
Returns the context's leaves if this context is a top-level context.abstract IndexReader
reader()
Returns theIndexReader
, this context represents.
-
-
-
Field Detail
-
parent
public final CompositeReaderContext parent
The reader context for this reader's immediate parent, or null if none
-
isTopLevel
public final boolean isTopLevel
true
if this context struct represents the top level reader within the hierarchical context
-
docBaseInParent
public final int docBaseInParent
the doc base for this reader in the parent, 0 if parent is null
-
ordInParent
public final int ordInParent
the ord for this reader in the parent, 0 if parent is null
-
-
Method Detail
-
id
public Object id()
Expert: Return anObject
that uniquely identifies this context. The returned object does neither reference thisIndexReaderContext
nor the wrappedIndexReader
.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
reader
public abstract IndexReader reader()
Returns theIndexReader
, this context represents.
-
leaves
public abstract List<LeafReaderContext> leaves() throws UnsupportedOperationException
Returns the context's leaves if this context is a top-level context. For convenience, if this is anLeafReaderContext
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()
-
children
public abstract List<IndexReaderContext> children()
Returns the context's children iff this context is a composite context otherwisenull
.
-
-