Package org.hibernate.metamodel.mapping.internal

Class BasicEntityIdentifierMappingImpl

java.lang.Object

org.hibernate.metamodel.mapping.internal.BasicEntityIdentifierMappingImpl

All Implemented Interfaces:

AttributeMapping, AttributeMetadata, BasicEntityIdentifierMapping, BasicValuedMapping, BasicValuedModelPart, Bindable, EntityIdentifierMapping, SingleAttributeIdentifierMapping, JdbcMappingContainer, MappingModelExpressible, ModelPart, OwnedValuedModelPart, PropertyBasedMapping, SelectableMapping, SelectableMappings, SqlExpressible, SqlTypedMapping, ValuedModelPart, ValueMapping, DatabaseSnapshotContributor, Fetchable, FetchOptions, FetchStyleAccess, FetchTimingAccess, JavaTypedExpressible, MutabilityPlanExposer

public class BasicEntityIdentifierMappingImpl
extends Object
implements BasicEntityIdentifierMapping, FetchOptions

Mapping of a simple identifier

See Also:

Id

Nested Class Summary

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

Bindable.JdbcValuesBiConsumer<X,Y>, Bindable.JdbcValuesConsumer

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

EntityIdentifierMapping.Nature

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

ModelPart.JdbcValueBiConsumer<X,Y>, ModelPart.JdbcValueConsumer

Field Summary

Fields inherited from interface org.hibernate.metamodel.mapping.EntityIdentifierMapping

ID_ROLE_NAME, LEGACY_ID_NAME

Constructor Summary

Constructors

Constructor	Description
BasicEntityIdentifierMappingImpl(EntityPersister entityPersister, Supplier<?> instanceCreator, String attributeName, String rootTable, String pkColumnName, String columnDefinition, Long length, Integer precision, Integer scale, boolean insertable, boolean updateable, BasicType<?> idType, MappingModelCreationProcess creationProcess)

Method Summary

Modifier and Type	Method	Description
void	addToCacheKey(MutableCacheKeyBuilder cacheKey, Object value, SharedSessionContractImplementor session)	Add to the MutableCacheKey the values obtained disassembling the value and the hasCode generated from the disassembled value.
void	applySqlSelections(NavigablePath navigablePath, TableGroup tableGroup, DomainResultCreationState creationState)	Apply SQL selections for a specific reference to this ModelPart outside the domain query's root select clause.
void	applySqlSelections(NavigablePath navigablePath, TableGroup tableGroup, DomainResultCreationState creationState, BiConsumer<SqlSelection,JdbcMapping> selectionConsumer)	Apply SQL selections for a specific reference to this ModelPart outside the domain query's root select clause.
<X,Y> int	breakDownJdbcValues(Object domainValue, int offset, X x, Y y, ModelPart.JdbcValueBiConsumer<X,Y> valueConsumer, SharedSessionContractImplementor session)	Breaks down the domain value to its constituent JDBC values.
<T> DomainResult<T>	createDomainResult(NavigablePath navigablePath, TableGroup tableGroup, String resultVariable, DomainResultCreationState creationState)	Create a DomainResult for a specific reference to this ModelPart.
Object	disassemble(Object value, SharedSessionContractImplementor session)	Breaks down a value of J into its simple pieces.
EntityMappingType	findContainingEntityMapping()
<X,Y> int	forEachDisassembledJdbcValue(Object value, int offset, X x, Y y, Bindable.JdbcValuesBiConsumer<X,Y> valuesConsumer, SharedSessionContractImplementor session)	Like Bindable.forEachDisassembledJdbcValue(Object, Object, Object, JdbcValuesBiConsumer, SharedSessionContractImplementor), but additionally receives an offset by which the selectionIndex is incremented when calling Bindable.JdbcValuesBiConsumer.consume(int, Object, Object, Object, JdbcMapping).
int	forEachJdbcType(int offset, IndexedConsumer<JdbcMapping> action)	Visit each JdbcMapping starting from the given offset
int	forEachSelectable(int offset, SelectableConsumer consumer)	Visits each selectable mapping with the selectable index offset by the given value.
Fetch	generateFetch(FetchParent fetchParent, NavigablePath fetchablePath, FetchTiming fetchTiming, boolean selected, String resultVariable, DomainResultCreationState creationState)	Generates a Fetch of this fetchable
String	getAttributeName()	The name of the attribute defining the id, if one
String	getColumnDefinition()
String	getContainingTableExpression()	The table which contains the columns mapped by this value
String	getCustomReadExpression()	The selection's read expression accounting for formula treatment as well as ColumnTransformer.read()
String	getCustomWriteExpression()	The selection's write expression accounting ColumnTransformer.write()
String	getFetchableName()	The name of the fetchable.
Object	getIdentifier(Object entity)	Extract the identifier from an instance of the entity
JavaType<?>	getJavaType()	The Java type for this part.
JdbcMapping	getJdbcMapping()	Anything that is expressible at the SQL AST level would be of basic type.
Long	getLength()
FetchOptions	getMappedFetchOptions()	The configured fetch timing and style
MappingType	getMappedType()	Descriptor for the type of this mapping
EntityIdentifierMapping.Nature	getNature()
NavigableRole	getNavigableRole()
MappingType	getPartMappingType()	The type for this part.
Integer	getPrecision()
PropertyAccess	getPropertyAccess()	Access to the identifier attribute's PropertyAccess
Integer	getScale()
String	getSelectionExpression()	The selection's expression.
FetchStyle	getStyle()
Integer	getTemporalPrecision()
FetchTiming	getTiming()
IdentifierValue	getUnsavedStrategy()	The strategy for distinguishing between detached and transient state based on the identifier mapping
boolean	hasPartitionedSelectionMapping()
Object	instantiate()	Instantiate an instance of the identifier.
boolean	isFormula()	Is the mapping a formula instead of a physical column?
boolean	isInsertable()
boolean	isNullable()	Is the mapping considered nullable?
boolean	isPartitioned()
boolean	isUpdateable()
void	setIdentifier(Object entity, Object id, SharedSessionContractImplementor session)	Inject an identifier value into an instance of the entity
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

asAttributeMapping, asEmbeddedAttributeMapping, asPluralAttributeMapping, compare, getExposedMutabilityPlan, getValue, isEmbeddedAttributeMapping, isPluralAttributeMapping, setValue

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

getCascadeStyle

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

getFetchableKey

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

asBasicValuedModelPart, forEachSelectable, getJdbcMapping, getJdbcTypeCount, getSelectable, getSingleJdbcMapping

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

forEachDisassembledJdbcValue, forEachDisassembledJdbcValue, forEachDisassembledJdbcValue, forEachJdbcType, forEachJdbcValue, forEachJdbcValue, forEachJdbcValue, forEachJdbcValue

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

createSnapshotDomainResult

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

getIdentifier, getIdentifierIfNotUnsaved, isEntityIdentifierMapping

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

incrementFetchDepth, resolveCircularFetch

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

areEqual, asEntityMappingType, breakDownJdbcValues, decompose, decompose, isVirtual

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

getSelectableName, getSelectablePath, getWriteExpression

Methods inherited from interface org.hibernate.metamodel.mapping.internal.SingleAttributeIdentifierMapping

getAttributeMetadata, getDeclaringType, getGenerator, getMutabilityPlan, getPartName, getStateArrayPosition, isIncludedInDirtyChecking, isIncludedInOptimisticLocking, isSelectable, isUpdatable

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

isLob, toSize

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

forEachInsertable, forEachNonFormula, forEachUpdatable, getJdbcTypeCount, getSingleJdbcMapping

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

getExpressibleJavaType, treatAs

Constructor Detail

BasicEntityIdentifierMappingImpl

public BasicEntityIdentifierMappingImpl(EntityPersister entityPersister,
                                        Supplier<?> instanceCreator,
                                        String attributeName,
                                        String rootTable,
                                        String pkColumnName,
                                        String columnDefinition,
                                        Long length,
                                        Integer precision,
                                        Integer scale,
                                        boolean insertable,
                                        boolean updateable,
                                        BasicType<?> idType,
                                        MappingModelCreationProcess creationProcess)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getPropertyAccess

public PropertyAccess getPropertyAccess()

Description copied from interface: SingleAttributeIdentifierMapping

Access to the identifier attribute's PropertyAccess

Specified by:

getPropertyAccess in interface AttributeMapping

Specified by:

getPropertyAccess in interface AttributeMetadata

Specified by:

getPropertyAccess in interface PropertyBasedMapping

Specified by:

getPropertyAccess in interface SingleAttributeIdentifierMapping

getAttributeName

public String getAttributeName()

Description copied from interface: EntityIdentifierMapping

The name of the attribute defining the id, if one

Specified by:

getAttributeName in interface AttributeMapping

Specified by:

getAttributeName in interface EntityIdentifierMapping

Specified by:

getAttributeName in interface SingleAttributeIdentifierMapping

getNature

public EntityIdentifierMapping.Nature getNature()

Specified by:

getNature in interface EntityIdentifierMapping

See Also:

EntityIdentifierMapping.Nature

getUnsavedStrategy

public IdentifierValue getUnsavedStrategy()

Description copied from interface: EntityIdentifierMapping

The strategy for distinguishing between detached and transient state based on the identifier mapping

Specified by:

getUnsavedStrategy in interface EntityIdentifierMapping

See Also:

EntityVersionMapping.getUnsavedStrategy()

getIdentifier

public Object getIdentifier(Object entity)

Description copied from interface: EntityIdentifierMapping

Extract the identifier from an instance of the entity

Specified by:

getIdentifier in interface EntityIdentifierMapping

setIdentifier

public void setIdentifier(Object entity,
                          Object id,
                          SharedSessionContractImplementor session)

Description copied from interface: EntityIdentifierMapping

Inject an identifier value into an instance of the entity

Specified by:

setIdentifier in interface EntityIdentifierMapping

instantiate

public Object instantiate()

Description copied from interface: EntityIdentifierMapping

Instantiate an instance of the identifier.

Specified by:

instantiate in interface EntityIdentifierMapping

getPartMappingType

public MappingType getPartMappingType()

Description copied from interface: ModelPart

The type for this part.

Specified by:

getPartMappingType in interface BasicValuedModelPart

Specified by:

getPartMappingType in interface ModelPart

getMappedType

public MappingType getMappedType()

Description copied from interface: ValueMapping

Descriptor for the type of this mapping

Specified by:

getMappedType in interface ValueMapping

forEachSelectable

public int forEachSelectable(int offset,
                             SelectableConsumer consumer)

Description copied from interface: ModelPart

Visits each selectable mapping with the selectable index offset by the given value. Returns the amount of jdbc types that have been visited.

Specified by:

forEachSelectable in interface BasicValuedModelPart

Specified by:

forEachSelectable in interface ModelPart

Specified by:

forEachSelectable in interface SelectableMappings

Specified by:

forEachSelectable in interface ValuedModelPart

See Also:

SelectableConsumer.accept(int, SelectableMapping)

breakDownJdbcValues

public <X,Y> int breakDownJdbcValues(Object domainValue,
                                           int offset,
                                           X x,
                                           Y y,
                                           ModelPart.JdbcValueBiConsumer<X,Y> valueConsumer,
                                           SharedSessionContractImplementor session)

Description copied from interface: ModelPart

Breaks down the domain value to its constituent JDBC values. Think of it as breaking the multi-dimensional array into a visitable flat array. Additionally, it passes through the values X and Y to the consumer. Returns the amount of jdbc types that have been visited.

Specified by:

breakDownJdbcValues in interface ModelPart

findContainingEntityMapping

public EntityMappingType findContainingEntityMapping()

Specified by:

findContainingEntityMapping in interface AttributeMapping

Specified by:

findContainingEntityMapping in interface ModelPart

forEachJdbcType

public int forEachJdbcType(int offset,
                           IndexedConsumer<JdbcMapping> action)

Description copied from interface: JdbcMappingContainer

Visit each JdbcMapping starting from the given offset

Specified by:

forEachJdbcType in interface JdbcMappingContainer

getJavaType

public JavaType<?> getJavaType()

Description copied from interface: ModelPart

The Java type for this part. Generally equivalent to MappingType.getMappedJavaType() relative to ModelPart.getPartMappingType()

Specified by:

getJavaType in interface ModelPart

getNavigableRole

public NavigableRole getNavigableRole()

Specified by:

getNavigableRole in interface ModelPart

See Also:

ModelPart.getPartName()

createDomainResult

public <T> DomainResult<T> createDomainResult(NavigablePath navigablePath,
                                              TableGroup tableGroup,
                                              String resultVariable,
                                              DomainResultCreationState creationState)

Description copied from interface: ModelPart

Create a DomainResult for a specific reference to this ModelPart.

Specified by:

createDomainResult in interface ModelPart

applySqlSelections

public void applySqlSelections(NavigablePath navigablePath,
                               TableGroup tableGroup,
                               DomainResultCreationState creationState)

Description copied from interface: ModelPart

Apply SQL selections for a specific reference to this ModelPart outside the domain query's root select clause.

Specified by:

applySqlSelections in interface ModelPart

applySqlSelections

public void applySqlSelections(NavigablePath navigablePath,
                               TableGroup tableGroup,
                               DomainResultCreationState creationState,
                               BiConsumer<SqlSelection,JdbcMapping> selectionConsumer)

Description copied from interface: ModelPart

Apply SQL selections for a specific reference to this ModelPart outside the domain query's root select clause.

Specified by:

applySqlSelections in interface ModelPart

getContainingTableExpression

public String getContainingTableExpression()

Description copied from interface: ValuedModelPart

The table which contains the columns mapped by this value

Specified by:

getContainingTableExpression in interface SelectableMapping

Specified by:

getContainingTableExpression in interface ValuedModelPart

getSelectionExpression

public String getSelectionExpression()

Description copied from interface: SelectableMapping

The selection's expression. This is the column name or formula

Specified by:

getSelectionExpression in interface SelectableMapping

isFormula

public boolean isFormula()

Description copied from interface: SelectableMapping

Is the mapping a formula instead of a physical column?

Specified by:

isFormula in interface SelectableMapping

isNullable

public boolean isNullable()

Description copied from interface: SelectableMapping

Is the mapping considered nullable?

Specified by:

isNullable in interface AttributeMetadata

Specified by:

isNullable in interface BasicEntityIdentifierMapping

Specified by:

isNullable in interface SelectableMapping

Specified by:

isNullable in interface SingleAttributeIdentifierMapping

isInsertable

public boolean isInsertable()

Specified by:

isInsertable in interface AttributeMetadata

Specified by:

isInsertable in interface BasicEntityIdentifierMapping

Specified by:

isInsertable in interface SelectableMapping

Specified by:

isInsertable in interface SingleAttributeIdentifierMapping

isUpdateable

public boolean isUpdateable()

Specified by:

isUpdateable in interface SelectableMapping

isPartitioned

public boolean isPartitioned()

Specified by:

isPartitioned in interface SelectableMapping

hasPartitionedSelectionMapping

public boolean hasPartitionedSelectionMapping()

Specified by:

hasPartitionedSelectionMapping in interface BasicValuedModelPart

Specified by:

hasPartitionedSelectionMapping in interface ModelPart

getCustomReadExpression

public String getCustomReadExpression()

Description copied from interface: SelectableMapping

The selection's read expression accounting for formula treatment as well as ColumnTransformer.read()

Specified by:

getCustomReadExpression in interface SelectableMapping

getCustomWriteExpression

public String getCustomWriteExpression()

Description copied from interface: SelectableMapping

The selection's write expression accounting ColumnTransformer.write()

Specified by:

getCustomWriteExpression in interface SelectableMapping

getColumnDefinition

public String getColumnDefinition()

Specified by:

getColumnDefinition in interface SqlTypedMapping

getLength

public Long getLength()

Specified by:

getLength in interface SqlTypedMapping

getPrecision

public Integer getPrecision()

Specified by:

getPrecision in interface SqlTypedMapping

getTemporalPrecision

public Integer getTemporalPrecision()

Specified by:

getTemporalPrecision in interface SqlTypedMapping

getScale

public Integer getScale()

Specified by:

getScale in interface SqlTypedMapping

getJdbcMapping

public JdbcMapping getJdbcMapping()

Description copied from interface: SqlExpressible

Anything that is expressible at the SQL AST level would be of basic type.

Specified by:

getJdbcMapping in interface BasicValuedMapping

Specified by:

getJdbcMapping in interface SqlExpressible

Specified by:

getJdbcMapping in interface SqlTypedMapping

getFetchableName

public String getFetchableName()

Description copied from interface: Fetchable

The name of the fetchable. This is the part's "local name".

Specified by:

getFetchableName in interface Fetchable

See Also:

ModelPart.getNavigableRole(), NavigableRole.getLocalName()

getMappedFetchOptions

public FetchOptions getMappedFetchOptions()

Description copied from interface: Fetchable

The configured fetch timing and style

Specified by:

getMappedFetchOptions in interface Fetchable

disassemble

public Object disassemble(Object value,
                          SharedSessionContractImplementor session)

Description copied from interface: Bindable

Breaks down a value of J into its simple pieces. E.g., an embedded value gets broken down into an array of its attribute state; a basic value converts to itself; etc.

Generally speaking, this is the form in which entity state is kept relative to a Session via EntityEntry.

 @Entity class Person {
     @Id Integer id;
     @Embedded Name name;
     int age;
 }

 @Embeddable class Name {
     String familiarName;
     String familyName;
 }
 

At the top level, we would want to disassemble a Person value, so we'd ask the Bindable for the Person entity to disassemble. Given a Person value:

 Person( id=1, name=Name( 'Steve', 'Ebersole' ), 28 )
 

this disassemble would result in a multidimensional array:

 [ ["Steve", "Ebersole"], 28 ]
 

Note that the identifier is not part of this disassembled state. Note also how the embedded value results in a sub-array.

Specified by:

disassemble in interface BasicValuedMapping

Specified by:

disassemble in interface Bindable

See Also:

EntityEntry

addToCacheKey

public void addToCacheKey(MutableCacheKeyBuilder cacheKey,
                          Object value,
                          SharedSessionContractImplementor session)

Description copied from interface: Bindable

Add to the MutableCacheKey the values obtained disassembling the value and the hasCode generated from the disassembled value.

Specified by:

addToCacheKey in interface BasicValuedMapping

Specified by:

addToCacheKey in interface Bindable

Specified by:

addToCacheKey in interface JavaTypedExpressible

Parameters:

cacheKey - the MutableCacheKey used to add the disassembled value and the hashCode

value - the value to disassemble

session - the SharedSessionContractImplementor

forEachDisassembledJdbcValue

public <X,Y> int forEachDisassembledJdbcValue(Object value,
                                                    int offset,
                                                    X x,
                                                    Y y,
                                                    Bindable.JdbcValuesBiConsumer<X,Y> valuesConsumer,
                                                    SharedSessionContractImplementor session)

Description copied from interface: Bindable

Like Bindable.forEachDisassembledJdbcValue(Object, Object, Object, JdbcValuesBiConsumer, SharedSessionContractImplementor), but additionally receives an offset by which the selectionIndex is incremented when calling Bindable.JdbcValuesBiConsumer.consume(int, Object, Object, Object, JdbcMapping).

Specified by:

forEachDisassembledJdbcValue in interface Bindable

generateFetch

public Fetch generateFetch(FetchParent fetchParent,
                           NavigablePath fetchablePath,
                           FetchTiming fetchTiming,
                           boolean selected,
                           String resultVariable,
                           DomainResultCreationState creationState)

Description copied from interface: Fetchable

Generates a Fetch of this fetchable

Specified by:

generateFetch in interface Fetchable

Parameters:

fetchParent - The parent of the Fetch we are generating

fetchablePath - The overall path within the graph

fetchTiming - The requested fetch timing

getStyle

public FetchStyle getStyle()

Specified by:

getStyle in interface FetchStyleAccess

getTiming

public FetchTiming getTiming()

Specified by:

getTiming in interface FetchTimingAccess