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
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default AttributeMapping
asAttributeMapping()
default EmbeddedAttributeMapping
asEmbeddedAttributeMapping()
A utility method to avoid casting explicitly to EmbeddedAttributeMappingdefault PluralAttributeMapping
asPluralAttributeMapping()
A utility method to avoid casting explicitly to PluralAttributeMappingdefault EntityMappingType
findContainingEntityMapping()
AttributeMetadataAccess
getAttributeMetadataAccess()
Access to AttributeMetadataString
getAttributeName()
The name of the mapped attributeManagedMappingType
getDeclaringType()
The managed type that declares this attributedefault MutabilityPlan<?>
getExposedMutabilityPlan()
default String
getPartName()
PropertyAccess
getPropertyAccess()
The getter/setter access to this attributeint
getStateArrayPosition()
The attribute's position within the container's state arraydefault Object
getValue(Object container)
Convenient access to getting the value for this attribute from the declarerValueGeneration
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 interfaceModelPart
-
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 interfacePropertyBasedMapping
-
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 interfaceModelPart
-
getExposedMutabilityPlan
default MutabilityPlan<?> getExposedMutabilityPlan()
- Specified by:
getExposedMutabilityPlan
in interfaceMutabilityPlanExposer
-
asAttributeMapping
default AttributeMapping asAttributeMapping()
- Specified by:
asAttributeMapping
in interfaceFetchable
- Specified by:
asAttributeMapping
in interfaceModelPart
-
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()
-
-