Package io.substrait.relation

Class ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation

java.lang.Object

io.substrait.relation.ConsistentPartitionWindow.WindowRelFunctionInvocation

io.substrait.relation.ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation

Enclosing class:

ImmutableConsistentPartitionWindow

public static final class ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation
extends ConsistentPartitionWindow.WindowRelFunctionInvocation

Immutable implementation of ConsistentPartitionWindow.WindowRelFunctionInvocation.

Use the builder to create immutable instances: ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation.builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation.Builder	Builds instances of type WindowRelFunctionInvocation.

Method Summary

Modifier and Type	Method	Description
Expression.AggregationPhase	aggregationPhase()	Returns the aggregation phase (e.g., initial, intermediate, final).
List<FunctionArg>	arguments()	Returns the ordered list of function arguments.
Expression.WindowBoundsType	boundsType()	Returns the bounds type (e.g., ROWS or RANGE).
static ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation.Builder	builder()	Creates a builder for WindowRelFunctionInvocation.
static ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation	copyOf(ConsistentPartitionWindow.WindowRelFunctionInvocation instance)	Creates an immutable copy of a ConsistentPartitionWindow.WindowRelFunctionInvocation value.
SimpleExtension.WindowFunctionVariant	declaration()	Returns the window function variant declaration.
boolean	equals(Object another)	This instance is equal to all instances of WindowRelFunctionInvocation that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: declaration, arguments, options, outputType, aggregationPhase, invocation, lowerBound, upperBound, boundsType.
Expression.AggregationInvocation	invocation()	Returns the aggregation invocation semantics (e.g., aggregate, merge).
WindowBound	lowerBound()	Returns the inclusive lower bound of the window frame.
List<FunctionOption>	options()	Returns the options applied to the function invocation.
Type	outputType()	Returns the type produced by this invocation.
String	toString()	Prints the immutable value WindowRelFunctionInvocation with attribute values.
WindowBound	upperBound()	Returns the inclusive upper bound of the window frame.
final ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation	withAggregationPhase(Expression.AggregationPhase value)	Copy the current immutable object by setting a value for the aggregationPhase attribute.
final ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation	withArguments(FunctionArg... elements)	Copy the current immutable object with elements that replace the content of arguments.
final ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation	withArguments(Iterable<? extends FunctionArg> elements)	Copy the current immutable object with elements that replace the content of arguments.
final ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation	withBoundsType(Expression.WindowBoundsType value)	Copy the current immutable object by setting a value for the boundsType attribute.
final ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation	withDeclaration(SimpleExtension.WindowFunctionVariant value)	Copy the current immutable object by setting a value for the declaration attribute.
final ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation	withInvocation(Expression.AggregationInvocation value)	Copy the current immutable object by setting a value for the invocation attribute.
final ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation	withLowerBound(WindowBound value)	Copy the current immutable object by setting a value for the lowerBound attribute.
final ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation	withOptions(FunctionOption... elements)	Copy the current immutable object with elements that replace the content of options.
final ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation	withOptions(Iterable<? extends FunctionOption> elements)	Copy the current immutable object with elements that replace the content of options.
final ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation	withOutputType(Type value)	Copy the current immutable object by setting a value for the outputType attribute.
final ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation	withUpperBound(WindowBound value)	Copy the current immutable object by setting a value for the upperBound attribute.

Methods inherited from class java.lang.Object

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

Method Details

declaration

public SimpleExtension.WindowFunctionVariant declaration()

Returns the window function variant declaration.

Specified by:

declaration in class ConsistentPartitionWindow.WindowRelFunctionInvocation

Returns:

the function variant declaration

arguments

public List<FunctionArg> arguments()

Returns the ordered list of function arguments.

Specified by:

arguments in class ConsistentPartitionWindow.WindowRelFunctionInvocation

Returns:

list of function arguments

options

public List<FunctionOption> options()

Returns the options applied to the function invocation.

Specified by:

options in class ConsistentPartitionWindow.WindowRelFunctionInvocation

Returns:

list of function options

outputType

public Type outputType()

Returns the type produced by this invocation.

Specified by:

outputType in class ConsistentPartitionWindow.WindowRelFunctionInvocation

Returns:

output type of the window function

aggregationPhase

public Expression.AggregationPhase aggregationPhase()

Returns the aggregation phase (e.g., initial, intermediate, final).

Specified by:

aggregationPhase in class ConsistentPartitionWindow.WindowRelFunctionInvocation

Returns:

aggregation phase

invocation

public Expression.AggregationInvocation invocation()

Returns the aggregation invocation semantics (e.g., aggregate, merge).

Specified by:

invocation in class ConsistentPartitionWindow.WindowRelFunctionInvocation

Returns:

aggregation invocation

lowerBound

public WindowBound lowerBound()

Returns the inclusive lower bound of the window frame.

Specified by:

lowerBound in class ConsistentPartitionWindow.WindowRelFunctionInvocation

Returns:

lower window bound

upperBound

public WindowBound upperBound()

Returns the inclusive upper bound of the window frame.

Specified by:

upperBound in class ConsistentPartitionWindow.WindowRelFunctionInvocation

Returns:

upper window bound

boundsType

public Expression.WindowBoundsType boundsType()

Returns the bounds type (e.g., ROWS or RANGE).

Specified by:

boundsType in class ConsistentPartitionWindow.WindowRelFunctionInvocation

Returns:

window bounds type

withDeclaration

public final ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation 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 ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation 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 ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation 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 ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation 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 ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation 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

withOutputType

public final ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation 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

withAggregationPhase

public final ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation 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

withInvocation

public final ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation 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

withLowerBound

public final ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation 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 ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation 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

withBoundsType

public final ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation 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

equals

public boolean equals(Object another)

This instance is equal to all instances of WindowRelFunctionInvocation 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, outputType, aggregationPhase, invocation, lowerBound, upperBound, boundsType.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value WindowRelFunctionInvocation with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation copyOf(ConsistentPartitionWindow.WindowRelFunctionInvocation instance)

Creates an immutable copy of a ConsistentPartitionWindow.WindowRelFunctionInvocation 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 WindowRelFunctionInvocation instance

builder

public static ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation.Builder builder()

Creates a builder for WindowRelFunctionInvocation.

 ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation.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
    .outputType(io.substrait.type.Type) // required outputType
    .aggregationPhase(io.substrait.expression.Expression.AggregationPhase) // required aggregationPhase
    .invocation(io.substrait.expression.Expression.AggregationInvocation) // required invocation
    .lowerBound(io.substrait.expression.WindowBound) // required lowerBound
    .upperBound(io.substrait.expression.WindowBound) // required upperBound
    .boundsType(io.substrait.expression.Expression.WindowBoundsType) // required boundsType
    .build();
 

Returns:

A new WindowRelFunctionInvocation builder