Package org.hibernate.metamodel.mapping

Interface AttributeMapping

All Superinterfaces:

Bindable, DatabaseSnapshotContributor, Fetchable, JavaTypedExpressible, JdbcMappingContainer, MappingModelExpressible, ModelPart, MutabilityPlanExposer, PropertyBasedMapping, ValueMapping

All Known Subinterfaces:

PluralAttributeMapping, SingularAttributeMapping

All Known Implementing Classes:

AbstractAttributeMapping, AbstractSingularAttributeMapping, AbstractStateArrayContributorMapping, BasicAttributeMapping, DiscriminatedAssociationAttributeMapping, EmbeddedAttributeMapping, InverseNonAggregatedIdentifierMapping, PluralAttributeMappingImpl, ToOneAttributeMapping, VirtualEmbeddedAttributeMapping

public interface AttributeMapping
extends ModelPart, ValueMapping, Fetchable, DatabaseSnapshotContributor, PropertyBasedMapping, MutabilityPlanExposer

Describes an attribute at the mapping model level.

Nested Class Summary

Nested classes/interfaces inherited from interface org.hibernate.metamodel.mapping.Bindable

Bindable.JdbcValuesConsumer

Nested classes/interfaces inherited from interface org.hibernate.metamodel.mapping.ModelPart

ModelPart.JdbcValueConsumer

Method Summary

Modifier and Type	Method	Description
default AttributeMapping	asAttributeMapping()
default EmbeddedAttributeMapping	asEmbeddedAttributeMapping()	A utility method to avoid casting explicitly to EmbeddedAttributeMapping
default PluralAttributeMapping	asPluralAttributeMapping()	A utility method to avoid casting explicitly to PluralAttributeMapping
default EntityMappingType	findContainingEntityMapping()
AttributeMetadataAccess	getAttributeMetadataAccess()	Access to AttributeMetadata
String	getAttributeName()	The name of the mapped attribute
ManagedMappingType	getDeclaringType()	The managed type that declares this attribute
default MutabilityPlan<?>	getExposedMutabilityPlan()
default String	getPartName()
PropertyAccess	getPropertyAccess()	The getter/setter access to this attribute
int	getStateArrayPosition()	The attribute's position within the container's state array
default Object	getValue(Object container)	Convenient access to getting the value for this attribute from the declarer
ValueGeneration	getValueGeneration()	The value generation strategy to use for this attribute.
default boolean	isEmbeddedAttributeMapping()
default boolean	isPluralAttributeMapping()
default void	setValue(Object container, Object value)	Convenient access to setting the value for this attribute on the declarer

Methods inherited from interface org.hibernate.metamodel.mapping.Bindable

disassemble, forEachDisassembledJdbcValue, forEachDisassembledJdbcValue, forEachJdbcType, forEachJdbcValue, forEachJdbcValue, getJdbcMappings, getJdbcTypeCount

Methods inherited from interface org.hibernate.sql.results.graph.DatabaseSnapshotContributor

createSnapshotDomainResult

Methods inherited from interface org.hibernate.sql.results.graph.Fetchable

generateFetch, getFetchableName, getMappedFetchOptions, incrementFetchDepth, resolveCircularFetch

Methods inherited from interface org.hibernate.metamodel.mapping.JdbcMappingContainer

forEachJdbcType

Methods inherited from interface org.hibernate.metamodel.mapping.ModelPart

applySqlSelections, applySqlSelections, areEqual, breakDownJdbcValues, createDomainResult, forEachSelectable, forEachSelectable, getJavaType, getNavigableRole, getPartMappingType

Methods inherited from interface org.hibernate.metamodel.mapping.ValueMapping

getExpressibleJavaType, getMappedType, treatAs

Method Detail

getAttributeName

String getAttributeName()

The name of the mapped attribute

getPartName

default String getPartName()

Specified by:

getPartName in interface ModelPart

getStateArrayPosition

int getStateArrayPosition()

The attribute's position within the container's state array

getAttributeMetadataAccess

AttributeMetadataAccess getAttributeMetadataAccess()

Access to AttributeMetadata

getDeclaringType

ManagedMappingType getDeclaringType()

The managed type that declares this attribute

getPropertyAccess

PropertyAccess getPropertyAccess()

The getter/setter access to this attribute

Specified by:

getPropertyAccess in interface PropertyBasedMapping

getValue

default Object getValue(Object container)

Convenient access to getting the value for this attribute from the declarer

setValue

default void setValue(Object container,
                      Object value)

Convenient access to setting the value for this attribute on the declarer

getValueGeneration

ValueGeneration getValueGeneration()

The value generation strategy to use for this attribute.

findContainingEntityMapping

default EntityMappingType findContainingEntityMapping()

Specified by:

findContainingEntityMapping in interface ModelPart

getExposedMutabilityPlan

default MutabilityPlan<?> getExposedMutabilityPlan()

Specified by:

getExposedMutabilityPlan in interface MutabilityPlanExposer

asAttributeMapping

default AttributeMapping asAttributeMapping()

Specified by:

asAttributeMapping in interface Fetchable

Specified by:

asAttributeMapping in interface ModelPart

asPluralAttributeMapping

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

default 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()