Module com.darkcollective.relix.plan

Package com.darkcollective.relix.plan

Record Class PhysicalNode.Window

java.lang.Object

java.lang.Record

com.darkcollective.relix.plan.PhysicalNode.Window

All Implemented Interfaces:

PhysicalNode

Enclosing interface:

PhysicalNode

public static record PhysicalNode.Window(Schema schema, WindowFunction function, List<String> partitionKeys, List<SortSpecification> sortSpecs, WindowFrame frame, String outputColumn, PhysicalNode input)
extends Record
implements PhysicalNode

Window (ROLLING / WINDOW): adds one computed column (outputColumn) to every input row, partitioned by partitionKeys and ordered within each partition by sortSpecs. The frame sets the scope of rows fed to function. Output schema = input schema + the appended column.

Nested Class Summary

Nested classes/interfaces inherited from interface com.darkcollective.relix.plan.PhysicalNode

PhysicalNode.Aggregate, PhysicalNode.AsOfJoin, PhysicalNode.BernoulliSample, PhysicalNode.BuildSide, PhysicalNode.Closure, PhysicalNode.Cluster, PhysicalNode.ConstructiveCover, PhysicalNode.Cover, PhysicalNode.Distinct, PhysicalNode.Division, PhysicalNode.Downsample, PhysicalNode.Empty, PhysicalNode.Fixpoint, PhysicalNode.IntervalJoin, PhysicalNode.Iterate, PhysicalNode.Join, PhysicalNode.JoinAlgorithm, PhysicalNode.JoinKeys, PhysicalNode.JoinKind, PhysicalNode.LateralJoin, PhysicalNode.Limit, PhysicalNode.Optimize, PhysicalNode.Path, PhysicalNode.Pivot, PhysicalNode.Project, PhysicalNode.PushedScan, PhysicalNode.RecursiveRef, PhysicalNode.Rename, PhysicalNode.ReservoirSample, PhysicalNode.Scan, PhysicalNode.Select, PhysicalNode.Sessionize, PhysicalNode.SetKind, PhysicalNode.SetOp, PhysicalNode.Solve, PhysicalNode.Sort, PhysicalNode.Spool, PhysicalNode.TopK, PhysicalNode.Trace, PhysicalNode.Tree, PhysicalNode.Universal, PhysicalNode.Unnest, PhysicalNode.Unpivot, PhysicalNode.Why, PhysicalNode.Window

Constructor Summary

Constructors

Constructor	Description
Window(Schema schema, WindowFunction function, List<String> partitionKeys, List<SortSpecification> sortSpecs, WindowFrame frame, String outputColumn, PhysicalNode input)	Creates an instance of a Window record class.

Method Summary

Modifier and Type	Method	Description
List<PhysicalNode>	children()	Direct child plans, left-to-right; empty for a PhysicalNode.Scan.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
WindowFrame	frame()	Returns the value of the frame record component.
WindowFunction	function()	Returns the value of the function record component.
final int	hashCode()	Returns a hash code value for this object.
PhysicalNode	input()	Returns the value of the input record component.
String	outputColumn()	Returns the value of the outputColumn record component.
List<String>	partitionKeys()	Returns the value of the partitionKeys record component.
Schema	schema()	Returns the value of the schema record component.
List<SortSpecification>	sortSpecs()	Returns the value of the sortSpecs record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.darkcollective.relix.plan.PhysicalNode

deliveredOrdering, mapChildren

Constructor Details

Window

public Window(Schema schema,
 WindowFunction function,
 List<String> partitionKeys,
 List<SortSpecification> sortSpecs,
 WindowFrame frame,
 String outputColumn,
 PhysicalNode input)

Creates an instance of a Window record class.

Parameters:

schema - the value for the schema record component

function - the value for the function record component

partitionKeys - the value for the partitionKeys record component

sortSpecs - the value for the sortSpecs record component

frame - the value for the frame record component

outputColumn - the value for the outputColumn record component

input - the value for the input record component

Method Details

children

public List<PhysicalNode> children()

Description copied from interface: PhysicalNode

Direct child plans, left-to-right; empty for a PhysicalNode.Scan.

Specified by:

children in interface PhysicalNode

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

schema

public Schema schema()

Returns the value of the schema record component.

Specified by:

schema in interface PhysicalNode

Returns:

the value of the schema record component

function

public WindowFunction function()

Returns the value of the function record component.

Returns:

the value of the function record component

partitionKeys

public List<String> partitionKeys()

Returns the value of the partitionKeys record component.

Returns:

the value of the partitionKeys record component

sortSpecs

public List<SortSpecification> sortSpecs()

Returns the value of the sortSpecs record component.

Returns:

the value of the sortSpecs record component

frame

public WindowFrame frame()

Returns the value of the frame record component.

Returns:

the value of the frame record component

outputColumn

public String outputColumn()

Returns the value of the outputColumn record component.

Returns:

the value of the outputColumn record component

input

public PhysicalNode input()

Returns the value of the input record component.

Returns:

the value of the input record component