Module com.darkcollective.relix.plan

Package com.darkcollective.relix.plan

Record Class PhysicalNode.Roll

java.lang.Object

java.lang.Record

com.darkcollective.relix.plan.PhysicalNode.Roll

All Implemented Interfaces:

PhysicalNode

Enclosing interface:

PhysicalNode

public static record PhysicalNode.Roll(Schema schema, Optional<Long> seed, Optional<Operand> weight, PhysicalNode input)
extends Record
implements PhysicalNode

Endless uniform draw with replacement (ROLL): buffers the finite face set input and then emits an unbounded stream of independent uniform draws from it (a die roll). When seed is present the sequence of draws is deterministic. The output schema equals the input schema; it delivers no ordering. Streaming output over a buffered (necessarily bounded) input — a plan-time check rejects an unbounded face set.

When weight is present each face is drawn with probability proportional to that non-negative NUMBER expression over the face's columns (a loaded die); when absent, every face is equally likely.

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.Roll, PhysicalNode.Scan, PhysicalNode.Select, PhysicalNode.Sessionize, PhysicalNode.SetKind, PhysicalNode.SetOp, PhysicalNode.Shuffle, 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
Roll(Schema schema, Optional<Long> seed, Optional<Operand> weight, PhysicalNode input)	Creates an instance of a Roll 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.
final int	hashCode()	Returns a hash code value for this object.
PhysicalNode	input()	Returns the value of the input record component.
Schema	schema()	Returns the value of the schema record component.
Optional<Long>	seed()	Returns the value of the seed record component.
final String	toString()	Returns a string representation of this record class.
Optional<Operand>	weight()	Returns the value of the weight record component.

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

Roll

public Roll(Schema schema,
 Optional<Long> seed,
 Optional<Operand> weight,
 PhysicalNode input)

Creates an instance of a Roll record class.

Parameters:

schema - the value for the schema record component

seed - the value for the seed record component

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

seed

public Optional<Long> seed()

Returns the value of the seed record component.

Returns:

the value of the seed record component

weight

public Optional<Operand> weight()

Returns the value of the weight record component.

Returns:

the value of the weight record component

input

public PhysicalNode input()

Returns the value of the input record component.

Returns:

the value of the input record component