Package org.apache.lucene.index
Class LeafReaderContext
- java.lang.Object
-
- org.apache.lucene.index.IndexReaderContext
-
- org.apache.lucene.index.LeafReaderContext
-
public final class LeafReaderContext extends IndexReaderContext
IndexReaderContextforLeafReaderinstances.
-
-
Field Summary
Fields Modifier and Type Field Description intdocBaseThe reader's absolute doc baseintordThe reader's ord in the top-level's leaves array-
Fields inherited from class org.apache.lucene.index.IndexReaderContext
docBaseInParent, isTopLevel, ordInParent, parent
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description List<IndexReaderContext>children()Returns the context's children iff this context is a composite context otherwisenull.List<LeafReaderContext>leaves()Returns the context's leaves if this context is a top-level context.LeafReaderreader()Returns theIndexReader, this context represents.StringtoString()-
Methods inherited from class org.apache.lucene.index.IndexReaderContext
id
-
-
-
-
Method Detail
-
leaves
public List<LeafReaderContext> leaves()
Description copied from class:IndexReaderContextReturns the context's leaves if this context is a top-level context. For convenience, if this is anLeafReaderContextthis returns itself as the only leaf, and it will never return a null value.Note: this is convenience method since leaves can always be obtained by walking the context tree using
IndexReaderContext.children().- Specified by:
leavesin classIndexReaderContext- See Also:
IndexReaderContext.children()
-
children
public List<IndexReaderContext> children()
Description copied from class:IndexReaderContextReturns the context's children iff this context is a composite context otherwisenull.- Specified by:
childrenin classIndexReaderContext
-
reader
public LeafReader reader()
Description copied from class:IndexReaderContextReturns theIndexReader, this context represents.- Specified by:
readerin classIndexReaderContext
-
-