Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Interface BlockLoader

All Known Implementing Classes:

AbstractBooleansBlockLoader, AbstractBytesRefsFromOrdsBlockLoader, AbstractDoublesFromDocValuesBlockLoader, AbstractIntsFromDocValuesBlockLoader, AbstractLongsFromDocValuesBlockLoader, AbstractShapeGeometryFieldMapper.AbstractShapeGeometryFieldType.BoundsBlockLoader, BlockDocValuesReader.DocValuesBlockLoader, BlockLoader.Delegating, BlockSourceReader.BooleansBlockLoader, BlockSourceReader.BytesRefsBlockLoader, BlockSourceReader.DenseVectorBlockLoader, BlockSourceReader.DoublesBlockLoader, BlockSourceReader.GeometriesBlockLoader, BlockSourceReader.IntsBlockLoader, BlockSourceReader.IpsBlockLoader, BlockSourceReader.LongsBlockLoader, BlockStoredFieldsReader.BytesFromBytesRefsBlockLoader, BlockStoredFieldsReader.BytesFromStringsBlockLoader, BlockStoredFieldsReader.IdBlockLoader, BlockStoredFieldsReader.StoredFieldsBlockLoader, BooleansBlockLoader, BytesRefsFromBinaryBlockLoader, BytesRefsFromCustomBinaryBlockLoader, BytesRefsFromOrdsBlockLoader, DenseVectorBlockLoader, DenseVectorFromBinaryBlockLoader, DoublesBlockLoader, FallbackSyntheticSourceBlockLoader, IntsBlockLoader, LongsBlockLoader, MvMaxBooleansBlockLoader, MvMaxBytesRefsFromOrdsBlockLoader, MvMaxDoublesFromDocValuesBlockLoader, MvMaxIntsFromDocValuesBlockLoader, MvMaxLongsFromDocValuesBlockLoader, MvMinBooleansBlockLoader, MvMinBytesRefsFromOrdsBlockLoader, MvMinDoublesFromDocValuesBlockLoader, MvMinIntsFromDocValuesBlockLoader, MvMinLongsFromDocValuesBlockLoader, SourceFieldBlockLoader, Utf8CodePointsFromOrdsBlockLoader

public interface BlockLoader

Interface for loading data in a block shape. Instances of this class must be immutable and thread safe.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	BlockLoader.AggregateMetricDoubleBuilder
static interface	BlockLoader.AllReader
static interface	BlockLoader.Block	Marker interface for block results.
static interface	BlockLoader.BlockFactory	Builds block "builders" for loading data into blocks for the compute engine.
static interface	BlockLoader.BooleanBuilder
static interface	BlockLoader.Builder	A builder for typed values.
static interface	BlockLoader.BytesRefBuilder
static interface	BlockLoader.ColumnAtATimeReader
static class	BlockLoader.ConstantNullsReader	Implementation of BlockLoader.ColumnAtATimeReader and BlockLoader.RowStrideReader that always loads null.
static class	BlockLoader.Delegating
static interface	BlockLoader.Docs	A list of documents to load.
static interface	BlockLoader.DoubleBuilder
static interface	BlockLoader.ExponentialHistogramBuilder
static interface	BlockLoader.FloatBuilder
static interface	BlockLoader.IntBuilder
static interface	BlockLoader.LongBuilder
static interface	BlockLoader.OptionalColumnAtATimeReader	An interface for readers that attempt to load all document values in a column-at-a-time fashion.
static interface	BlockLoader.Reader
static interface	BlockLoader.RowStrideReader
static interface	BlockLoader.SingletonBytesRefBuilder	Specialized builder for collecting dense arrays of BytesRef values.
static interface	BlockLoader.SingletonDoubleBuilder	Specialized builder for collecting dense arrays of double values.
static interface	BlockLoader.SingletonIntBuilder	Specialized builder for collecting dense arrays of double values.
static interface	BlockLoader.SingletonLongBuilder	Specialized builder for collecting dense arrays of long values.
static interface	BlockLoader.SingletonOrdinalsBuilder
static interface	BlockLoader.SortedSetOrdinalsBuilder
static interface	BlockLoader.StoredFields

Field Summary

Fields

Modifier and Type	Field	Description
static final BlockLoader	CONSTANT_NULLS	Load blocks with only null.

Method Summary

Modifier and Type	Method	Description
BlockLoader.Builder	builder(BlockLoader.BlockFactory factory, int expectedCount)	The BlockLoader.Builder for data of this type.
BlockLoader.ColumnAtATimeReader	columnAtATimeReader(org.apache.lucene.index.LeafReaderContext context)
static BlockLoader	constantBytes(org.apache.lucene.util.BytesRef value)	Load blocks with only value.
default BlockLoader.Block	convert(BlockLoader.Block block)	In support of 'Union Types', we sometimes desire that Blocks loaded from source are immediately converted in some way.
org.apache.lucene.index.SortedSetDocValues	ordinals(org.apache.lucene.index.LeafReaderContext context)	Load ordinals for the provided context.
BlockLoader.RowStrideReader	rowStrideReader(org.apache.lucene.index.LeafReaderContext context)
StoredFieldsSpec	rowStrideStoredFieldSpec()
boolean	supportsOrdinals()	Does this loader support loading bytes via calling ordinals(org.apache.lucene.index.LeafReaderContext).

Field Details

CONSTANT_NULLS

static final BlockLoader CONSTANT_NULLS

Load blocks with only null.

Method Details

builder

BlockLoader.Builder builder(BlockLoader.BlockFactory factory,
 int expectedCount)

The BlockLoader.Builder for data of this type. Called when loading from a multi-segment or unsorted block.

columnAtATimeReader

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

Throws:

IOException

rowStrideReader

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

Throws:

IOException

rowStrideStoredFieldSpec

StoredFieldsSpec rowStrideStoredFieldSpec()

supportsOrdinals

boolean supportsOrdinals()

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

ordinals

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

Load ordinals for the provided context.

Throws:

IOException

convert

default BlockLoader.Block convert(BlockLoader.Block block)

In support of 'Union Types', we sometimes desire that Blocks loaded from source are immediately converted in some way. Typically, this would be a type conversion, or an encoding conversion.

Parameters:

block - original block loaded from source

Returns:

converted block (or original if no conversion required)

constantBytes

static BlockLoader constantBytes(org.apache.lucene.util.BytesRef value)

Load blocks with only value.