Module com.darkcollective.relix.plan

Package com.darkcollective.relix.plan

Record Class PhysicalNode.Tree

java.lang.Object

java.lang.Record

com.darkcollective.relix.plan.PhysicalNode.Tree

All Implemented Interfaces:

PhysicalNode

Enclosing interface:

PhysicalNode

public static record PhysicalNode.Tree(Schema schema, String keyColumn, String parentColumn, List<SortSpecification> orderSpecs, String childrenColumn, PhysicalNode input)
extends Record
implements PhysicalNode

Adjacency-to-forest nesting (TREE): folds the adjacency relation input (with node key keyColumn and parent key parentColumn) into a forest of nested documents — one output row per root, each carrying its subtree in the appended childrenColumn array (siblings ordered by orderSpecs, empty = input order). Output schema = input schema + the childrenColumn nested ANY column. Blocking; never pushed down.

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
Tree(Schema schema, String keyColumn, String parentColumn, List<SortSpecification> orderSpecs, String childrenColumn, PhysicalNode input)	Creates an instance of a Tree record class.

Method Summary

Modifier and Type	Method	Description
List<PhysicalNode>	children()	Direct child plans, left-to-right; empty for a PhysicalNode.Scan.
String	childrenColumn()	Returns the value of the childrenColumn record component.
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.
String	keyColumn()	Returns the value of the keyColumn record component.
List<SortSpecification>	orderSpecs()	Returns the value of the orderSpecs record component.
String	parentColumn()	Returns the value of the parentColumn record component.
Schema	schema()	Returns the value of the schema 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

Tree

public Tree(Schema schema,
 String keyColumn,
 String parentColumn,
 List<SortSpecification> orderSpecs,
 String childrenColumn,
 PhysicalNode input)

Creates an instance of a Tree record class.

Parameters:

schema - the value for the schema record component

keyColumn - the value for the keyColumn record component

parentColumn - the value for the parentColumn record component

orderSpecs - the value for the orderSpecs record component

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

keyColumn

public String keyColumn()

Returns the value of the keyColumn record component.

Returns:

the value of the keyColumn record component

parentColumn

public String parentColumn()

Returns the value of the parentColumn record component.

Returns:

the value of the parentColumn record component

orderSpecs

public List<SortSpecification> orderSpecs()

Returns the value of the orderSpecs record component.

Returns:

the value of the orderSpecs record component

childrenColumn

public String childrenColumn()

Returns the value of the childrenColumn record component.

Returns:

the value of the childrenColumn record component

input

public PhysicalNode input()

Returns the value of the input record component.

Returns:

the value of the input record component