java.lang.Object
org.apache.lucene.index.IndexReader
org.apache.lucene.index.LeafReader
org.apache.lucene.index.CodecReader
org.apache.lucene.index.SlowCompositeCodecReaderWrapper
- All Implemented Interfaces:
Closeable
,AutoCloseable
A merged
CodecReader
view of multiple CodecReader
. This view is primarily
targeted at merging, not searching.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static final record
private static class
private static final record
private static class
private static class
private static class
private static class
private static class
private class
private class
Nested classes/interfaces inherited from class org.apache.lucene.index.IndexReader
IndexReader.CacheHelper, IndexReader.CacheKey, IndexReader.ClosedListener
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final CodecReader[]
private final int[]
private final FieldInfos
private final Bits
private final LeafMetaData
(package private) int
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
SlowCompositeCodecReaderWrapper
(List<CodecReader> codecReaders) -
Method Summary
Modifier and TypeMethodDescriptionprivate int
docIdToReaderId
(int doc) Optional method: Return aIndexReader.CacheHelper
that can be used to cache based on the content of this leaf regardless of deletions.Expert: retrieve underlying DocValuesProducerGet theFieldInfos
describing all fields in this reader.Expert: retrieve underlying StoredFieldsReaderReturns theBits
representing live (not deleted) docs.Return metadata about this leaf.Expert: retrieve underlying NormsProducerExpert: retrieve underlying PointsReaderExpert: retrieve underlying FieldsProducerOptional method: Return aIndexReader.CacheHelper
that can be used to cache based on the content of this reader.Expert: retrieve underlying TermVectorsReaderExpert: retrieve underlying VectorReaderint
maxDoc()
Returns one greater than the largest possible document number.int
numDocs()
Returns the number of documents in this index.private FieldInfo
(package private) static CodecReader
wrap
(List<CodecReader> readers) Methods inherited from class org.apache.lucene.index.CodecReader
checkIntegrity, doClose, getBinaryDocValues, getByteVectorValues, getDocValuesSkipper, getFloatVectorValues, getNormValues, getNumericDocValues, getPointValues, getSortedDocValues, getSortedNumericDocValues, getSortedSetDocValues, searchNearestVectors, searchNearestVectors, storedFields, terms, termVectors
Methods inherited from class org.apache.lucene.index.LeafReader
docFreq, getContext, getDocCount, getSumDocFreq, getSumTotalTermFreq, postings, postings, searchNearestVectors, searchNearestVectors, totalTermFreq
Methods inherited from class org.apache.lucene.index.IndexReader
close, decRef, ensureOpen, equals, getRefCount, hasDeletions, hashCode, incRef, leaves, notifyReaderClosedListeners, numDeletedDocs, registerParentReader, tryIncRef
-
Field Details
-
meta
-
codecReaders
-
docStarts
private final int[] docStarts -
fieldInfos
-
liveDocs
-
numDocs
int numDocs
-
-
Constructor Details
-
SlowCompositeCodecReaderWrapper
- Throws:
IOException
-
-
Method Details
-
wrap
- Throws:
IOException
-
docIdToReaderId
private int docIdToReaderId(int doc) -
getFieldsReader
Description copied from class:CodecReader
Expert: retrieve underlying StoredFieldsReader- Specified by:
getFieldsReader
in classCodecReader
-
remap
-
getTermVectorsReader
Description copied from class:CodecReader
Expert: retrieve underlying TermVectorsReader- Specified by:
getTermVectorsReader
in classCodecReader
-
getNormsReader
Description copied from class:CodecReader
Expert: retrieve underlying NormsProducer- Specified by:
getNormsReader
in classCodecReader
-
getDocValuesReader
Description copied from class:CodecReader
Expert: retrieve underlying DocValuesProducer- Specified by:
getDocValuesReader
in classCodecReader
-
getPostingsReader
Description copied from class:CodecReader
Expert: retrieve underlying FieldsProducer- Specified by:
getPostingsReader
in classCodecReader
-
getPointsReader
Description copied from class:CodecReader
Expert: retrieve underlying PointsReader- Specified by:
getPointsReader
in classCodecReader
-
getVectorReader
Description copied from class:CodecReader
Expert: retrieve underlying VectorReader- Specified by:
getVectorReader
in classCodecReader
-
getCoreCacheHelper
Description copied from class:LeafReader
Optional method: Return aIndexReader.CacheHelper
that can be used to cache based on the content of this leaf regardless of deletions. Two readers that have the same data but different sets of deleted documents or doc values updates may be considered equal. Consider usingIndexReader.getReaderCacheHelper()
if you need deletions or dv updates to be taken into account.A return value of
null
indicates that this reader is not suited for caching, which is typically the case for short-lived wrappers that alter the content of the wrapped leaf reader.- Specified by:
getCoreCacheHelper
in classLeafReader
-
getFieldInfos
Description copied from class:LeafReader
Get theFieldInfos
describing all fields in this reader.Note: Implementations should cache the FieldInfos instance returned by this method such that subsequent calls to this method return the same instance.
- Specified by:
getFieldInfos
in classLeafReader
-
getLiveDocs
Description copied from class:LeafReader
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 classLeafReader
-
getMetaData
Description copied from class:LeafReader
Return metadata about this leaf.- Specified by:
getMetaData
in classLeafReader
-
numDocs
public int numDocs()Description copied from class:IndexReader
Returns the number of documents in this index.NOTE: This operation may run in O(maxDoc). Implementations that can't return this number in constant-time should cache it.
- 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
-
getReaderCacheHelper
Description copied from class:IndexReader
Optional method: Return aIndexReader.CacheHelper
that can be used to cache based on the content of this reader. Two readers that have different data or different sets of deleted documents will be considered different.A return value of
null
indicates that this reader is not suited for caching, which is typically the case for short-lived wrappers that alter the content of the wrapped reader.- Specified by:
getReaderCacheHelper
in classIndexReader
-