Package org.elasticsearch.common.lucene.index

Class ElasticsearchLeafReader

java.lang.Object
org.apache.lucene.index.IndexReader
org.apache.lucene.index.LeafReader
org.apache.lucene.index.FilterLeafReader
org.elasticsearch.common.lucene.index.SequentialStoredFieldsLeafReader
org.elasticsearch.common.lucene.index.ElasticsearchLeafReader
All Implemented Interfaces:
Closeable, AutoCloseable
public final class ElasticsearchLeafReader extends SequentialStoredFieldsLeafReader
A FilterLeafReader 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.FilterLeafReader

    org.apache.lucene.index.FilterLeafReader.FilterFields, org.apache.lucene.index.FilterLeafReader.FilterPostingsEnum, org.apache.lucene.index.FilterLeafReader.FilterTerms, org.apache.lucene.index.FilterLeafReader.FilterTermsEnum

    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.FilterLeafReader

    in

  • Constructor Summary

    Constructors
    Constructor
    Description
    ElasticsearchLeafReader(org.apache.lucene.index.LeafReader in, ShardId shardId)
    Construct a FilterLeafReader based on the specified base reader.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected org.apache.lucene.codecs.StoredFieldsReader
    doGetSequentialStoredFieldsReader(org.apache.lucene.codecs.StoredFieldsReader reader)
    Implementations should return a StoredFieldsReader that wraps the provided reader that is optimized for sequential access (adjacent doc ids).
    org.apache.lucene.index.IndexReader.CacheHelper
    getCoreCacheHelper()
     
    static ElasticsearchLeafReader
    getElasticsearchLeafReader(org.apache.lucene.index.LeafReader reader)
     
    org.apache.lucene.index.IndexReader.CacheHelper
    getReaderCacheHelper()
     
    ShardId
    shardId()
    Returns the shard id this segment belongs to.

    Methods inherited from class org.elasticsearch.common.lucene.index.SequentialStoredFieldsLeafReader

    getSequentialStoredFieldsReader

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

    checkIntegrity, doClose, document, getBinaryDocValues, getDelegate, getFieldInfos, getLiveDocs, getMetaData, getNormValues, getNumericDocValues, getPointValues, getSortedDocValues, getSortedNumericDocValues, getSortedSetDocValues, getTermVectors, maxDoc, numDocs, terms, toString, unwrap

    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, numDeletedDocs, registerParentReader, tryIncRef

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ElasticsearchLeafReader

      public ElasticsearchLeafReader(org.apache.lucene.index.LeafReader in, ShardId shardId)

      Construct a FilterLeafReader based on the specified base reader.

      Note that base reader is closed if this FilterLeafReader is closed.

      Parameters:
      in - specified base reader.

  • Method Details

    • shardId

      public ShardId shardId()
      Returns the shard id this segment belongs to.

    • getCoreCacheHelper

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

    • getReaderCacheHelper

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

    • getElasticsearchLeafReader

      public static ElasticsearchLeafReader getElasticsearchLeafReader(org.apache.lucene.index.LeafReader reader)

    • doGetSequentialStoredFieldsReader

      protected org.apache.lucene.codecs.StoredFieldsReader doGetSequentialStoredFieldsReader(org.apache.lucene.codecs.StoredFieldsReader reader)
      Description copied from class: SequentialStoredFieldsLeafReader
      Implementations should return a StoredFieldsReader that wraps the provided reader that is optimized for sequential access (adjacent doc ids).
      Specified by:
      doGetSequentialStoredFieldsReader in class SequentialStoredFieldsLeafReader