|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.lucene.index.IndexReaderContext
public abstract class IndexReaderContext
A struct like class that represents a hierarchical relationship between
IndexReader
instances.
Field Summary | |
---|---|
int |
docBaseInParent
the doc base for this reader in the parent, 0 if parent is null |
boolean |
isTopLevel
true if this context struct represents the top level reader within the hierarchical context |
int |
ordInParent
the ord for this reader in the parent, 0 if parent is null |
CompositeReaderContext |
parent
The reader context for this reader's immediate parent, or null if none |
Method Summary | |
---|---|
abstract List<IndexReaderContext> |
children()
Returns the context's children iff this context is a composite context otherwise null . |
abstract List<AtomicReaderContext> |
leaves()
Returns the context's leaves if this context is a top-level context. |
abstract IndexReader |
reader()
Returns the IndexReader , this context represents. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public final CompositeReaderContext parent
public final boolean isTopLevel
true
if this context struct represents the top level reader within the hierarchical context
public final int docBaseInParent
public final int ordInParent
Method Detail |
---|
public abstract IndexReader reader()
IndexReader
, this context represents.
public abstract List<AtomicReaderContext> leaves() throws UnsupportedOperationException
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()
.
UnsupportedOperationException
- if this is not a top-level context.children()
public abstract List<IndexReaderContext> children()
null
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |