Package io.substrait.expression

Class ImmutableAggregateFunctionInvocation.Builder

java.lang.Object

io.substrait.expression.ImmutableAggregateFunctionInvocation.Builder

Enclosing class:

ImmutableAggregateFunctionInvocation

public static final class ImmutableAggregateFunctionInvocation.Builder
extends Object

Builds instances of type ImmutableAggregateFunctionInvocation. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method	Description
final ImmutableAggregateFunctionInvocation.Builder	addAllArguments(Iterable<? extends FunctionArg> elements)	Adds elements to arguments list.
final ImmutableAggregateFunctionInvocation.Builder	addAllOptions(Iterable<? extends FunctionOption> elements)	Adds elements to options list.
final ImmutableAggregateFunctionInvocation.Builder	addAllSort(Iterable<? extends Expression.SortField> elements)	Adds elements to sort list.
final ImmutableAggregateFunctionInvocation.Builder	addArguments(FunctionArg element)	Adds one element to arguments list.
final ImmutableAggregateFunctionInvocation.Builder	addArguments(FunctionArg... elements)	Adds elements to arguments list.
final ImmutableAggregateFunctionInvocation.Builder	addOptions(FunctionOption element)	Adds one element to options list.
final ImmutableAggregateFunctionInvocation.Builder	addOptions(FunctionOption... elements)	Adds elements to options list.
final ImmutableAggregateFunctionInvocation.Builder	addSort(Expression.SortField element)	Adds one element to sort list.
final ImmutableAggregateFunctionInvocation.Builder	addSort(Expression.SortField... elements)	Adds elements to sort list.
final ImmutableAggregateFunctionInvocation.Builder	aggregationPhase(Expression.AggregationPhase aggregationPhase)	Initializes the value for the aggregationPhase attribute.
final ImmutableAggregateFunctionInvocation.Builder	arguments(Iterable<? extends FunctionArg> elements)	Sets or replaces all elements for arguments list.
ImmutableAggregateFunctionInvocation	build()	Builds a new ImmutableAggregateFunctionInvocation.
final ImmutableAggregateFunctionInvocation.Builder	declaration(SimpleExtension.AggregateFunctionVariant declaration)	Initializes the value for the declaration attribute.
final ImmutableAggregateFunctionInvocation.Builder	from(AggregateFunctionInvocation instance)	Fill a builder with attribute values from the provided AggregateFunctionInvocation instance.
final ImmutableAggregateFunctionInvocation.Builder	invocation(Expression.AggregationInvocation invocation)	Initializes the value for the invocation attribute.
final ImmutableAggregateFunctionInvocation.Builder	options(Iterable<? extends FunctionOption> elements)	Sets or replaces all elements for options list.
final ImmutableAggregateFunctionInvocation.Builder	outputType(Type outputType)	Initializes the value for the outputType attribute.
final ImmutableAggregateFunctionInvocation.Builder	sort(Iterable<? extends Expression.SortField> elements)	Sets or replaces all elements for sort list.

Methods inherited from class java.lang.Object

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

Method Details

from

public final ImmutableAggregateFunctionInvocation.Builder from(AggregateFunctionInvocation instance)

Fill a builder with attribute values from the provided AggregateFunctionInvocation instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values. Collection elements and entries will be added, not replaced.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

declaration

public final ImmutableAggregateFunctionInvocation.Builder declaration(SimpleExtension.AggregateFunctionVariant declaration)

Initializes the value for the declaration attribute.

Parameters:

declaration - The value for declaration

Returns:

this builder for use in a chained invocation

addArguments

public final ImmutableAggregateFunctionInvocation.Builder addArguments(FunctionArg element)

Adds one element to arguments list.

Parameters:

element - A arguments element

Returns:

this builder for use in a chained invocation

addArguments

public final ImmutableAggregateFunctionInvocation.Builder addArguments(FunctionArg... elements)

Adds elements to arguments list.

Parameters:

elements - An array of arguments elements

Returns:

this builder for use in a chained invocation

arguments

public final ImmutableAggregateFunctionInvocation.Builder arguments(Iterable<? extends FunctionArg> elements)

Sets or replaces all elements for arguments list.

Parameters:

elements - An iterable of arguments elements

Returns:

this builder for use in a chained invocation

addAllArguments

public final ImmutableAggregateFunctionInvocation.Builder addAllArguments(Iterable<? extends FunctionArg> elements)

Adds elements to arguments list.

Parameters:

elements - An iterable of arguments elements

Returns:

this builder for use in a chained invocation

addOptions

public final ImmutableAggregateFunctionInvocation.Builder addOptions(FunctionOption element)

Adds one element to options list.

Parameters:

element - A options element

Returns:

this builder for use in a chained invocation

addOptions

public final ImmutableAggregateFunctionInvocation.Builder addOptions(FunctionOption... elements)

Adds elements to options list.

Parameters:

elements - An array of options elements

Returns:

this builder for use in a chained invocation

options

public final ImmutableAggregateFunctionInvocation.Builder options(Iterable<? extends FunctionOption> elements)

Sets or replaces all elements for options list.

Parameters:

elements - An iterable of options elements

Returns:

this builder for use in a chained invocation

addAllOptions

public final ImmutableAggregateFunctionInvocation.Builder addAllOptions(Iterable<? extends FunctionOption> elements)

Adds elements to options list.

Parameters:

elements - An iterable of options elements

Returns:

this builder for use in a chained invocation

aggregationPhase

public final ImmutableAggregateFunctionInvocation.Builder aggregationPhase(Expression.AggregationPhase aggregationPhase)

Initializes the value for the aggregationPhase attribute.

Parameters:

aggregationPhase - The value for aggregationPhase

Returns:

this builder for use in a chained invocation

addSort

public final ImmutableAggregateFunctionInvocation.Builder addSort(Expression.SortField element)

Adds one element to sort list.

Parameters:

element - A sort element

Returns:

this builder for use in a chained invocation

addSort

public final ImmutableAggregateFunctionInvocation.Builder addSort(Expression.SortField... elements)

Adds elements to sort list.

Parameters:

elements - An array of sort elements

Returns:

this builder for use in a chained invocation

sort

public final ImmutableAggregateFunctionInvocation.Builder sort(Iterable<? extends Expression.SortField> elements)

Sets or replaces all elements for sort list.

Parameters:

elements - An iterable of sort elements

Returns:

this builder for use in a chained invocation

addAllSort

public final ImmutableAggregateFunctionInvocation.Builder addAllSort(Iterable<? extends Expression.SortField> elements)

Adds elements to sort list.

Parameters:

elements - An iterable of sort elements

Returns:

this builder for use in a chained invocation

outputType

public final ImmutableAggregateFunctionInvocation.Builder outputType(Type outputType)

Initializes the value for the outputType attribute.

Parameters:

outputType - The value for outputType

Returns:

this builder for use in a chained invocation

invocation

public final ImmutableAggregateFunctionInvocation.Builder invocation(Expression.AggregationInvocation invocation)

Initializes the value for the invocation attribute.

Parameters:

invocation - The value for invocation

Returns:

this builder for use in a chained invocation

build

public ImmutableAggregateFunctionInvocation build()

Builds a new ImmutableAggregateFunctionInvocation.

Returns:

An immutable instance of AggregateFunctionInvocation

Throws:

IllegalStateException - if any required attributes are missing