Package io.substrait.relation

Class ConsistentPartitionWindow

java.lang.Object

io.substrait.relation.AbstractRel

io.substrait.relation.SingleInputRel

io.substrait.relation.ConsistentPartitionWindow

All Implemented Interfaces:

HasExtension, Rel

Direct Known Subclasses:

ImmutableConsistentPartitionWindow

@Immutable
@Enclosing
public abstract class ConsistentPartitionWindow
extends SingleInputRel
implements HasExtension

A window relation that ensures consistent partitioning and ordering across all window function invocations in a single input relation. Provides partition expressions, sort keys, and window functions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConsistentPartitionWindow.WindowRelFunctionInvocation	A single window function invocation with its arguments, options, output type, phase/invocation, and window bounds.

Nested classes/interfaces inherited from interface io.substrait.relation.Rel

Rel.Remap

Constructor Summary

Constructors

Constructor	Description
ConsistentPartitionWindow()

Method Summary

Modifier and Type	Method	Description
<O, C extends VisitationContext, E extends Exception> O	accept(RelVisitor<O,C,E> visitor, C context)	Accepts a relation visitor.
static ImmutableConsistentPartitionWindow.Builder	builder()	Creates a builder for ConsistentPartitionWindow.
protected Type.Struct	deriveRecordType()	Derives the output record type by appending window outputs to the input type.
abstract List<Expression>	getPartitionExpressions()	Returns the expressions used to partition the input rows.
abstract List<Expression.SortField>	getSorts()	Returns the sort fields defining row order within each partition.
abstract List<ConsistentPartitionWindow.WindowRelFunctionInvocation>	getWindowFunctions()	Returns the window function invocations applied over the input.

Methods inherited from class io.substrait.relation.SingleInputRel

getInput, getInputs

Methods inherited from class io.substrait.relation.AbstractRel

getRecordType

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.substrait.relation.HasExtension

getExtension

Methods inherited from interface io.substrait.relation.Rel

getCommonExtension, getHint, getRemap

Constructor Details

ConsistentPartitionWindow

public ConsistentPartitionWindow()

Method Details

getWindowFunctions

public abstract List<ConsistentPartitionWindow.WindowRelFunctionInvocation> getWindowFunctions()

Returns the window function invocations applied over the input.

Returns:

list of window function invocations

getPartitionExpressions

public abstract List<Expression> getPartitionExpressions()

Returns the expressions used to partition the input rows.

Returns:

list of partitioning expressions

getSorts

public abstract List<Expression.SortField> getSorts()

Returns the sort fields defining row order within each partition.

Returns:

list of sort fields

deriveRecordType

protected Type.Struct deriveRecordType()

Derives the output record type by appending window outputs to the input type.

Specified by:

deriveRecordType in class AbstractRel

Returns:

the resulting struct type

accept

public <O,
C extends VisitationContext,
E extends Exception>
O accept(RelVisitor<O,C,E> visitor,
 C context)
  throws E

Accepts a relation visitor.

Specified by:

accept in interface Rel

Type Parameters:

O - the result type

C - the visitation context type

E - the exception type that may be thrown

Parameters:

visitor - the relation visitor

context - the visitation context

Returns:

the visit result

Throws:

E - if the visitor signals an error

builder

public static ImmutableConsistentPartitionWindow.Builder builder()

Creates a builder for ConsistentPartitionWindow.

Returns:

a new immutable builder