Package org.apache.lucene.index

Class ReaderManager

java.lang.Object

org.apache.lucene.search.ReferenceManager<DirectoryReader>

org.apache.lucene.index.ReaderManager

All Implemented Interfaces:

Closeable, AutoCloseable

public final class ReaderManager
extends ReferenceManager<DirectoryReader>

Utility class to safely share DirectoryReader instances across multiple threads, while periodically reopening. This class ensures each reader is closed only once all threads have finished using it.

See Also:

SearcherManager

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.search.ReferenceManager

ReferenceManager.RefreshListener

Constructor Summary

Constructors

Constructor	Description
ReaderManager(IndexWriter writer, boolean applyAllDeletes)	Creates and returns a new ReaderManager from the given IndexWriter.
ReaderManager(Directory dir)	Creates and returns a new ReaderManager from the given Directory.

Method Summary

Methods inherited from class org.apache.lucene.search.ReferenceManager

acquire, addListener, close, maybeRefresh, maybeRefreshBlocking, release, removeListener

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReaderManager

public ReaderManager(IndexWriter writer,
                     boolean applyAllDeletes)
              throws IOException

Creates and returns a new ReaderManager from the given IndexWriter.

Parameters:

writer - the IndexWriter to open the IndexReader from.

applyAllDeletes - If true, all buffered deletes will be applied (made visible) in the IndexSearcher / DirectoryReader. If false, the deletes may or may not be applied, but remain buffered (in IndexWriter) so that they will be applied in the future. Applying deletes can be costly, so if your app can tolerate deleted documents being returned you might gain some performance by passing false. See DirectoryReader.openIfChanged(DirectoryReader, IndexWriter, boolean).

Throws:

IOException - If there is a low-level I/O error

ReaderManager

public ReaderManager(Directory dir)
              throws IOException

Creates and returns a new ReaderManager from the given Directory.

Parameters:

dir - the directory to open the DirectoryReader on.

Throws:

IOException - If there is a low-level I/O error