Top Description Methods
org.hibernate.metamodel.mapping

public Interface AttributeMapping

extends OwnedValuedModelPart, Fetchable, DatabaseSnapshotContributor, PropertyBasedMapping, MutabilityPlanExposer
Known Direct Subinterfaces
org.hibernate.metamodel.mapping.PluralAttributeMapping, org.hibernate.metamodel.mapping.SingularAttributeMapping, org.hibernate.metamodel.mapping.internal.SingleAttributeIdentifierMapping
Known Direct Implementers
org.hibernate.metamodel.mapping.internal.AbstractAttributeMapping
Imports
org.hibernate.generator.Generator, org.hibernate.metamodel.mapping.internal.EmbeddedAttributeMapping, org.hibernate.property.access.spi.PropertyAccess, org.hibernate.sql.results.graph.DatabaseSnapshotContributor, .Fetchable, org.hibernate.type.descriptor.java.JavaType, .MutabilityPlan, .MutabilityPlanExposer
Describes an attribute at the mapping model level.
Author
Steve Ebersole

Method Summary

Modifier and TypeMethod and Description
public default AttributeMapping
asAttributeMapping()

Overrides default org.hibernate.metamodel.mapping.ModelPart.asAttributeMapping, org.hibernate.sql.results.graph.Fetchable.asAttributeMapping.

public default EmbeddedAttributeMapping

Returns:

EmbeddedAttributeMapping if this is an instance of EmbeddedAttributeMapping otherwise null
asEmbeddedAttributeMapping()

A utility method to avoid casting explicitly to EmbeddedAttributeMapping

public default PluralAttributeMapping

Returns:

PluralAttributeMapping if this is an instance of PluralAttributeMapping otherwise null
asPluralAttributeMapping()

A utility method to avoid casting explicitly to PluralAttributeMapping

public default int
compare(Object value1, Object value2)

public default EntityMappingType
findContainingEntityMapping()

Implements org.hibernate.metamodel.mapping.ModelPart.findContainingEntityMapping.

public AttributeMetadata
getAttributeMetadata()

Access to AttributeMetadata

public String
getAttributeName()

The name of the mapped attribute

public ManagedMappingType
getDeclaringType()

Redeclares org.hibernate.metamodel.mapping.OwnedValuedModelPart.getDeclaringType.

The managed type that declares this attribute
public default MutabilityPlan<?>
getExposedMutabilityPlan()

Implements org.hibernate.type.descriptor.java.MutabilityPlanExposer.getExposedMutabilityPlan.

public Generator
getGenerator()

The value generation strategy to use for this attribute.

public default String
getPartName()

Implements org.hibernate.metamodel.mapping.ModelPart.getPartName.

The local part name, which is generally the unqualified role name
public PropertyAccess
getPropertyAccess()

Redeclares org.hibernate.metamodel.mapping.PropertyBasedMapping.getPropertyAccess.

The getter/setter access to this attribute
public int
getStateArrayPosition()

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

public default Object
getValue(Object container)

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

public default boolean
isEmbeddedAttributeMapping()

public default boolean
isPluralAttributeMapping()

public default void
setValue(Object container, Object value)

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

Inherited from org.hibernate.sql.results.graph.DatabaseSnapshotContributor:
createSnapshotDomainResult
Inherited from org.hibernate.sql.results.graph.Fetchable:
generateFetchgetFetchableKeygetFetchableNamegetMappedFetchOptionsincrementFetchDepthisSelectableresolveCircularFetch

Method Detail

asAttributeMappingback to summary
public default AttributeMapping asAttributeMapping()

Overrides default org.hibernate.metamodel.mapping.ModelPart.asAttributeMapping, org.hibernate.sql.results.graph.Fetchable.asAttributeMapping.

Annotations
@Override
asEmbeddedAttributeMappingback to summary
public default EmbeddedAttributeMapping asEmbeddedAttributeMapping()

A utility method to avoid casting explicitly to EmbeddedAttributeMapping

Returns:EmbeddedAttributeMapping

EmbeddedAttributeMapping if this is an instance of EmbeddedAttributeMapping otherwise null

asPluralAttributeMappingback to summary
public default PluralAttributeMapping asPluralAttributeMapping()

A utility method to avoid casting explicitly to PluralAttributeMapping

Returns:PluralAttributeMapping

PluralAttributeMapping if this is an instance of PluralAttributeMapping otherwise null

compareback to summary
public default int compare(Object value1, Object value2)
findContainingEntityMappingback to summary
public default EntityMappingType findContainingEntityMapping()

Implements org.hibernate.metamodel.mapping.ModelPart.findContainingEntityMapping.

Annotations
@Override
getAttributeMetadataback to summary
public AttributeMetadata getAttributeMetadata()

Access to AttributeMetadata

getAttributeNameback to summary
public String getAttributeName()

The name of the mapped attribute

getDeclaringTypeback to summary
public ManagedMappingType getDeclaringType()

Redeclares org.hibernate.metamodel.mapping.OwnedValuedModelPart.getDeclaringType.

The managed type that declares this attribute

getExposedMutabilityPlanback to summary
public default MutabilityPlan<?> getExposedMutabilityPlan()

Implements org.hibernate.type.descriptor.java.MutabilityPlanExposer.getExposedMutabilityPlan.

Annotations
@Override
getGeneratorback to summary
public Generator getGenerator()

The value generation strategy to use for this attribute.

API Note

Only relevant for non-id attributes

getPartNameback to summary
public default String getPartName()

Implements org.hibernate.metamodel.mapping.ModelPart.getPartName.

Doc from org.hibernate.metamodel.mapping.ModelPart.getPartName.

The local part name, which is generally the unqualified role name

Annotations
@Override
getPropertyAccessback to summary
public PropertyAccess getPropertyAccess()

Redeclares org.hibernate.metamodel.mapping.PropertyBasedMapping.getPropertyAccess.

The getter/setter access to this attribute

getStateArrayPositionback to summary
public int getStateArrayPosition()

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

getValueback to summary
public default Object getValue(Object container)

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

isEmbeddedAttributeMappingback to summary
public default boolean isEmbeddedAttributeMapping()
isPluralAttributeMappingback to summary
public default boolean isPluralAttributeMapping()
setValueback to summary
public default void setValue(Object container, Object value)

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