Package io.substrait.expression

Class ImmutableExpression.WindowFunctionInvocation.Builder

java.lang.Object

io.substrait.expression.ImmutableExpression.WindowFunctionInvocation.Builder

Enclosing class:

ImmutableExpression.WindowFunctionInvocation

public static final class ImmutableExpression.WindowFunctionInvocation.Builder
extends Object

Builds instances of type WindowFunctionInvocation. 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 ImmutableExpression.WindowFunctionInvocation.Builder	addAllArguments(Iterable<? extends FunctionArg> elements)	Adds elements to arguments list.
final ImmutableExpression.WindowFunctionInvocation.Builder	addAllOptions(Iterable<? extends FunctionOption> elements)	Adds elements to options list.
final ImmutableExpression.WindowFunctionInvocation.Builder	addAllPartitionBy(Iterable<? extends Expression> elements)	Adds elements to partitionBy list.
final ImmutableExpression.WindowFunctionInvocation.Builder	addAllSort(Iterable<? extends Expression.SortField> elements)	Adds elements to sort list.
final ImmutableExpression.WindowFunctionInvocation.Builder	addArguments(FunctionArg element)	Adds one element to arguments list.
final ImmutableExpression.WindowFunctionInvocation.Builder	addArguments(FunctionArg... elements)	Adds elements to arguments list.
final ImmutableExpression.WindowFunctionInvocation.Builder	addOptions(FunctionOption element)	Adds one element to options list.
final ImmutableExpression.WindowFunctionInvocation.Builder	addOptions(FunctionOption... elements)	Adds elements to options list.
final ImmutableExpression.WindowFunctionInvocation.Builder	addPartitionBy(Expression element)	Adds one element to partitionBy list.
final ImmutableExpression.WindowFunctionInvocation.Builder	addPartitionBy(Expression... elements)	Adds elements to partitionBy list.
final ImmutableExpression.WindowFunctionInvocation.Builder	addSort(Expression.SortField element)	Adds one element to sort list.
final ImmutableExpression.WindowFunctionInvocation.Builder	addSort(Expression.SortField... elements)	Adds elements to sort list.
final ImmutableExpression.WindowFunctionInvocation.Builder	aggregationPhase(Expression.AggregationPhase aggregationPhase)	Initializes the value for the aggregationPhase attribute.
final ImmutableExpression.WindowFunctionInvocation.Builder	arguments(Iterable<? extends FunctionArg> elements)	Sets or replaces all elements for arguments list.
final ImmutableExpression.WindowFunctionInvocation.Builder	boundsType(Expression.WindowBoundsType boundsType)	Initializes the value for the boundsType attribute.
ImmutableExpression.WindowFunctionInvocation	build()	Builds a new WindowFunctionInvocation.
final ImmutableExpression.WindowFunctionInvocation.Builder	declaration(SimpleExtension.WindowFunctionVariant declaration)	Initializes the value for the declaration attribute.
final ImmutableExpression.WindowFunctionInvocation.Builder	from(Expression.WindowFunctionInvocation instance)	Fill a builder with attribute values from the provided WindowFunctionInvocation instance.
final ImmutableExpression.WindowFunctionInvocation.Builder	invocation(Expression.AggregationInvocation invocation)	Initializes the value for the invocation attribute.
final ImmutableExpression.WindowFunctionInvocation.Builder	lowerBound(WindowBound lowerBound)	Initializes the value for the lowerBound attribute.
final ImmutableExpression.WindowFunctionInvocation.Builder	options(Iterable<? extends FunctionOption> elements)	Sets or replaces all elements for options list.
final ImmutableExpression.WindowFunctionInvocation.Builder	outputType(Type outputType)	Initializes the value for the outputType attribute.
final ImmutableExpression.WindowFunctionInvocation.Builder	partitionBy(Iterable<? extends Expression> elements)	Sets or replaces all elements for partitionBy list.
final ImmutableExpression.WindowFunctionInvocation.Builder	sort(Iterable<? extends Expression.SortField> elements)	Sets or replaces all elements for sort list.
final ImmutableExpression.WindowFunctionInvocation.Builder	upperBound(WindowBound upperBound)	Initializes the value for the upperBound attribute.

Methods inherited from class java.lang.Object

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

Method Details

from

public final ImmutableExpression.WindowFunctionInvocation.Builder from(Expression.WindowFunctionInvocation instance)

Fill a builder with attribute values from the provided WindowFunctionInvocation 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 ImmutableExpression.WindowFunctionInvocation.Builder declaration(SimpleExtension.WindowFunctionVariant 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 ImmutableExpression.WindowFunctionInvocation.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 ImmutableExpression.WindowFunctionInvocation.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 ImmutableExpression.WindowFunctionInvocation.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 ImmutableExpression.WindowFunctionInvocation.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 ImmutableExpression.WindowFunctionInvocation.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 ImmutableExpression.WindowFunctionInvocation.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 ImmutableExpression.WindowFunctionInvocation.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 ImmutableExpression.WindowFunctionInvocation.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 ImmutableExpression.WindowFunctionInvocation.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

addPartitionBy

public final ImmutableExpression.WindowFunctionInvocation.Builder addPartitionBy(Expression element)

Adds one element to partitionBy list.

Parameters:

element - A partitionBy element

Returns:

this builder for use in a chained invocation

addPartitionBy

public final ImmutableExpression.WindowFunctionInvocation.Builder addPartitionBy(Expression... elements)

Adds elements to partitionBy list.

Parameters:

elements - An array of partitionBy elements

Returns:

this builder for use in a chained invocation

partitionBy

public final ImmutableExpression.WindowFunctionInvocation.Builder partitionBy(Iterable<? extends Expression> elements)

Sets or replaces all elements for partitionBy list.

Parameters:

elements - An iterable of partitionBy elements

Returns:

this builder for use in a chained invocation

addAllPartitionBy

public final ImmutableExpression.WindowFunctionInvocation.Builder addAllPartitionBy(Iterable<? extends Expression> elements)

Adds elements to partitionBy list.

Parameters:

elements - An iterable of partitionBy elements

Returns:

this builder for use in a chained invocation

addSort

public final ImmutableExpression.WindowFunctionInvocation.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 ImmutableExpression.WindowFunctionInvocation.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 ImmutableExpression.WindowFunctionInvocation.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 ImmutableExpression.WindowFunctionInvocation.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

boundsType

public final ImmutableExpression.WindowFunctionInvocation.Builder boundsType(Expression.WindowBoundsType boundsType)

Initializes the value for the boundsType attribute.

Parameters:

boundsType - The value for boundsType

Returns:

this builder for use in a chained invocation

lowerBound

public final ImmutableExpression.WindowFunctionInvocation.Builder lowerBound(WindowBound lowerBound)

Initializes the value for the lowerBound attribute.

Parameters:

lowerBound - The value for lowerBound

Returns:

this builder for use in a chained invocation

upperBound

public final ImmutableExpression.WindowFunctionInvocation.Builder upperBound(WindowBound upperBound)

Initializes the value for the upperBound attribute.

Parameters:

upperBound - The value for upperBound

Returns:

this builder for use in a chained invocation

outputType

public final ImmutableExpression.WindowFunctionInvocation.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 ImmutableExpression.WindowFunctionInvocation.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 ImmutableExpression.WindowFunctionInvocation build()

Builds a new WindowFunctionInvocation.

Returns:

An immutable instance of WindowFunctionInvocation

Throws:

IllegalStateException - if any required attributes are missing