- All Implemented Interfaces:
- Direct Known Subclasses:
public abstract class CompositeReader extends IndexReaderInstances of this reader type can only be used to get stored fields from the underlying LeafReaders, but it is not possible to directly retrieve postings. To do that, get the
LeafReaderContextfor all sub-readers via
IndexReader instances for indexes on disk are usually constructed with a call to one of the static
CompositeReaderinterface, it is not possible to directly get postings.
Concrete subclasses of IndexReader are usually constructed with a call to one of the static
For efficiency, in this API documents are often referred to via document numbers, non-negative integers which each name a unique document in the index. These document numbers are ephemeral -- they may change as documents are added to and deleted from an index. Clients should thus not rely on a given document having the same number between sessions.
IndexReaderinstances are completely thread safe, meaning multiple threads can call any of its methods, concurrently. If your application requires external synchronization, you should not synchronize on the
IndexReaderinstance; use your own (non-Lucene) objects instead.
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.index.IndexReader
IndexReader.CacheHelper, IndexReader.CacheKey, IndexReader.ClosedListener
Constructors Modifier Constructor Description
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description
getContext()Expert: Returns the root
IndexReader's sub-reader tree.
protected abstract List<? extends IndexReader>
getSequentialSubReaders()Expert: returns the sequential sub readers that this reader is logically composed of.
Methods inherited from class org.apache.lucene.index.IndexReader
close, decRef, docFreq, doClose, document, document, document, ensureOpen, equals, getDocCount, getReaderCacheHelper, getRefCount, getSumDocFreq, getSumTotalTermFreq, getTermVector, getTermVectors, hasDeletions, hashCode, incRef, leaves, maxDoc, notifyReaderClosedListeners, numDeletedDocs, numDocs, registerParentReader, totalTermFreq, tryIncRef
protected abstract List<? extends IndexReader> getSequentialSubReaders()Expert: returns the sequential sub readers that this reader is logically composed of. This method may not return
NOTE: In contrast to previous Lucene versions this method is no longer public, code that wants to get all
LeafReaders this composite is composed of should use
- See Also:
public final CompositeReaderContext getContext()Description copied from class:
IndexReaderExpert: Returns the root
IndexReader's sub-reader tree.
Iff this reader is composed of sub readers, i.e. this reader being a composite reader, this method returns a
CompositeReaderContextholding the reader's direct children as well as a view of the reader tree's atomic leaf contexts. All sub-
IndexReaderContextinstances referenced from this readers top-level context are private to this reader and are not shared with another context tree. For example, IndexSearcher uses this API to drive searching by one atomic leaf reader at a time. If this reader is not composed of child readers, this method returns an
Note: Any of the sub-
CompositeReaderContextinstances referenced from this top-level context do not support
CompositeReaderContext.leaves(). Only the top-level context maintains the convenience leaf-view for performance reasons.
- Specified by: