Module org.elasticsearch.server

Package org.elasticsearch.index.mapper.blockloader.docvalues

Class BlockDocValuesReader.DocValuesBlockLoader

java.lang.Object

org.elasticsearch.index.mapper.blockloader.docvalues.BlockDocValuesReader.DocValuesBlockLoader

All Implemented Interfaces:

BlockLoader

Direct Known Subclasses:

AbstractBooleansBlockLoader, AbstractBytesRefsFromOrdsBlockLoader, AbstractDoublesFromDocValuesBlockLoader, AbstractIntsFromDocValuesBlockLoader, AbstractLongsFromDocValuesBlockLoader, AbstractShapeGeometryFieldMapper.AbstractShapeGeometryFieldType.BoundsAndCentroidBlockLoader, AbstractShapeGeometryFieldMapper.AbstractShapeGeometryFieldType.BoundsBlockLoader, AbstractShapeGeometryFieldMapper.AbstractShapeGeometryFieldType.CentroidBlockLoader, ByteLengthFromBytesRefDocValuesBlockLoader, BytesRefsFromBinaryBlockLoader, BytesRefsFromBinaryMultiSeparateCountBlockLoader, BytesRefsFromCustomBinaryBlockLoader, DateRangeDocValuesLoader, DenseVectorBlockLoader, DenseVectorFromBinaryBlockLoader, GeoBytesRefFromLongsBlockLoader, KeyedFlattenedDocValuesBlockLoader, MvMaxBytesRefsFromBinaryBlockLoader, MvMinBytesRefsFromBinaryBlockLoader, Utf8CodePointsFromOrdsBlockLoader

Enclosing class:

BlockDocValuesReader

public abstract static class BlockDocValuesReader.DocValuesBlockLoader
extends Object
implements BlockLoader

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.index.mapper.BlockLoader

BlockLoader.AggregateMetricDoubleBuilder, BlockLoader.Block, BlockLoader.BlockFactory, BlockLoader.BooleanBuilder, BlockLoader.Builder, BlockLoader.BytesRefBuilder, BlockLoader.ColumnAtATimeReader, BlockLoader.ConditionalBlockLoader, BlockLoader.Docs, BlockLoader.DoubleBuilder, BlockLoader.ExponentialHistogramBuilder, BlockLoader.FloatBuilder, BlockLoader.IntBuilder, BlockLoader.LongBuilder, BlockLoader.LongRangeBuilder, BlockLoader.OptionalColumnAtATimeReader, BlockLoader.OptionalLengthReader, BlockLoader.Reader, BlockLoader.RowStrideReader, BlockLoader.SingletonBytesRefBuilder, BlockLoader.SingletonDoubleBuilder, BlockLoader.SingletonIntBuilder, BlockLoader.SingletonLongBuilder, BlockLoader.SingletonOrdinalsBuilder, BlockLoader.SortedSetOrdinalsBuilder, BlockLoader.StoredFields, BlockLoader.TDigestBuilder

Constructor Summary

Constructors

Constructor	Description
DocValuesBlockLoader()

Method Summary

Modifier and Type	Method	Description
final org.apache.lucene.util.IOFunction<CircuitBreaker,BlockLoader.ColumnAtATimeReader>	columnAtATimeReader(org.apache.lucene.index.LeafReaderContext context)	Build a column-at-a-time reader.
org.apache.lucene.index.SortedSetDocValues	ordinals(org.apache.lucene.index.LeafReaderContext context)	Load ordinals for the provided context.
abstract BlockLoader.ColumnAtATimeReader	reader(CircuitBreaker breaker, org.apache.lucene.index.LeafReaderContext context)
BlockLoader.RowStrideReader	rowStrideReader(CircuitBreaker breaker, org.apache.lucene.index.LeafReaderContext context)	Build a row-by-row reader.
final StoredFieldsSpec	rowStrideStoredFieldSpec()	What stored fields are needed by this reader.
boolean	supportsOrdinals()	Does this loader support loading bytes via calling BlockLoader.ordinals(org.apache.lucene.index.LeafReaderContext).

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.index.mapper.BlockLoader

builder

Constructor Details

DocValuesBlockLoader

public DocValuesBlockLoader()

Method Details

reader

public abstract BlockLoader.ColumnAtATimeReader reader(CircuitBreaker breaker,
 org.apache.lucene.index.LeafReaderContext context)
                                                throws IOException

Throws:

IOException

columnAtATimeReader

public final org.apache.lucene.util.IOFunction<CircuitBreaker,BlockLoader.ColumnAtATimeReader> columnAtATimeReader(org.apache.lucene.index.LeafReaderContext context)

Description copied from interface: BlockLoader

Build a column-at-a-time reader. May return null if the underlying storage needs to be loaded row-by-row. Callers should try this first, only falling back to BlockLoader.rowStrideReader(org.elasticsearch.common.breaker.CircuitBreaker, org.apache.lucene.index.LeafReaderContext) if this returns null. If this returns null then BlockLoader.rowStrideReader(org.elasticsearch.common.breaker.CircuitBreaker, org.apache.lucene.index.LeafReaderContext) may not.

Specified by:

columnAtATimeReader in interface BlockLoader

rowStrideReader

public BlockLoader.RowStrideReader rowStrideReader(CircuitBreaker breaker,
 org.apache.lucene.index.LeafReaderContext context)
                                            throws IOException

Description copied from interface: BlockLoader

Build a row-by-row reader. May return null if the underlying storage prefers to be loaded column-at-a-time. Callers should try BlockLoader.columnAtATimeReader(org.apache.lucene.index.LeafReaderContext) first, only falling back to this if BlockLoader.columnAtATimeReader(org.apache.lucene.index.LeafReaderContext) returns null. This may not return null if BlockLoader.columnAtATimeReader(org.apache.lucene.index.LeafReaderContext) does.

Specified by:

rowStrideReader in interface BlockLoader

Throws:

IOException

rowStrideStoredFieldSpec

public final StoredFieldsSpec rowStrideStoredFieldSpec()

Description copied from interface: BlockLoader

What stored fields are needed by this reader.

Specified by:

rowStrideStoredFieldSpec in interface BlockLoader

supportsOrdinals

public boolean supportsOrdinals()

Description copied from interface: BlockLoader

Does this loader support loading bytes via calling BlockLoader.ordinals(org.apache.lucene.index.LeafReaderContext).

Specified by:

supportsOrdinals in interface BlockLoader

ordinals

public org.apache.lucene.index.SortedSetDocValues ordinals(org.apache.lucene.index.LeafReaderContext context)
                                                    throws IOException

Description copied from interface: BlockLoader

Load ordinals for the provided context.

Specified by:

ordinals in interface BlockLoader

Throws:

IOException