Package org.hibernate.metamodel.mapping.internal

Class SimpleNaturalIdMapping

java.lang.Object

org.hibernate.metamodel.mapping.internal.AbstractNaturalIdMapping

org.hibernate.metamodel.mapping.internal.SimpleNaturalIdMapping

All Implemented Interfaces:

BasicValuedMapping, Bindable, JdbcMappingContainer, MappingModelExpressible, ModelPart, NaturalIdMapping, SqlExpressible, ValueMapping, VirtualModelPart, JavaType.CoercionContext, JavaTypedExpressible

public class SimpleNaturalIdMapping
extends AbstractNaturalIdMapping
implements JavaType.CoercionContext, BasicValuedMapping

Single-attribute NaturalIdMapping implementation

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.ModelPart

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

Field Summary

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

PART_NAME

Constructor Summary

Constructors

Constructor	Description
SimpleNaturalIdMapping(SingularAttributeMapping attribute, EntityMappingType declaringType, 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.
AttributeMapping	asAttributeMapping()
<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.
int	calculateHashCode(Object value)	Calculate the hash-code of a natural-id value
<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.
Object	extractNaturalIdFromEntity(Object entity)	Given an entity instance, extract the normalized natural id representation
Object	extractNaturalIdFromEntityState(Object[] state)	Given an array of "full entity state", extract the normalized natural id representation
<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
<X, Y> int	forEachJdbcValue(Object value, int offset, X x, Y y, Bindable.JdbcValuesBiConsumer<X,Y> valuesConsumer, SharedSessionContractImplementor session)	Visit each constituent JDBC value extracted from the entity instance itself.
int	forEachSelectable(int offset, SelectableConsumer consumer)	Visits each selectable mapping with the selectable index offset by the given value.
SingularAttributeMapping	getAttribute()
JavaType<?>	getJavaType()	The Java type for this part.
JdbcMapping	getJdbcMapping()	Anything that is expressible at the SQL AST level would be of basic type.
JdbcMapping	getJdbcMapping(int index)
int	getJdbcTypeCount()	The number of JDBC mappings
MappingType	getMappedType()	Descriptor for the type of this mapping
List<SingularAttributeMapping>	getNaturalIdAttributes()	The attribute(s) making up the natural-id.
MappingType	getPartMappingType()	The type for this part.
JdbcMapping	getSingleJdbcMapping()
TypeConfiguration	getTypeConfiguration()
boolean	hasPartitionedSelectionMapping()
NaturalIdLoader<?>	makeLoader(EntityMappingType entityDescriptor)	Make a loader capable of loading a single entity by natural-id
MultiNaturalIdLoader<?>	makeMultiLoader(EntityMappingType entityDescriptor)	Make a loader capable of loading multiple entities by natural-id
Object	normalizeIncomingValue(Object naturalIdToLoad)
Object	normalizeInput(Object incoming)	Normalize a user-provided natural-id value into the representation Hibernate uses internally
void	validateInternalForm(Object naturalIdValue)	Validates a natural id value(s) for the described natural-id based on the expected internal representation
void	verifyFlushState(Object id, Object[] currentState, Object[] loadedState, SharedSessionContractImplementor session)	Verify the natural-id value(s) we are about to flush to the database

Methods inherited from class org.hibernate.metamodel.mapping.internal.AbstractNaturalIdMapping

findContainingEntityMapping, getCacheAccess, getDeclaringType, getNavigableRole, isMutable

Methods inherited from class java.lang.Object

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

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

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

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

areEqual, asBasicValuedModelPart, asEntityMappingType, breakDownJdbcValues, decompose, decompose, forEachSelectable, isEntityIdentifierMapping

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

getPartName

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

getExpressibleJavaType, treatAs

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

isVirtual

Constructor Details

SimpleNaturalIdMapping

public SimpleNaturalIdMapping(SingularAttributeMapping attribute,
 EntityMappingType declaringType,
 MappingModelCreationProcess creationProcess)

Method Details

getAttribute

public SingularAttributeMapping getAttribute()

verifyFlushState

public void verifyFlushState(Object id,
 Object[] currentState,
 Object[] loadedState,
 SharedSessionContractImplementor session)

Description copied from interface: NaturalIdMapping

Verify the natural-id value(s) we are about to flush to the database

Specified by:

verifyFlushState in interface NaturalIdMapping

extractNaturalIdFromEntityState

public Object extractNaturalIdFromEntityState(Object[] state)

Description copied from interface: NaturalIdMapping

Given an array of "full entity state", extract the normalized natural id representation

Specified by:

extractNaturalIdFromEntityState in interface NaturalIdMapping

Parameters:

state - The attribute state array

Returns:

The extracted natural id values. This is a normalized

extractNaturalIdFromEntity

public Object extractNaturalIdFromEntity(Object entity)

Description copied from interface: NaturalIdMapping

Given an entity instance, extract the normalized natural id representation

Specified by:

extractNaturalIdFromEntity in interface NaturalIdMapping

Parameters:

entity - The entity instance

Returns:

The extracted natural id values

validateInternalForm

public void validateInternalForm(Object naturalIdValue)

Description copied from interface: NaturalIdMapping

Validates a natural id value(s) for the described natural-id based on the expected internal representation

Specified by:

validateInternalForm in interface NaturalIdMapping

calculateHashCode

public int calculateHashCode(Object value)

Description copied from interface: NaturalIdMapping

Calculate the hash-code of a natural-id value

Specified by:

calculateHashCode in interface NaturalIdMapping

Parameters:

value - The natural-id value

Returns:

The hash-code

normalizeInput

public Object normalizeInput(Object incoming)

Description copied from interface: NaturalIdMapping

Normalize a user-provided natural-id value into the representation Hibernate uses internally

Specified by:

normalizeInput in interface NaturalIdMapping

Parameters:

incoming - The user-supplied value

Returns:

The normalized, internal representation

normalizeIncomingValue

public Object normalizeIncomingValue(Object naturalIdToLoad)

getNaturalIdAttributes

public List<SingularAttributeMapping> getNaturalIdAttributes()

Description copied from interface: NaturalIdMapping

The attribute(s) making up the natural-id.

Specified by:

getNaturalIdAttributes in interface NaturalIdMapping

getPartMappingType

public MappingType getPartMappingType()

Description copied from interface: ModelPart

The type for this part.

Specified by:

getPartMappingType in interface ModelPart

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

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

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 ModelPart

getJdbcTypeCount

public int getJdbcTypeCount()

Description copied from interface: Bindable

The number of JDBC mappings

Specified by:

getJdbcTypeCount in interface BasicValuedMapping

Specified by:

getJdbcTypeCount in interface Bindable

Specified by:

getJdbcTypeCount in interface JdbcMappingContainer

getJdbcMapping

public JdbcMapping getJdbcMapping(int index)

Specified by:

getJdbcMapping in interface BasicValuedMapping

Specified by:

getJdbcMapping in interface JdbcMappingContainer

Specified by:

getJdbcMapping in interface SqlExpressible

getSingleJdbcMapping

public JdbcMapping getSingleJdbcMapping()

Specified by:

getSingleJdbcMapping in interface BasicValuedMapping

Specified by:

getSingleJdbcMapping in interface JdbcMappingContainer

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

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

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:

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

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

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

forEachJdbcValue

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

Description copied from interface: Bindable

Visit each constituent JDBC value extracted from the entity instance itself. Short-hand form of calling Bindable.disassemble(java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor) and piping its result to Bindable.forEachDisassembledJdbcValue(Object, int, JdbcValuesConsumer, SharedSessionContractImplementor)

Specified by:

forEachJdbcValue in interface Bindable

makeLoader

public NaturalIdLoader<?> makeLoader(EntityMappingType entityDescriptor)

Description copied from interface: NaturalIdMapping

Make a loader capable of loading a single entity by natural-id

Specified by:

makeLoader in interface NaturalIdMapping

makeMultiLoader

public MultiNaturalIdLoader<?> makeMultiLoader(EntityMappingType entityDescriptor)

Description copied from interface: NaturalIdMapping

Make a loader capable of loading multiple entities by natural-id

Specified by:

makeMultiLoader in interface NaturalIdMapping

getTypeConfiguration

public TypeConfiguration getTypeConfiguration()

Specified by:

getTypeConfiguration in interface JavaType.CoercionContext

asAttributeMapping

public AttributeMapping asAttributeMapping()

Specified by:

asAttributeMapping in interface ModelPart

hasPartitionedSelectionMapping

public boolean hasPartitionedSelectionMapping()

Specified by:

hasPartitionedSelectionMapping 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