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.BoundsBlockLoader, BytesRefsFromBinaryBlockLoader, BytesRefsFromCustomBinaryBlockLoader, DenseVectorBlockLoader, DenseVectorFromBinaryBlockLoader, 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.AllReader, BlockLoader.Block, BlockLoader.BlockFactory, BlockLoader.BooleanBuilder, BlockLoader.Builder, BlockLoader.BytesRefBuilder, BlockLoader.ColumnAtATimeReader, BlockLoader.ConstantNullsReader, BlockLoader.Delegating, BlockLoader.Docs, BlockLoader.DoubleBuilder, BlockLoader.ExponentialHistogramBuilder, BlockLoader.FloatBuilder, BlockLoader.IntBuilder, BlockLoader.LongBuilder, BlockLoader.OptionalColumnAtATimeReader, BlockLoader.Reader, BlockLoader.RowStrideReader, BlockLoader.SingletonBytesRefBuilder, BlockLoader.SingletonDoubleBuilder, BlockLoader.SingletonIntBuilder, BlockLoader.SingletonLongBuilder, BlockLoader.SingletonOrdinalsBuilder, BlockLoader.SortedSetOrdinalsBuilder, BlockLoader.StoredFields, BlockLoader.TDigestBuilder

Field Summary

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

CONSTANT_NULLS

Constructor Summary

Constructors

Constructor	Description
DocValuesBlockLoader()

Method Summary

Modifier and Type	Method	Description
final 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.AllReader	reader(org.apache.lucene.index.LeafReaderContext context)
final BlockLoader.RowStrideReader	rowStrideReader(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, convert

Constructor Details

DocValuesBlockLoader

public DocValuesBlockLoader()

Method Details

reader

public abstract BlockLoader.AllReader reader(org.apache.lucene.index.LeafReaderContext context)
                                      throws IOException

Throws:

IOException

columnAtATimeReader

public final BlockLoader.ColumnAtATimeReader columnAtATimeReader(org.apache.lucene.index.LeafReaderContext context)
                                                          throws IOException

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.apache.lucene.index.LeafReaderContext) if this returns null or if they can't load column-at-a-time themselves.

Specified by:

columnAtATimeReader in interface BlockLoader

Throws:

IOException

rowStrideReader

public final BlockLoader.RowStrideReader rowStrideReader(org.apache.lucene.index.LeafReaderContext context)
                                                  throws IOException

Description copied from interface: BlockLoader

Build a row-by-row reader. Must never return null, evan if the underlying storage prefers to be loaded column-at-a-time. Some callers simply can't load column-at-a-time so all implementations must support this method.

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