Module com.darkcollective.relix.plan

Package com.darkcollective.relix.plan

Record Class PhysicalNode.Rename

java.lang.Object

java.lang.Record

com.darkcollective.relix.plan.PhysicalNode.Rename

Record Components:

schema - the renamed heading

relation - the new relation name, if the rename supplies one

pairs - the old → new pairs of the pair form; empty otherwise

input - the renamed sub-plan

All Implemented Interfaces:

PhysicalNode

Enclosing interface:

PhysicalNode

public static record PhysicalNode.Rename(Schema schema, Optional<String> relation, List<RenameNode.RenamePair> pairs, PhysicalNode input)
extends Record
implements PhysicalNode

Relation/column rename — a metadata-only relabel to schema().

A declared row is relabelled by the heading alone. A schema-on-read row has no heading to relabel, so the executor applies the rename to the document itself: pairs renames the fields it names, and relation re-anchors the document to the new relation name.

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
Rename(Schema schema, PhysicalNode input)	A rename that gives no new relation name.
Rename(Schema schema, Optional<String> relation, List<RenameNode.RenamePair> pairs, PhysicalNode input)	Creates an instance of a Rename 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.
List<RenameNode.RenamePair>	pairs()	Returns the value of the pairs record component.
Optional<String>	relation()	Returns the value of the relation 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

Rename

public Rename(Schema schema,
 Optional<String> relation,
 List<RenameNode.RenamePair> pairs,
 PhysicalNode input)

Creates an instance of a Rename record class.

Parameters:

schema - the value for the schema record component

relation - the value for the relation record component

pairs - the value for the pairs record component

input - the value for the input record component

Rename

public Rename(Schema schema,
 PhysicalNode input)

A rename that gives no new relation name.

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

relation

public Optional<String> relation()

Returns the value of the relation record component.

Returns:

the value of the relation record component

pairs

public List<RenameNode.RenamePair> pairs()

Returns the value of the pairs record component.

Returns:

the value of the pairs record component

input

public PhysicalNode input()

Returns the value of the input record component.

Returns:

the value of the input record component