Class SequentialStoredFieldsLeafReader
java.lang.Object
org.apache.lucene.index.IndexReader
org.apache.lucene.index.LeafReader
org.apache.lucene.index.FilterLeafReader
org.elasticsearch.common.lucene.index.SequentialStoredFieldsLeafReader
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
- Direct Known Subclasses:
ElasticsearchLeafReader
public abstract class SequentialStoredFieldsLeafReader
extends org.apache.lucene.index.FilterLeafReader
A
FilterLeafReader
that exposes a StoredFieldsReader
optimized for sequential access. This class should be used by custom
FilterLeafReader
that are used at search time in order to
leverage sequential access when retrieving stored fields in queries,
aggregations or during the fetch phase.-
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
-
Field Summary
-
Constructor Summary
Constructors Constructor Description SequentialStoredFieldsLeafReader(org.apache.lucene.index.LeafReader in)
Construct a StoredFieldsFilterLeafReader based on the specified base reader. -
Method Summary
Modifier and Type Method Description protected abstract org.apache.lucene.codecs.StoredFieldsReader
doGetSequentialStoredFieldsReader(org.apache.lucene.codecs.StoredFieldsReader reader)
Implementations should return aStoredFieldsReader
that wraps the providedreader
that is optimized for sequential access (adjacent doc ids).org.apache.lucene.codecs.StoredFieldsReader
getSequentialStoredFieldsReader()
Returns aStoredFieldsReader
optimized for sequential access (adjacent doc ids).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, getCoreCacheHelper, getDocCount, getSumDocFreq, getSumTotalTermFreq, postings, postings, totalTermFreq
-
Constructor Details
-
SequentialStoredFieldsLeafReader
public SequentialStoredFieldsLeafReader(org.apache.lucene.index.LeafReader in)Construct a StoredFieldsFilterLeafReader based on the specified base reader.
Note that base reader is closed if this FilterLeafReader is closed.
- Parameters:
in
- specified base reader.
-
-
Method Details
-
doGetSequentialStoredFieldsReader
protected abstract org.apache.lucene.codecs.StoredFieldsReader doGetSequentialStoredFieldsReader(org.apache.lucene.codecs.StoredFieldsReader reader)Implementations should return aStoredFieldsReader
that wraps the providedreader
that is optimized for sequential access (adjacent doc ids). -
getSequentialStoredFieldsReader
public org.apache.lucene.codecs.StoredFieldsReader getSequentialStoredFieldsReader() throws java.io.IOExceptionReturns aStoredFieldsReader
optimized for sequential access (adjacent doc ids).- Throws:
java.io.IOException
-