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

Record Class RelationFunctionCall

java.lang.Object
java.lang.Record
com.darkcollective.relix.ast.RelationFunctionCall
Record Components:
functionName - the name of the table-valued function; must not be blank
arguments - the scalar argument expressions, in order; must not be null
location - the source location of this node; never null
All Implemented Interfaces:
RelNode
public record RelationFunctionCall(String functionName, List<Operand> arguments, SourceLocation location) extends Record implements RelNode
A reference to a table-valued (relation-returning) user-defined function, used wherever a relation is expected — a leaf node in the relational algebra tree.

Example: recentOrders(2) invokes the table-valued function recentOrders with the scalar argument 2; it yields the relation produced by the function's body with that argument bound to its parameter.

The arguments are scalar Operand expressions (not relational children), so this node has no RelNode children and is treated as a leaf by RelNode.children()/RelNode.mapChildren(java.util.function.UnaryOperator<com.darkcollective.relix.ast.RelNode>). Binding is by substitution: the planner inlines the function's body with each parameter replaced by the corresponding argument expression.

  • Constructor Details

    • RelationFunctionCall

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

    • RelationFunctionCall

      public RelationFunctionCall(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.

    • 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