IndexWriter.IndexReaderWarmer (Jackrabbit Oak 1.78.0 API)

java.lang.Object
- org.apache.lucene.index.IndexWriter.IndexReaderWarmer

Direct Known Subclasses:

SimpleMergedSegmentWarmer

Enclosing class:

IndexWriter
```
public abstract static class IndexWriter.IndexReaderWarmer
extends Object
```
If DirectoryReader.open(IndexWriter,boolean) has been called (ie, this writer is in near real-time mode), then after a merge completes, this class can be invoked to warm the reader on the newly merged segment, before the merge commits. This is not required for near real-time search, but will reduce search latency on opening a new near real-time reader after a merge completes.

Constructor Summary

Constructors
Modifier Constructor Description

protected IndexReaderWarmer()
Sole constructor.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`abstract void`	`warm(AtomicReader reader)`	Invoked on the `AtomicReader` for the newly merged segment, before that segment is made visible to near-real-time readers.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IndexReaderWarmer
```
protected IndexReaderWarmer()
```
    Sole constructor. (For invocation by subclass constructors, typically implicit.)
- Method Detail
  - warm
```
public abstract void warm(AtomicReader reader)
                   throws IOException
```
    Invoked on the AtomicReader for the newly merged segment, before that segment is made visible to near-real-time readers.
    
    Throws:
    
    IOException