Record Class AggregatePath.TableInfo

java.lang.Object
java.lang.Record
org.springframework.data.relational.core.mapping.AggregatePath.TableInfo
Record Components:
qualifiedTableName - the fully qualified name of the table this path is tied to or of the longest ancestor path that is actually tied to a table. Must not be null.
tableAlias - the alias used for the table on which this path is based. May be null.
backReferenceColumnInfos - information about the columns used to reference back to the owning entity. Must not be null. Since 3.5.
qualifierColumnInfo - the column used for the list index or map key of the leaf property of this path. May be null.
qualifierColumnType - the type of the qualifier column of the leaf property of this path or null if this is not applicable. May be null.
idColumnInfos - the column name of the id column of the ancestor path that represents an actual table. Must not be null.
Enclosing interface:
AggregatePath
public static record AggregatePath.TableInfo(SqlIdentifier qualifiedTableName, @Nullable SqlIdentifier tableAlias, AggregatePath.ColumnInfos backReferenceColumnInfos, @Nullable AggregatePath.ColumnInfo qualifierColumnInfo, @Nullable Class<?> qualifierColumnType, AggregatePath.ColumnInfos idColumnInfos) extends Record
Information about a table underlying an entity.
Since:
3.2
Author:
Jens Schauder, Mark Paluch

  • Constructor Details

  • Method Details

    • getRequiredQualifierColumnInfo

      public AggregatePath.ColumnInfo getRequiredQualifierColumnInfo()

    • backReferenceColumnInfos

      public AggregatePath.ColumnInfos backReferenceColumnInfos()
      Returns the value of the backReferenceColumnInfos record component.
      Returns:
      the value of the backReferenceColumnInfos record component

    • reverseColumnInfo

      @Deprecated(forRemoval=true) public AggregatePath.ColumnInfo reverseColumnInfo()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since there might be more than one reverse column instead. Use backReferenceColumnInfos() instead.
      Returns the unique AggregatePath.ColumnInfo referencing the parent table, if such exists.
      Returns:
      guaranteed not to be null.
      Throws:
      IllegalStateException - if there is not exactly one back referencing column.

    • effectiveIdColumnInfos

      public AggregatePath.ColumnInfos effectiveIdColumnInfos()
      The id columns of the underlying table.

      These might be:

      • the columns representing the id of the entity in question.
      • the columns representing the id of a parent entity, which _owns_ the table. Note that this case also covers the first case.
      • or the backReferenceColumns.
      Returns:
      ColumnInfos representing the effective id of this entity. Guaranteed not to be null.

    • getRequiredQualifierColumnType

      public Class<?> getRequiredQualifierColumnType()

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

    • qualifiedTableName

      public SqlIdentifier qualifiedTableName()
      Returns the value of the qualifiedTableName record component.
      Returns:
      the value of the qualifiedTableName record component

    • tableAlias

      public @Nullable SqlIdentifier tableAlias()
      Returns the value of the tableAlias record component.
      Returns:
      the value of the tableAlias record component

    • qualifierColumnInfo

      public @Nullable AggregatePath.ColumnInfo qualifierColumnInfo()
      Returns the value of the qualifierColumnInfo record component.
      Returns:
      the value of the qualifierColumnInfo record component

    • qualifierColumnType

      public @Nullable Class<?> qualifierColumnType()
      Returns the value of the qualifierColumnType record component.
      Returns:
      the value of the qualifierColumnType record component

    • idColumnInfos

      public AggregatePath.ColumnInfos idColumnInfos()
      Returns the value of the idColumnInfos record component.
      Returns:
      the value of the idColumnInfos record component