Module org.elasticsearch.compute

Package org.elasticsearch.compute.aggregation

Record Class WindowAggregatorFunctionSupplier

java.lang.Object

java.lang.Record

org.elasticsearch.compute.aggregation.WindowAggregatorFunctionSupplier

All Implemented Interfaces:

AggregatorFunctionSupplier, Describable

public record WindowAggregatorFunctionSupplier(AggregatorFunctionSupplier supplier, Duration window)
extends Record
implements AggregatorFunctionSupplier

A AggregatorFunctionSupplier that wraps another, and apply a window function on the final aggregation.

Constructor Summary

Constructors

Constructor	Description
WindowAggregatorFunctionSupplier(AggregatorFunctionSupplier supplier, Duration window)	Creates an instance of a WindowAggregatorFunctionSupplier record class.

Method Summary

Modifier and Type	Method	Description
AggregatorFunction	aggregator(DriverContext driverContext, List<Integer> channels)
String	describe()	Returns a description of the component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
GroupingAggregatorFunction	groupingAggregator(DriverContext driverContext, List<Integer> channels)
List<IntermediateStateDesc>	groupingIntermediateStateDesc()
final int	hashCode()	Returns a hash code value for this object.
List<IntermediateStateDesc>	nonGroupingIntermediateStateDesc()
AggregatorFunctionSupplier	supplier()	Returns the value of the supplier record component.
final String	toString()	Returns a string representation of this record class.
Duration	window()	Returns the value of the window record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.compute.aggregation.AggregatorFunctionSupplier

aggregatorFactory, groupingAggregatorFactory

Constructor Details

WindowAggregatorFunctionSupplier

public WindowAggregatorFunctionSupplier(AggregatorFunctionSupplier supplier,
 Duration window)

Creates an instance of a WindowAggregatorFunctionSupplier record class.

Parameters:

supplier - the value for the supplier record component

window - the value for the window record component

Method Details

nonGroupingIntermediateStateDesc

public List<IntermediateStateDesc> nonGroupingIntermediateStateDesc()

Specified by:

nonGroupingIntermediateStateDesc in interface AggregatorFunctionSupplier

groupingIntermediateStateDesc

public List<IntermediateStateDesc> groupingIntermediateStateDesc()

Specified by:

groupingIntermediateStateDesc in interface AggregatorFunctionSupplier

aggregator

public AggregatorFunction aggregator(DriverContext driverContext,
 List<Integer> channels)

Specified by:

aggregator in interface AggregatorFunctionSupplier

groupingAggregator

public GroupingAggregatorFunction groupingAggregator(DriverContext driverContext,
 List<Integer> channels)

Specified by:

groupingAggregator in interface AggregatorFunctionSupplier

describe

public String describe()

Description copied from interface: Describable

Returns a description of the component. This description can be more specific than Object::toString.

Specified by:

describe in interface Describable

Returns:

the description

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

supplier

public AggregatorFunctionSupplier supplier()

Returns the value of the supplier record component.

Returns:

the value of the supplier record component

window

public Duration window()

Returns the value of the window record component.

Returns:

the value of the window record component