Module com.darkcollective.relix.plan

Package com.darkcollective.relix.plan

Record Class PhysicalNode.Iterate

java.lang.Object

java.lang.Record

com.darkcollective.relix.plan.PhysicalNode.Iterate

Record Components:

name - the bound relation name (must match the PhysicalNode.RecursiveRef nodes inside step)

base - the relation the first round reads; planned independently

step - the body computing each round from the previous one

stop - when the iteration stops, and how it reports not stopping

All Implemented Interfaces:

PhysicalNode

Enclosing interface:

PhysicalNode

public static record PhysicalNode.Iterate(Schema schema, String name, PhysicalNode base, PhysicalNode step, IterateStop stop)
extends Record
implements PhysicalNode

Replace-each-round iteration (ITERATE): evaluates base(), then evaluates step() with the relation named name() bound to the previous round's whole output, replacing it each round, until stop() is satisfied. Output is the last round, under set semantics; materialises a set. Never pushed to a source.

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
Iterate(Schema schema, String name, PhysicalNode base, PhysicalNode step, IterateStop stop)	Creates an instance of a Iterate record class.

Method Summary

Modifier and Type	Method	Description
PhysicalNode	base()	Returns the value of the base record component.
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.
final int	hashCode()	Returns a hash code value for this object.
String	name()	Returns the value of the name record component.
Schema	schema()	Returns the value of the schema record component.
PhysicalNode	step()	Returns the value of the step record component.
IterateStop	stop()	Returns the value of the stop 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

Iterate

public Iterate(Schema schema,
 String name,
 PhysicalNode base,
 PhysicalNode step,
 IterateStop stop)

Creates an instance of a Iterate record class.

Parameters:

schema - the value for the schema record component

name - the value for the name record component

base - the value for the base record component

step - the value for the step record component

stop - the value for the stop 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

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

base

public PhysicalNode base()

Returns the value of the base record component.

Returns:

the value of the base record component

step

public PhysicalNode step()

Returns the value of the step record component.

Returns:

the value of the step record component

stop

public IterateStop stop()

Returns the value of the stop record component.

Returns:

the value of the stop record component