Module org.apache.lucene.core
Package org.apache.lucene.index
Class SoftDeletesDirectoryReaderWrapper.SoftDeletesFilterCodecReader
java.lang.Object
org.apache.lucene.index.IndexReader
org.apache.lucene.index.LeafReader
org.apache.lucene.index.CodecReader
org.apache.lucene.index.FilterCodecReader
org.apache.lucene.index.SoftDeletesDirectoryReaderWrapper.SoftDeletesFilterCodecReader
- All Implemented Interfaces:
Closeable
,AutoCloseable
- Enclosing class:
SoftDeletesDirectoryReaderWrapper
static final class SoftDeletesDirectoryReaderWrapper.SoftDeletesFilterCodecReader
extends FilterCodecReader
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.index.IndexReader
IndexReader.CacheHelper, IndexReader.CacheKey, IndexReader.ClosedListener
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final FixedBitSet
private final int
private final LeafReader
private final IndexReader.CacheHelper
Fields inherited from class org.apache.lucene.index.FilterCodecReader
in
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
SoftDeletesFilterCodecReader
(CodecReader reader, FixedBitSet bits, int numDocs) -
Method Summary
Modifier and TypeMethodDescriptionOptional method: Return aIndexReader.CacheHelper
that can be used to cache based on the content of this leaf regardless of deletions.Returns theBits
representing live (not deleted) docs.Optional method: Return aIndexReader.CacheHelper
that can be used to cache based on the content of this reader.int
numDocs()
Returns the number of documents in this index.Methods inherited from class org.apache.lucene.index.FilterCodecReader
checkIntegrity, doClose, getDelegate, getDocValuesReader, getFieldInfos, getFieldsReader, getMetaData, getNormsReader, getPointsReader, getPostingsReader, getTermVectorsReader, getVectorReader, maxDoc, unwrap, wrapLiveDocs
Methods inherited from class org.apache.lucene.index.CodecReader
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
-
reader
-
bits
-
numDocs
private final int numDocs -
readerCacheHelper
-
-
Constructor Details
-
SoftDeletesFilterCodecReader
-
-
Method Details
-
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.
- Overrides:
getLiveDocs
in classFilterCodecReader
-
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.
- Overrides:
numDocs
in classFilterCodecReader
-
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
-
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
-