Interface AttributeMapping

All Superinterfaces:
Bindable, DatabaseSnapshotContributor, Fetchable, JavaTypedExpressible, JdbcMappingContainer, MappingModelExpressible, ModelPart, MutabilityPlanExposer, OwnedValuedModelPart, PropertyBasedMapping, SelectableMappings, ValuedModelPart, ValueMapping
All Known Subinterfaces:
AggregatedIdentifierMapping, BasicEntityIdentifierMapping, PluralAttributeMapping, SingleAttributeIdentifierMapping, SingularAttributeMapping
public interface AttributeMapping extends OwnedValuedModelPart, Fetchable, DatabaseSnapshotContributor, PropertyBasedMapping, MutabilityPlanExposer
Describes an attribute at the mapping model level.

  • Method Details

    • getAttributeName

      @Nullable String getAttributeName()
      The name of the mapped attribute, or null for an unnamed synthetic attribute.

    • getPartName

      @Nullable default String getPartName()
      Description copied from interface: ModelPart
      The local part name, which is generally the unqualified role name
      Specified by:
      getPartName in interface ModelPart

    • getStateArrayPosition

      int getStateArrayPosition()
      The attribute's position within the container's state array

    • getAttributeMetadata

      @Nullable AttributeMetadata getAttributeMetadata()
      Access to AttributeMetadata, or null for a synthetic attribute without metadata.

    • getDeclaringType

      @Nullable ManagedMappingType getDeclaringType()
      The managed type that declares this attribute, or null for a synthetic attribute.
      Specified by:
      getDeclaringType in interface OwnedValuedModelPart

    • getPropertyAccess

      @Nullable PropertyAccess getPropertyAccess()
      The getter/setter access to this attribute, or null if it has no Java property.
      Specified by:
      getPropertyAccess in interface PropertyBasedMapping

    • getValue

      @Nullable default Object getValue(@Nonnull Object container)
      Convenient access to getting the value for this attribute from the declarer

    • setValue

      default void setValue(@Nonnull Object container, @Nullable Object value)
      Convenient access to setting the value for this attribute on the declarer

    • getGenerator

      @Nullable Generator getGenerator()
      The value generation strategy to use for this attribute.
      API Note:
      Only relevant for non-id attributes

    • findContainingEntityMapping

      @Nullable default EntityMappingType findContainingEntityMapping()
      Specified by:
      findContainingEntityMapping in interface ModelPart

    • getExposedMutabilityPlan

      @Nonnull default MutabilityPlan<?> getExposedMutabilityPlan()
      Specified by:
      getExposedMutabilityPlan in interface MutabilityPlanExposer

    • compare

      default int compare(@Nullable Object value1, @Nullable Object value2)
      Compare attribute values, treating null as less than every non-null value.

    • asAttributeMapping

      @Nonnull default AttributeMapping asAttributeMapping()
      Specified by:
      asAttributeMapping in interface ModelPart

    • asPluralAttributeMapping

      @Nullable default PluralAttributeMapping asPluralAttributeMapping()
      A utility method to avoid casting explicitly to PluralAttributeMapping
      Returns:
      PluralAttributeMapping if this is an instance of PluralAttributeMapping otherwise null

    • isPluralAttributeMapping

      default boolean isPluralAttributeMapping()

    • asEmbeddedAttributeMapping

      @Nullable @Internal default org.hibernate.metamodel.mapping.internal.EmbeddedAttributeMapping asEmbeddedAttributeMapping()
      A utility method to avoid casting explicitly to EmbeddedAttributeMapping
      Returns:
      EmbeddedAttributeMapping if this is an instance of EmbeddedAttributeMapping otherwise null

    • isEmbeddedAttributeMapping

      default boolean isEmbeddedAttributeMapping()