Package io.substrait.expression

Class ImmutableExpression.WindowFunctionInvocation

java.lang.Object

io.substrait.expression.Expression.WindowFunctionInvocation

io.substrait.expression.ImmutableExpression.WindowFunctionInvocation

All Implemented Interfaces:

Expression, FunctionArg

Enclosing class:

ImmutableExpression

public static final class ImmutableExpression.WindowFunctionInvocation
extends Expression.WindowFunctionInvocation

Immutable implementation of Expression.WindowFunctionInvocation.

Use the builder to create immutable instances: ImmutableExpression.WindowFunctionInvocation.builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ImmutableExpression.WindowFunctionInvocation.Builder	Builds instances of type WindowFunctionInvocation.

Nested classes/interfaces inherited from interface io.substrait.expression.Expression

Expression.AggregationInvocation, Expression.AggregationPhase, Expression.BinaryLiteral, Expression.BoolLiteral, Expression.Cast, Expression.DateLiteral, Expression.DecimalLiteral, Expression.EmptyListLiteral, Expression.EmptyMapLiteral, Expression.FailureBehavior, Expression.FixedBinaryLiteral, Expression.FixedCharLiteral, Expression.FP32Literal, Expression.FP64Literal, Expression.I16Literal, Expression.I32Literal, Expression.I64Literal, Expression.I8Literal, Expression.IfClause, Expression.IfThen, Expression.InPredicate, Expression.IntervalCompoundLiteral, Expression.IntervalDayLiteral, Expression.IntervalYearLiteral, Expression.Lambda, Expression.ListLiteral, Expression.Literal, Expression.MapLiteral, Expression.MultiOrList, Expression.MultiOrListRecord, Expression.Nested, Expression.NestedList, Expression.NestedStruct, Expression.NullLiteral, Expression.PrecisionTimeLiteral, Expression.PrecisionTimestampLiteral, Expression.PrecisionTimestampTZLiteral, Expression.PredicateOp, Expression.ScalarFunctionInvocation, Expression.ScalarSubquery, Expression.SetPredicate, Expression.SingleOrList, Expression.SortDirection, Expression.SortField, Expression.StrLiteral, Expression.StructLiteral, Expression.Subquery, Expression.Switch, Expression.SwitchClause, Expression.TimeLiteral, Expression.TimestampLiteral, Expression.TimestampTZLiteral, Expression.UserDefinedAnyLiteral, Expression.UserDefinedLiteral, Expression.UserDefinedStructLiteral, Expression.UUIDLiteral, Expression.VarCharLiteral, Expression.WindowBoundsType, Expression.WindowFunctionInvocation

Nested classes/interfaces inherited from interface io.substrait.expression.FunctionArg

FunctionArg.FuncArgVisitor<R,C extends VisitationContext,E extends Throwable>, FunctionArg.ProtoFrom

Method Summary

Modifier and Type	Method	Description
Expression.AggregationPhase	aggregationPhase()
List<FunctionArg>	arguments()
Expression.WindowBoundsType	boundsType()
static ImmutableExpression.WindowFunctionInvocation.Builder	builder()	Creates a builder for WindowFunctionInvocation.
static ImmutableExpression.WindowFunctionInvocation	copyOf(Expression.WindowFunctionInvocation instance)	Creates an immutable copy of a Expression.WindowFunctionInvocation value.
SimpleExtension.WindowFunctionVariant	declaration()
boolean	equals(Object another)	This instance is equal to all instances of WindowFunctionInvocation that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: declaration, arguments, options, aggregationPhase, partitionBy, sort, boundsType, lowerBound, upperBound, outputType, invocation.
Expression.AggregationInvocation	invocation()
WindowBound	lowerBound()
List<FunctionOption>	options()
Type	outputType()
List<Expression>	partitionBy()
List<Expression.SortField>	sort()
String	toString()	Prints the immutable value WindowFunctionInvocation with attribute values.
WindowBound	upperBound()
final ImmutableExpression.WindowFunctionInvocation	withAggregationPhase(Expression.AggregationPhase value)	Copy the current immutable object by setting a value for the aggregationPhase attribute.
final ImmutableExpression.WindowFunctionInvocation	withArguments(FunctionArg... elements)	Copy the current immutable object with elements that replace the content of arguments.
final ImmutableExpression.WindowFunctionInvocation	withArguments(Iterable<? extends FunctionArg> elements)	Copy the current immutable object with elements that replace the content of arguments.
final ImmutableExpression.WindowFunctionInvocation	withBoundsType(Expression.WindowBoundsType value)	Copy the current immutable object by setting a value for the boundsType attribute.
final ImmutableExpression.WindowFunctionInvocation	withDeclaration(SimpleExtension.WindowFunctionVariant value)	Copy the current immutable object by setting a value for the declaration attribute.
final ImmutableExpression.WindowFunctionInvocation	withInvocation(Expression.AggregationInvocation value)	Copy the current immutable object by setting a value for the invocation attribute.
final ImmutableExpression.WindowFunctionInvocation	withLowerBound(WindowBound value)	Copy the current immutable object by setting a value for the lowerBound attribute.
final ImmutableExpression.WindowFunctionInvocation	withOptions(FunctionOption... elements)	Copy the current immutable object with elements that replace the content of options.
final ImmutableExpression.WindowFunctionInvocation	withOptions(Iterable<? extends FunctionOption> elements)	Copy the current immutable object with elements that replace the content of options.
final ImmutableExpression.WindowFunctionInvocation	withOutputType(Type value)	Copy the current immutable object by setting a value for the outputType attribute.
final ImmutableExpression.WindowFunctionInvocation	withPartitionBy(Expression... elements)	Copy the current immutable object with elements that replace the content of partitionBy.
final ImmutableExpression.WindowFunctionInvocation	withPartitionBy(Iterable<? extends Expression> elements)	Copy the current immutable object with elements that replace the content of partitionBy.
final ImmutableExpression.WindowFunctionInvocation	withSort(Expression.SortField... elements)	Copy the current immutable object with elements that replace the content of sort.
final ImmutableExpression.WindowFunctionInvocation	withSort(Iterable<? extends Expression.SortField> elements)	Copy the current immutable object with elements that replace the content of sort.
final ImmutableExpression.WindowFunctionInvocation	withUpperBound(WindowBound value)	Copy the current immutable object by setting a value for the upperBound attribute.

Methods inherited from class io.substrait.expression.Expression.WindowFunctionInvocation

accept, check, getType

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.substrait.expression.Expression

accept

Method Details

declaration

public SimpleExtension.WindowFunctionVariant declaration()

Specified by:

declaration in class Expression.WindowFunctionInvocation

Returns:

The value of the declaration attribute

arguments

public List<FunctionArg> arguments()

Specified by:

arguments in class Expression.WindowFunctionInvocation

Returns:

The value of the arguments attribute

options

public List<FunctionOption> options()

Specified by:

options in class Expression.WindowFunctionInvocation

Returns:

The value of the options attribute

aggregationPhase

public Expression.AggregationPhase aggregationPhase()

Specified by:

aggregationPhase in class Expression.WindowFunctionInvocation

Returns:

The value of the aggregationPhase attribute

partitionBy

public List<Expression> partitionBy()

Specified by:

partitionBy in class Expression.WindowFunctionInvocation

Returns:

The value of the partitionBy attribute

sort

public List<Expression.SortField> sort()

Specified by:

sort in class Expression.WindowFunctionInvocation

Returns:

The value of the sort attribute

boundsType

public Expression.WindowBoundsType boundsType()

Specified by:

boundsType in class Expression.WindowFunctionInvocation

Returns:

The value of the boundsType attribute

lowerBound

public WindowBound lowerBound()

Specified by:

lowerBound in class Expression.WindowFunctionInvocation

Returns:

The value of the lowerBound attribute

upperBound

public WindowBound upperBound()

Specified by:

upperBound in class Expression.WindowFunctionInvocation

Returns:

The value of the upperBound attribute

outputType

public Type outputType()

Specified by:

outputType in class Expression.WindowFunctionInvocation

Returns:

The value of the outputType attribute

invocation

public Expression.AggregationInvocation invocation()

Specified by:

invocation in class Expression.WindowFunctionInvocation

Returns:

The value of the invocation attribute

withDeclaration

public final ImmutableExpression.WindowFunctionInvocation withDeclaration(SimpleExtension.WindowFunctionVariant value)

Copy the current immutable object by setting a value for the declaration attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for declaration

Returns:

A modified copy or the this object

withArguments

public final ImmutableExpression.WindowFunctionInvocation withArguments(FunctionArg... elements)

Copy the current immutable object with elements that replace the content of arguments.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withArguments

public final ImmutableExpression.WindowFunctionInvocation withArguments(Iterable<? extends FunctionArg> elements)

Copy the current immutable object with elements that replace the content of arguments. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of arguments elements to set

Returns:

A modified copy or this if not changed

withOptions

public final ImmutableExpression.WindowFunctionInvocation withOptions(FunctionOption... elements)

Copy the current immutable object with elements that replace the content of options.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withOptions

public final ImmutableExpression.WindowFunctionInvocation withOptions(Iterable<? extends FunctionOption> elements)

Copy the current immutable object with elements that replace the content of options. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of options elements to set

Returns:

A modified copy or this if not changed

withAggregationPhase

public final ImmutableExpression.WindowFunctionInvocation withAggregationPhase(Expression.AggregationPhase value)

Copy the current immutable object by setting a value for the aggregationPhase attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for aggregationPhase

Returns:

A modified copy or the this object

withPartitionBy

public final ImmutableExpression.WindowFunctionInvocation withPartitionBy(Expression... elements)

Copy the current immutable object with elements that replace the content of partitionBy.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withPartitionBy

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

Copy the current immutable object with elements that replace the content of partitionBy. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of partitionBy elements to set

Returns:

A modified copy or this if not changed

withSort

public final ImmutableExpression.WindowFunctionInvocation withSort(Expression.SortField... elements)

Copy the current immutable object with elements that replace the content of sort.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withSort

public final ImmutableExpression.WindowFunctionInvocation withSort(Iterable<? extends Expression.SortField> elements)

Copy the current immutable object with elements that replace the content of sort. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of sort elements to set

Returns:

A modified copy or this if not changed

withBoundsType

public final ImmutableExpression.WindowFunctionInvocation withBoundsType(Expression.WindowBoundsType value)

Copy the current immutable object by setting a value for the boundsType attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for boundsType

Returns:

A modified copy or the this object

withLowerBound

public final ImmutableExpression.WindowFunctionInvocation withLowerBound(WindowBound value)

Copy the current immutable object by setting a value for the lowerBound attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for lowerBound

Returns:

A modified copy or the this object

withUpperBound

public final ImmutableExpression.WindowFunctionInvocation withUpperBound(WindowBound value)

Copy the current immutable object by setting a value for the upperBound attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for upperBound

Returns:

A modified copy or the this object

withOutputType

public final ImmutableExpression.WindowFunctionInvocation withOutputType(Type value)

Copy the current immutable object by setting a value for the outputType attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for outputType

Returns:

A modified copy or the this object

withInvocation

public final ImmutableExpression.WindowFunctionInvocation withInvocation(Expression.AggregationInvocation value)

Copy the current immutable object by setting a value for the invocation attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for invocation

Returns:

A modified copy or the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of WindowFunctionInvocation that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: declaration, arguments, options, aggregationPhase, partitionBy, sort, boundsType, lowerBound, upperBound, outputType, invocation.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value WindowFunctionInvocation with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableExpression.WindowFunctionInvocation copyOf(Expression.WindowFunctionInvocation instance)

Creates an immutable copy of a Expression.WindowFunctionInvocation value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable WindowFunctionInvocation instance

builder

public static ImmutableExpression.WindowFunctionInvocation.Builder builder()

Creates a builder for WindowFunctionInvocation.

 ImmutableExpression.WindowFunctionInvocation.builder()
    .declaration(io.substrait.extension.SimpleExtension.WindowFunctionVariant) // required declaration
    .addArguments|addAllArguments(io.substrait.expression.FunctionArg) // arguments elements
    .addOptions|addAllOptions(io.substrait.expression.FunctionOption) // options elements
    .aggregationPhase(io.substrait.expression.Expression.AggregationPhase) // required aggregationPhase
    .addPartitionBy|addAllPartitionBy(io.substrait.expression.Expression) // partitionBy elements
    .addSort|addAllSort(io.substrait.expression.Expression.SortField) // sort elements
    .boundsType(io.substrait.expression.Expression.WindowBoundsType) // required boundsType
    .lowerBound(io.substrait.expression.WindowBound) // required lowerBound
    .upperBound(io.substrait.expression.WindowBound) // required upperBound
    .outputType(io.substrait.type.Type) // required outputType
    .invocation(io.substrait.expression.Expression.AggregationInvocation) // required invocation
    .build();
 

Returns:

A new WindowFunctionInvocation builder