Package org.apache.lucene.index

Class LazySoftDeletesDirectoryReaderWrapper

java.lang.Object
org.apache.lucene.index.IndexReader
org.apache.lucene.index.CompositeReader
org.apache.lucene.index.BaseCompositeReader<org.apache.lucene.index.LeafReader>
org.apache.lucene.index.DirectoryReader
org.apache.lucene.index.FilterDirectoryReader
org.apache.lucene.index.LazySoftDeletesDirectoryReaderWrapper
All Implemented Interfaces:
Closeable, AutoCloseable
public final class LazySoftDeletesDirectoryReaderWrapper extends org.apache.lucene.index.FilterDirectoryReader
This is a modified version of SoftDeletesDirectoryReaderWrapper that materializes the liveDocs bitset lazily. In contrast to SoftDeletesDirectoryReaderWrapper, this wrapper can only be used for non-NRT readers. This reader filters out documents that have a doc values value in the given field and treat these documents as soft deleted. Hard deleted documents will also be filtered out in the live docs of this reader.
See Also:
IndexWriterConfig.setSoftDeletesField(String), IndexWriter.softUpdateDocument(Term, Iterable, Field...), SoftDeletesRetentionMergePolicy

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    LazySoftDeletesDirectoryReaderWrapper.LazyBits
     
    static class 
    LazySoftDeletesDirectoryReaderWrapper.LazySoftDeletesFilterCodecReader
     
    static class 
    LazySoftDeletesDirectoryReaderWrapper.LazySoftDeletesFilterLeafReader
     

    Nested classes/interfaces inherited from class org.apache.lucene.index.FilterDirectoryReader

    org.apache.lucene.index.FilterDirectoryReader.SubReaderWrapper

    Nested classes/interfaces inherited from class org.apache.lucene.index.IndexReader

    org.apache.lucene.index.IndexReader.CacheHelper, org.apache.lucene.index.IndexReader.CacheKey, org.apache.lucene.index.IndexReader.ClosedListener

  • Field Summary

    Fields inherited from class org.apache.lucene.index.FilterDirectoryReader

    in

    Fields inherited from class org.apache.lucene.index.DirectoryReader

    directory

    Fields inherited from class org.apache.lucene.index.BaseCompositeReader

    subReadersSorter

  • Constructor Summary

    Constructors
    Constructor
    Description
    LazySoftDeletesDirectoryReaderWrapper​(org.apache.lucene.index.DirectoryReader in, String field)
    Creates a new soft deletes wrapper.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected org.apache.lucene.index.DirectoryReader
    doWrapDirectoryReader​(org.apache.lucene.index.DirectoryReader in)
     
    org.apache.lucene.index.IndexReader.CacheHelper
    getReaderCacheHelper()
     

    Methods inherited from class org.apache.lucene.index.FilterDirectoryReader

    doClose, doOpenIfChanged, doOpenIfChanged, doOpenIfChanged, getDelegate, getIndexCommit, getVersion, isCurrent, unwrap

    Methods inherited from class org.apache.lucene.index.DirectoryReader

    directory, indexExists, listCommits, open, open, open, open, open, openIfChanged, openIfChanged, openIfChanged, openIfChanged

    Methods inherited from class org.apache.lucene.index.BaseCompositeReader

    docFreq, document, getDocCount, getSequentialSubReaders, getSumDocFreq, getSumTotalTermFreq, getTermVectors, maxDoc, numDocs, readerBase, readerIndex, totalTermFreq

    Methods inherited from class org.apache.lucene.index.CompositeReader

    getContext, toString

    Methods inherited from class org.apache.lucene.index.IndexReader

    close, decRef, document, document, ensureOpen, equals, getRefCount, getTermVector, hasDeletions, hashCode, incRef, leaves, numDeletedDocs, registerParentReader, tryIncRef

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • LazySoftDeletesDirectoryReaderWrapper

      public LazySoftDeletesDirectoryReaderWrapper​(org.apache.lucene.index.DirectoryReader in, String field) throws IOException
      Creates a new soft deletes wrapper.
      Parameters:
      in - the incoming directory reader
      field - the soft deletes field
      Throws:
      IOException

  • Method Details

    • doWrapDirectoryReader

      protected org.apache.lucene.index.DirectoryReader doWrapDirectoryReader​(org.apache.lucene.index.DirectoryReader in) throws IOException
      Specified by:
      doWrapDirectoryReader in class org.apache.lucene.index.FilterDirectoryReader
      Throws:
      IOException

    • getReaderCacheHelper

      public org.apache.lucene.index.IndexReader.CacheHelper getReaderCacheHelper()
      Specified by:
      getReaderCacheHelper in class org.apache.lucene.index.IndexReader