Package org.apache.lucene.index
Class LeafReaderContext
java.lang.Object
org.apache.lucene.index.IndexReaderContext
org.apache.lucene.index.LeafReaderContext
IndexReaderContext for LeafReader instances.-
Field Summary
FieldsModifier and TypeFieldDescriptionfinal intThe reader's absolute doc basefinal intThe reader's ord in the top-level's leaves arrayFields inherited from class org.apache.lucene.index.IndexReaderContext
docBaseInParent, isTopLevel, ordInParent, parent -
Method Summary
Modifier and TypeMethodDescriptionchildren()Returns the context's children iff this context is a composite context otherwisenull.leaves()Returns the context's leaves if this context is a top-level context.reader()Returns theIndexReader, this context represents.toString()Methods inherited from class org.apache.lucene.index.IndexReaderContext
id
-
Field Details
-
ord
public final int ordThe reader's ord in the top-level's leaves array -
docBase
public final int docBaseThe reader's absolute doc base
-
-
Method Details
-
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:
-
children
Description copied from class:IndexReaderContextReturns the context's children iff this context is a composite context otherwisenull.- Specified by:
childrenin classIndexReaderContext
-
reader
Description copied from class:IndexReaderContextReturns theIndexReader, this context represents.- Specified by:
readerin classIndexReaderContext
-
toString
-