Package org.elasticsearch.xpack.esql.evaluator.command

Class CompoundOutputEvaluator

java.lang.Object

org.elasticsearch.xpack.esql.evaluator.command.CompoundOutputEvaluator

All Implemented Interfaces:

ColumnExtractOperator.Evaluator

public final class CompoundOutputEvaluator
extends Object
implements ColumnExtractOperator.Evaluator

The base evaluator that extracts compound output. Subclasses should implement the actual evaluation logic.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	CompoundOutputEvaluator.Factory
static interface	CompoundOutputEvaluator.GeoPointCollector
static enum	CompoundOutputEvaluator.MultiValueStrategy
static interface	CompoundOutputEvaluator.ObjBooleanConsumer<T>
static class	CompoundOutputEvaluator.OutputFieldsCollector	The base class for output fields collectors.
static interface	CompoundOutputEvaluator.OutputFieldsCollectorProvider
static final class	CompoundOutputEvaluator.RowOutput	A Block.Builder holder that is being set before each row evaluation.

Field Summary

Fields

Modifier and Type	Field	Description
static final CompoundOutputEvaluator.ObjBooleanConsumer<CompoundOutputEvaluator.RowOutput>	NOOP_BOOLEAN_COLLECTOR
static final CompoundOutputEvaluator.GeoPointCollector	NOOP_GEO_POINT_COLLECTOR
static final ObjIntConsumer<CompoundOutputEvaluator.RowOutput>	NOOP_INT_COLLECTOR
static final ObjLongConsumer<CompoundOutputEvaluator.RowOutput>	NOOP_LONG_COLLECTOR
static final BiConsumer<CompoundOutputEvaluator.RowOutput,String>	NOOP_STRING_COLLECTOR

Method Summary

Modifier and Type	Method	Description
static CompoundOutputEvaluator.ObjBooleanConsumer<CompoundOutputEvaluator.RowOutput>	booleanValueCollector(int index)
void	computeRow(BytesRefBlock input, int row, Block.Builder[] target, org.apache.lucene.util.BytesRef spare)	Executes the evaluation of the corresponding function on the provided input.
static CompoundOutputEvaluator.GeoPointCollector	geoPointValueCollector(int index)
static ObjIntConsumer<CompoundOutputEvaluator.RowOutput>	intValueCollector(int index, IntPredicate predicate)	Creates a collector for primitive int values.
static ObjLongConsumer<CompoundOutputEvaluator.RowOutput>	longValueCollector(int index)
static BiConsumer<CompoundOutputEvaluator.RowOutput,String>	stringValueCollector(int index)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

NOOP_STRING_COLLECTOR

public static final BiConsumer<CompoundOutputEvaluator.RowOutput,String> NOOP_STRING_COLLECTOR

NOOP_INT_COLLECTOR

public static final ObjIntConsumer<CompoundOutputEvaluator.RowOutput> NOOP_INT_COLLECTOR

NOOP_LONG_COLLECTOR

public static final ObjLongConsumer<CompoundOutputEvaluator.RowOutput> NOOP_LONG_COLLECTOR

NOOP_BOOLEAN_COLLECTOR

public static final CompoundOutputEvaluator.ObjBooleanConsumer<CompoundOutputEvaluator.RowOutput> NOOP_BOOLEAN_COLLECTOR

NOOP_GEO_POINT_COLLECTOR

public static final CompoundOutputEvaluator.GeoPointCollector NOOP_GEO_POINT_COLLECTOR

Method Details

computeRow

public void computeRow(BytesRefBlock input,
 int row,
 Block.Builder[] target,
 org.apache.lucene.util.BytesRef spare)

Executes the evaluation of the corresponding function on the provided input. The target output array must have the same size as the functionOutputFields list that was provided in construction, and its elements must match this list's entries in type and order. Otherwise, this method will throw an exception. If an expected output field is missing from the actual output of the function, a null value will be appended to the corresponding target block. If the actual output of the function contains an entry that is not expected, it will be ignored.

Specified by:

computeRow in interface ColumnExtractOperator.Evaluator

Parameters:

input - the input to evaluate the function on

row - row index in the input

target - the output column blocks

spare - the BytesRef to use for value retrieval

toString

public String toString()

Overrides:

toString in class Object

stringValueCollector

public static BiConsumer<CompoundOutputEvaluator.RowOutput,String> stringValueCollector(int index)

intValueCollector

public static ObjIntConsumer<CompoundOutputEvaluator.RowOutput> intValueCollector(int index,
 IntPredicate predicate)

Creates a collector for primitive int values.

Parameters:

index - the index of the corresponding block in the target array

predicate - the predicate to apply on the int value to determine whether to append it or a null

Returns:

a primitive int collector

longValueCollector

public static ObjLongConsumer<CompoundOutputEvaluator.RowOutput> longValueCollector(int index)

booleanValueCollector

public static CompoundOutputEvaluator.ObjBooleanConsumer<CompoundOutputEvaluator.RowOutput> booleanValueCollector(int index)

geoPointValueCollector

public static CompoundOutputEvaluator.GeoPointCollector geoPointValueCollector(int index)