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:
java.io.Closeable
,java.lang.AutoCloseable
,Accountable
- 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
Fields Modifier and Type Field Description private FixedBitSet
bits
private int
numDocs
private LeafReader
reader
private IndexReader.CacheHelper
readerCacheHelper
-
Fields inherited from class org.apache.lucene.index.FilterCodecReader
in
-
Fields inherited from interface org.apache.lucene.util.Accountable
NULL_ACCOUNTABLE
-
-
Constructor Summary
Constructors Modifier Constructor Description private
SoftDeletesFilterCodecReader(CodecReader reader, FixedBitSet bits, int numDocs)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IndexReader.CacheHelper
getCoreCacheHelper()
Optional method: Return aIndexReader.CacheHelper
that can be used to cache based on the content of this leaf regardless of deletions.Bits
getLiveDocs()
Returns theBits
representing live (not deleted) docs.IndexReader.CacheHelper
getReaderCacheHelper()
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, getChildResources, getDelegate, getDocValuesReader, getFieldInfos, getFieldsReader, getMetaData, getNormsReader, getPointsReader, getPostingsReader, getTermVectorsReader, maxDoc, ramBytesUsed, unwrap, wrapLiveDocs
-
Methods inherited from class org.apache.lucene.index.CodecReader
document, getBinaryDocValues, getNormValues, getNumericDocValues, getPointValues, getSortedDocValues, getSortedNumericDocValues, getSortedSetDocValues, getTermVectors, terms
-
Methods inherited from class org.apache.lucene.index.LeafReader
docFreq, getContext, getDocCount, getSumDocFreq, getSumTotalTermFreq, postings, postings, totalTermFreq
-
Methods inherited from class org.apache.lucene.index.IndexReader
close, decRef, document, document, ensureOpen, equals, getRefCount, getTermVector, hasDeletions, hashCode, incRef, leaves, notifyReaderClosedListeners, numDeletedDocs, registerParentReader, tryIncRef
-
-
-
-
Field Detail
-
reader
private final LeafReader reader
-
bits
private final FixedBitSet bits
-
numDocs
private final int numDocs
-
readerCacheHelper
private final IndexReader.CacheHelper readerCacheHelper
-
-
Constructor Detail
-
SoftDeletesFilterCodecReader
private SoftDeletesFilterCodecReader(CodecReader reader, FixedBitSet bits, int numDocs)
-
-
Method Detail
-
getLiveDocs
public Bits 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
public IndexReader.CacheHelper 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
public IndexReader.CacheHelper 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
-
-