Package org.apache.lucene.index

Class CompositeReaderContext

java.lang.Object

org.apache.lucene.index.IndexReaderContext

org.apache.lucene.index.CompositeReaderContext

public final class CompositeReaderContext
extends IndexReaderContext

IndexReaderContext for CompositeReader instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	CompositeReaderContext.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.List<IndexReaderContext>	children
private java.util.List<LeafReaderContext>	leaves
private CompositeReader	reader

Fields inherited from class org.apache.lucene.index.IndexReaderContext

docBaseInParent, identity, isTopLevel, ordInParent, parent

Constructor Summary

Constructors

Modifier	Constructor	Description
(package private)	CompositeReaderContext(CompositeReaderContext parent, CompositeReader reader, int ordInParent, int docbaseInParent, java.util.List<IndexReaderContext> children)	Creates a CompositeReaderContext for intermediate readers that aren't not top-level readers in the current context
private	CompositeReaderContext(CompositeReaderContext parent, CompositeReader reader, int ordInParent, int docbaseInParent, java.util.List<IndexReaderContext> children, java.util.List<LeafReaderContext> leaves)
(package private)	CompositeReaderContext(CompositeReader reader, java.util.List<IndexReaderContext> children, java.util.List<LeafReaderContext> leaves)	Creates a CompositeReaderContext for top-level readers with parent set to null

Method Summary

Modifier and Type	Method	Description
java.util.List<IndexReaderContext>	children()	Returns the context's children iff this context is a composite context otherwise null.
(package private) static CompositeReaderContext	create(CompositeReader reader)
java.util.List<LeafReaderContext>	leaves()	Returns the context's leaves if this context is a top-level context.
CompositeReader	reader()	Returns the IndexReader, this context represents.

Methods inherited from class org.apache.lucene.index.IndexReaderContext

id

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

children

private final java.util.List<IndexReaderContext> children

leaves

private final java.util.List<LeafReaderContext> leaves

reader

private final CompositeReader reader

Constructor Detail

CompositeReaderContext

CompositeReaderContext(CompositeReaderContext parent,
                       CompositeReader reader,
                       int ordInParent,
                       int docbaseInParent,
                       java.util.List<IndexReaderContext> children)

Creates a CompositeReaderContext for intermediate readers that aren't not top-level readers in the current context

CompositeReaderContext

CompositeReaderContext(CompositeReader reader,
                       java.util.List<IndexReaderContext> children,
                       java.util.List<LeafReaderContext> leaves)

Creates a CompositeReaderContext for top-level readers with parent set to null

CompositeReaderContext

private CompositeReaderContext(CompositeReaderContext parent,
                               CompositeReader reader,
                               int ordInParent,
                               int docbaseInParent,
                               java.util.List<IndexReaderContext> children,
                               java.util.List<LeafReaderContext> leaves)

Method Detail

create

static CompositeReaderContext create(CompositeReader reader)

leaves

public java.util.List<LeafReaderContext> leaves()
                                         throws java.lang.UnsupportedOperationException

Description copied from class: IndexReaderContext

Returns the context's leaves if this context is a top-level context. For convenience, if this is an LeafReaderContext this returns itself as the only leaf.

Note: this is convenience method since leaves can always be obtained by walking the context tree using IndexReaderContext.children().

Specified by:

leaves in class IndexReaderContext

Throws:

java.lang.UnsupportedOperationException - if this is not a top-level context.

See Also:

IndexReaderContext.children()

children

public java.util.List<IndexReaderContext> children()

Description copied from class: IndexReaderContext

Returns the context's children iff this context is a composite context otherwise null.

Specified by:

children in class IndexReaderContext

reader

public CompositeReader reader()

Description copied from class: IndexReaderContext

Returns the IndexReader, this context represents.

Specified by:

reader in class IndexReaderContext