Module com.darkcollective.relix.ast
Package com.darkcollective.relix.ast

Record Class LateralJoinNode

java.lang.Object
java.lang.Record
com.darkcollective.relix.ast.LateralJoinNode
Record Components:
left - the outer (driving) relation; must not be null
functionName - the name of the table-valued function; must not be blank
arguments - scalar argument expressions (may reference left columns)
location - source location of the LATERAL keyword
All Implemented Interfaces:
RelNode
public record LateralJoinNode(RelNode left, String functionName, List<Operand> arguments, SourceLocation location) extends Record implements RelNode
A correlated / lateral table-valued function application that produces one sub-relation per row of its left input.

Syntax: left LATERAL fn(arg, …) — for each row produced by left, the arguments are evaluated against that row, the function body is instantiated with those values, and the resulting rows are concatenated with the outer row to form the output.

Unlike RelationFunctionCall (a leaf whose arguments must be constants), this node carries a relational left child so RelNode.children() includes it in the structural traversal. The TVF arguments may reference columns from the left schema — that is the defining property of a lateral join.

  • Constructor Details

    • LateralJoinNode

      public LateralJoinNode(RelNode left, String functionName, List<Operand> arguments, SourceLocation location)
      Creates an instance of a LateralJoinNode record class.
      Parameters:
      left - the value for the left record component
      functionName - the value for the functionName record component
      arguments - the value for the arguments record component
      location - the value for the location record component

    • LateralJoinNode

      public LateralJoinNode(RelNode left, String functionName, List<Operand> arguments)
      Convenience constructor for tests; uses SourceLocation.UNKNOWN.

  • Method Details

    • accept

      public <R> R accept(RelNodeVisitor<R> visitor)
      Specified by:
      accept in interface RelNode

    • 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.

    • left

      public RelNode left()
      Returns the value of the left record component.
      Returns:
      the value of the left record component

    • functionName

      public String functionName()
      Returns the value of the functionName record component.
      Returns:
      the value of the functionName record component

    • arguments

      public List<Operand> arguments()
      Returns the value of the arguments record component.
      Returns:
      the value of the arguments record component

    • location

      public SourceLocation location()
      Returns the value of the location record component.
      Specified by:
      location in interface RelNode
      Returns:
      the value of the location record component