Module com.darkcollective.relix.lang.ast
Package com.darkcollective.relix.lang.ast.source

Record Class ColumnReference

java.lang.Object
java.lang.Record
com.darkcollective.relix.lang.ast.source.ColumnReference
Record Components:
sourceColumns - the referencing columns of the declaring source; must not be empty
targetRelation - the referenced relation name; must not be blank
targetColumns - the referenced columns; must not be empty
location - the source location of the entry's first token
public record ColumnReference(List<String> sourceColumns, String targetRelation, List<String> targetColumns, SourceLocation location) extends Record
One entry of a references: block on a database or connection-table source — a foreign-key style arrow from columns of the declaring source to columns of another relation: 
   references: {
       customer_id -> Customers.customer_id,
       (tenant_id, product_id) -> Product(tenant_id, id)
   }

Column lists are positional — the i-th source column equijoins the i-th target column — and a composite foreign key is one reference. Equal list lengths are validated semantically, with a positioned diagnostic, not here.

The FK-arrow form implies an upper multiplicity bound of 1 on the target endpoint (each referencing row points to at most one referenced row); the relationship name defaults to the source column list. Use a standalone relate statement for explicit names, inverse names, or bounds.

  • Constructor Details

    • ColumnReference

      public ColumnReference(List<String> sourceColumns, String targetRelation, List<String> targetColumns, SourceLocation location)
      Creates an instance of a ColumnReference record class.
      Parameters:
      sourceColumns - the value for the sourceColumns record component
      targetRelation - the value for the targetRelation record component
      targetColumns - the value for the targetColumns record component
      location - the value for the location record component

  • Method Details

    • defaultName

      public String defaultName()
      The default relationship name for this unnamed edge: the source column list.

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

    • sourceColumns

      public List<String> sourceColumns()
      Returns the value of the sourceColumns record component.
      Returns:
      the value of the sourceColumns record component

    • targetRelation

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

    • targetColumns

      public List<String> targetColumns()
      Returns the value of the targetColumns record component.
      Returns:
      the value of the targetColumns record component

    • location

      public SourceLocation location()
      Returns the value of the location record component.
      Returns:
      the value of the location record component