Interface RelationalPersistentProperty

All Superinterfaces:
PersistentProperty<RelationalPersistentProperty>
All Known Implementing Classes:
BasicJdbcPersistentProperty, BasicRelationalPersistentProperty

public interface RelationalPersistentProperty extends PersistentProperty<RelationalPersistentProperty>
A PersistentProperty with methods for additional RDBMS related metadata based on columns.
Author:
Jens Schauder, Oliver Gierke, Bastian Wilhelm
  • Method Details

    • getColumnName

      SqlIdentifier getColumnName()
      Returns the name of the column backing this property.
      Returns:
      the name of the column backing this property.
    • hasExplicitColumnName

      boolean hasExplicitColumnName()
      Returns whether the property uses an annotated field name through Column.
      Returns:
      Since:
      3.2
    • getOwner

      Specified by:
      getOwner in interface PersistentProperty<RelationalPersistentProperty>
    • getReverseColumnName

      Deprecated, for removal: This API element is subject to removal in a future version.
    • getReverseColumnName

      SqlIdentifier getReverseColumnName(RelationalPersistentEntity<?> owner)
      Parameters:
      owner - the owning entity.
      Returns:
      the column name to represent the owning side.
    • getKeyColumn

      @Nullable SqlIdentifier getKeyColumn()
    • isQualified

      boolean isQualified()
      Returns if this property is a qualified property, i.e. a property referencing multiple elements that can get picked by a key or an index.
    • getQualifierColumnType

      Class<?> getQualifierColumnType()
    • isOrdered

      boolean isOrdered()
      Returns whether this property is an ordered property.
    • isEmbedded

      default boolean isEmbedded()
      Returns:
      true, if the Property is an embedded value object, otherwise false.
    • getEmbeddedPrefix

      @Nullable default String getEmbeddedPrefix()
      Returns:
      Prefix for embedded columns. If the column is not embedded the return value is null.
    • shouldCreateEmptyEmbedded

      boolean shouldCreateEmptyEmbedded()
      Returns whether an empty embedded object is supposed to be created for this property.
    • isInsertOnly

      boolean isInsertOnly()
      Returns whether this property is only to be used during inserts and read.
      Since:
      3.0