Package org.elasticsearch.common.lucene.index

Class ElasticsearchDirectoryReader

java.lang.Object

org.apache.lucene.index.IndexReader

org.apache.lucene.index.CompositeReader

org.apache.lucene.index.BaseCompositeReader<LeafReader>

org.apache.lucene.index.DirectoryReader

org.apache.lucene.index.FilterDirectoryReader

org.elasticsearch.common.lucene.index.ElasticsearchDirectoryReader

All Implemented Interfaces:

Closeable, AutoCloseable

public final class ElasticsearchDirectoryReader
extends FilterDirectoryReader

A FilterDirectoryReader that exposes Elasticsearch internal per shard / index information like the shard ID.

Nested Class Summary

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

IndexReader.CacheHelper, IndexReader.CacheKey, IndexReader.ClosedListener

Field Summary

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

in

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

directory

Method Summary

Modifier and Type	Method	Description
static void	addReaderCloseListener(DirectoryReader reader, IndexReader.ClosedListener listener)	Adds the given listener to the provided directory reader.
protected DirectoryReader	doWrapDirectoryReader(DirectoryReader in)	Called by the doOpenIfChanged() methods to return a new wrapped DirectoryReader.
static ElasticsearchDirectoryReader	getElasticsearchDirectoryReader(DirectoryReader reader)	Tries to unwrap the given reader until the first ElasticsearchDirectoryReader instance is found or null if no instance is found.
IndexReader.CacheHelper	getReaderCacheHelper()	Optional method: Return a IndexReader.CacheHelper that can be used to cache based on the content of this reader.
ShardId	shardId()	Returns the shard id this index belongs to.
static ElasticsearchDirectoryReader	wrap(DirectoryReader reader, ShardId shardId)	Wraps the given reader in a ElasticsearchDirectoryReader as well as all it's sub-readers in ElasticsearchLeafReader to expose the given shard Id.

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, 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

Method Detail

shardId

public ShardId shardId()

Returns the shard id this index belongs to.

getReaderCacheHelper

public IndexReader.CacheHelper getReaderCacheHelper()

Description copied from class: IndexReader

Optional method: Return a IndexReader.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 class IndexReader

doWrapDirectoryReader

protected DirectoryReader doWrapDirectoryReader(DirectoryReader in)
                                         throws IOException

Description copied from class: FilterDirectoryReader

Called by the doOpenIfChanged() methods to return a new wrapped DirectoryReader. Implementations should just return an instantiation of themselves, wrapping the passed in DirectoryReader.

Specified by:

doWrapDirectoryReader in class FilterDirectoryReader

Parameters:

in - the DirectoryReader to wrap

Returns:

the wrapped DirectoryReader

Throws:

IOException

wrap

public static ElasticsearchDirectoryReader wrap(DirectoryReader reader,
                                                ShardId shardId)
                                         throws IOException

Wraps the given reader in a ElasticsearchDirectoryReader as well as all it's sub-readers in ElasticsearchLeafReader to expose the given shard Id.

Parameters:

reader - the reader to wrap

shardId - the shard ID to expose via the elasticsearch internal reader wrappers.

Throws:

IOException

addReaderCloseListener

public static void addReaderCloseListener(DirectoryReader reader,
                                          IndexReader.ClosedListener listener)

Adds the given listener to the provided directory reader. The reader must contain an ElasticsearchDirectoryReader in it's hierarchy otherwise we can't safely install the listener.

Throws:

IllegalArgumentException - if the reader doesn't contain an ElasticsearchDirectoryReader in it's hierarchy

getElasticsearchDirectoryReader

public static ElasticsearchDirectoryReader getElasticsearchDirectoryReader(DirectoryReader reader)

Tries to unwrap the given reader until the first ElasticsearchDirectoryReader instance is found or null if no instance is found.