Package org.apache.lucene.index
Class SlowCompositeReaderWrapper
- java.lang.Object
-
- org.apache.lucene.index.IndexReader
-
- org.apache.lucene.index.AtomicReader
-
- org.apache.lucene.index.SlowCompositeReaderWrapper
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
public final class SlowCompositeReaderWrapper extends AtomicReader
This class forces a composite reader (eg aMultiReader
orDirectoryReader
) to emulate an atomic reader. This requires implementing the postings APIs on-the-fly, using the static methods inMultiFields
,MultiDocValues
, by stepping through the sub-readers to merge fields/terms, appending docs, etc.NOTE: this class almost always results in a performance hit. If this is important to your use case, you'll get better performance by gathering the sub readers using
IndexReader.getContext()
to get the atomic leaves and then operate per-AtomicReader, instead of using this class.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.index.IndexReader
IndexReader.ReaderClosedListener
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
doClose()
Implements close.void
document(int docID, StoredFieldVisitor visitor)
Expert: visits the fields of a stored document, for custom processing/loading of each field.Fields
fields()
ReturnsFields
for this reader.BinaryDocValues
getBinaryDocValues(String field)
ReturnsBinaryDocValues
for this field, or null if noBinaryDocValues
were indexed for this field.Object
getCombinedCoreAndDeletesKey()
Expert: Returns a key for this IndexReader that also includes deletions, so FieldCache/CachingWrapperFilter can find it again.Object
getCoreCacheKey()
Expert: Returns a key for this IndexReader, so FieldCache/CachingWrapperFilter can find it again.Bits
getDocsWithField(String field)
Returns aBits
at the size ofreader.maxDoc()
, with turned on bits for each docid that does have a value for this field, or null if no DocValues were indexed for this field.FieldInfos
getFieldInfos()
Get theFieldInfos
describing all fields in this reader.Bits
getLiveDocs()
Returns theBits
representing live (not deleted) docs.NumericDocValues
getNormValues(String field)
ReturnsNumericDocValues
representing norms for this field, or null if noNumericDocValues
were indexed.NumericDocValues
getNumericDocValues(String field)
ReturnsNumericDocValues
for this field, or null if noNumericDocValues
were indexed for this field.SortedDocValues
getSortedDocValues(String field)
ReturnsSortedDocValues
for this field, or null if noSortedDocValues
were indexed for this field.SortedSetDocValues
getSortedSetDocValues(String field)
ReturnsSortedSetDocValues
for this field, or null if noSortedSetDocValues
were indexed for this field.Fields
getTermVectors(int docID)
Retrieve term vectors for this document, or null if term vectors were not indexed.int
maxDoc()
Returns one greater than the largest possible document number.int
numDocs()
Returns the number of documents in this index.String
toString()
static AtomicReader
wrap(IndexReader reader)
This method is sugar for getting anAtomicReader
from anIndexReader
of any kind.-
Methods inherited from class org.apache.lucene.index.AtomicReader
docFreq, getContext, getDocCount, getSumDocFreq, getSumTotalTermFreq, hasNorms, termDocsEnum, termPositionsEnum, terms, totalTermFreq
-
Methods inherited from class org.apache.lucene.index.IndexReader
addReaderClosedListener, close, decRef, document, document, ensureOpen, equals, getRefCount, getTermVector, hasDeletions, hashCode, incRef, leaves, numDeletedDocs, open, open, open, open, open, registerParentReader, removeReaderClosedListener, tryIncRef
-
-
-
-
Method Detail
-
wrap
public static AtomicReader wrap(IndexReader reader) throws IOException
This method is sugar for getting anAtomicReader
from anIndexReader
of any kind. If the reader is already atomic, it is returned unchanged, otherwise wrapped by this class.- Throws:
IOException
-
fields
public Fields fields()
Description copied from class:AtomicReader
ReturnsFields
for this reader. This method may return null if the reader has no postings.- Specified by:
fields
in classAtomicReader
-
getNumericDocValues
public NumericDocValues getNumericDocValues(String field) throws IOException
Description copied from class:AtomicReader
ReturnsNumericDocValues
for this field, or null if noNumericDocValues
were indexed for this field. The returned instance should only be used by a single thread.- Specified by:
getNumericDocValues
in classAtomicReader
- Throws:
IOException
-
getDocsWithField
public Bits getDocsWithField(String field) throws IOException
Description copied from class:AtomicReader
Returns aBits
at the size ofreader.maxDoc()
, with turned on bits for each docid that does have a value for this field, or null if no DocValues were indexed for this field. The returned instance should only be used by a single thread- Specified by:
getDocsWithField
in classAtomicReader
- Throws:
IOException
-
getBinaryDocValues
public BinaryDocValues getBinaryDocValues(String field) throws IOException
Description copied from class:AtomicReader
ReturnsBinaryDocValues
for this field, or null if noBinaryDocValues
were indexed for this field. The returned instance should only be used by a single thread.- Specified by:
getBinaryDocValues
in classAtomicReader
- Throws:
IOException
-
getSortedDocValues
public SortedDocValues getSortedDocValues(String field) throws IOException
Description copied from class:AtomicReader
ReturnsSortedDocValues
for this field, or null if noSortedDocValues
were indexed for this field. The returned instance should only be used by a single thread.- Specified by:
getSortedDocValues
in classAtomicReader
- Throws:
IOException
-
getSortedSetDocValues
public SortedSetDocValues getSortedSetDocValues(String field) throws IOException
Description copied from class:AtomicReader
ReturnsSortedSetDocValues
for this field, or null if noSortedSetDocValues
were indexed for this field. The returned instance should only be used by a single thread.- Specified by:
getSortedSetDocValues
in classAtomicReader
- Throws:
IOException
-
getNormValues
public NumericDocValues getNormValues(String field) throws IOException
Description copied from class:AtomicReader
ReturnsNumericDocValues
representing norms for this field, or null if noNumericDocValues
were indexed. The returned instance should only be used by a single thread.- Specified by:
getNormValues
in classAtomicReader
- Throws:
IOException
-
getTermVectors
public Fields getTermVectors(int docID) throws IOException
Description copied from class:IndexReader
Retrieve term vectors for this document, or null if term vectors were not indexed. The returned Fields instance acts like a single-document inverted index (the docID will be 0).- Specified by:
getTermVectors
in classIndexReader
- Throws:
IOException
-
numDocs
public int numDocs()
Description copied from class:IndexReader
Returns the number of documents in this index.- Specified by:
numDocs
in classIndexReader
-
maxDoc
public int maxDoc()
Description copied from class:IndexReader
Returns one greater than the largest possible document number. This may be used to, e.g., determine how big to allocate an array which will have an element for every document number in an index.- Specified by:
maxDoc
in classIndexReader
-
document
public void document(int docID, StoredFieldVisitor visitor) throws IOException
Description copied from class:IndexReader
Expert: visits the fields of a stored document, for custom processing/loading of each field. If you simply want to load all fields, useIndexReader.document(int)
. If you want to load a subset, useDocumentStoredFieldVisitor
.- Specified by:
document
in classIndexReader
- Throws:
IOException
-
getLiveDocs
public Bits getLiveDocs()
Description copied from class:AtomicReader
Returns theBits
representing live (not deleted) docs. A set bit indicates the doc ID has not been deleted. If this method returns null it means there are no deleted documents (all documents are live). The returned instance has been safely published for use by multiple threads without additional synchronization.- Specified by:
getLiveDocs
in classAtomicReader
-
getFieldInfos
public FieldInfos getFieldInfos()
Description copied from class:AtomicReader
Get theFieldInfos
describing all fields in this reader.- Specified by:
getFieldInfos
in classAtomicReader
-
getCoreCacheKey
public Object getCoreCacheKey()
Description copied from class:IndexReader
Expert: Returns a key for this IndexReader, so FieldCache/CachingWrapperFilter can find it again. This key must not have equals()/hashCode() methods, so "equals" means "identical".- Overrides:
getCoreCacheKey
in classIndexReader
-
getCombinedCoreAndDeletesKey
public Object getCombinedCoreAndDeletesKey()
Description copied from class:IndexReader
Expert: Returns a key for this IndexReader that also includes deletions, so FieldCache/CachingWrapperFilter can find it again. This key must not have equals()/hashCode() methods, so "equals" means "identical".- Overrides:
getCombinedCoreAndDeletesKey
in classIndexReader
-
doClose
protected void doClose() throws IOException
Description copied from class:IndexReader
Implements close.- Specified by:
doClose
in classIndexReader
- Throws:
IOException
-
-