Interface EntityIdentifierMapping

All Superinterfaces:

Bindable, Fetchable, JavaTypedExpressible, JdbcMappingContainer, MappingModelExpressible, ModelPart, SelectableMappings, ValuedModelPart, ValueMapping

All Known Subinterfaces:

AggregatedIdentifierMapping, BasicEntityIdentifierMapping, CompositeIdentifierMapping, NonAggregatedIdentifierMapping, SingleAttributeIdentifierMapping

public interface EntityIdentifierMapping
extends ValuedModelPart, Fetchable

Describes the mapping of an entity's identifier.

See Also:

• Id
• EmbeddedId
• EntityIdentifierMapping.Nature

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	EntityIdentifierMapping.Nature	The style of identifier used.

Nested classes/interfaces inherited from interface Bindable

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

Nested classes/interfaces inherited from interface ModelPart

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID_ROLE_NAME
static final String	LEGACY_ID_NAME

Method Summary

Modifier and Type	Method	Description
String	getAttributeName()	The name of the attribute defining the id, if one
Object	getIdentifier(Object entity)	Extract the identifier from an instance of the entity
default Object	getIdentifier(Object entity, MergeContext mergeContext)	Extract the identifier from an instance of the entity
default Object	getIdentifierIfNotUnsaved(Object entity, SharedSessionContractImplementor session)	Return the identifier of the persistent or transient object, or throw an exception if the instance is "unsaved"
EntityIdentifierMapping.Nature	getNature()
default String	getPartName()	The local part name, which is generally the unqualified role name
IdentifierValue	getUnsavedStrategy()	The strategy for distinguishing between detached and transient state based on the identifier mapping
Object	instantiate()	Instantiate an instance of the identifier.
default boolean	isEntityIdentifierMapping()
static boolean	matchesRoleName(String name)
void	setIdentifier(Object entity, Object id, SharedSessionContractImplementor session)	Inject an identifier value into an instance of the entity

Methods inherited from interface Bindable

addToCacheKey, disassemble, forEachDisassembledJdbcValue, forEachDisassembledJdbcValue, forEachDisassembledJdbcValue, forEachDisassembledJdbcValue, forEachJdbcType, forEachJdbcValue, forEachJdbcValue, forEachJdbcValue, forEachJdbcValue

Methods inherited from interface Fetchable

generateFetch, getFetchableKey, getFetchableName, getMappedFetchOptions, incrementFetchDepth, isSelectable, resolveCircularFetch

Methods inherited from interface JavaTypedExpressible

addToCacheKey

Methods inherited from interface JdbcMappingContainer

forEachJdbcType, getJdbcMapping

Methods inherited from interface ModelPart

applySqlSelections, applySqlSelections, areEqual, asAttributeMapping, asBasicValuedModelPart, asEntityMappingType, breakDownJdbcValues, breakDownJdbcValues, createDomainResult, decompose, decompose, findContainingEntityMapping, getJavaType, getNavigableRole, getPartMappingType, hasPartitionedSelectionMapping, isVirtual

Methods inherited from interface SelectableMappings

getSelectable

Methods inherited from interface ValuedModelPart

forEachColumn, forEachInsertable, forEachNonFormula, forEachSelectable, forEachSelectable, forEachUpdatable, getContainingTableExpression, getJdbcTypeCount, getSingleJdbcMapping

Methods inherited from interface ValueMapping

getExpressibleJavaType, getMappedType, treatAs

Field Details

ID_ROLE_NAME

static final String ID_ROLE_NAME

See Also:

• Constant Field Values

LEGACY_ID_NAME

static final String LEGACY_ID_NAME

See Also:

• Constant Field Values

Method Details

matchesRoleName

static boolean matchesRoleName(@Nonnull
 String name)

getPartName

@Nonnull
default String getPartName()

Description copied from interface: ModelPart

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

Specified by:

getPartName in interface ModelPart

getNature

@Nonnull
EntityIdentifierMapping.Nature getNature()

See Also:

• EntityIdentifierMapping.Nature

getAttributeName

@Nullable
String getAttributeName()

The name of the attribute defining the id, if one

getUnsavedStrategy

@Nonnull
IdentifierValue getUnsavedStrategy()

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

See Also:

• EntityVersionMapping.getUnsavedStrategy()

instantiate

@Nullable
Object instantiate()

Instantiate an instance of the identifier.

API Note:

This is really only valid on composite identifiers

getIdentifier

@Nullable
Object getIdentifier(@Nonnull
 Object entity)

Extract the identifier from an instance of the entity

getIdentifier

@Nullable
default Object getIdentifier(@Nonnull
 Object entity,
 @Nullable
 MergeContext mergeContext)

Extract the identifier from an instance of the entity

API Note:

Intended for use during the merging process

getIdentifierIfNotUnsaved

@Nullable
default Object getIdentifierIfNotUnsaved(@Nullable
 Object entity,
 @Nullable
 SharedSessionContractImplementor session)

Return the identifier of the persistent or transient object, or throw an exception if the instance is "unsaved"

Parameters:

entity - The entity instance

session - The session

Returns:

The identifier

Throws:

TransientObjectException - if the entity is transient (does not yet have an identifier)

Since:

6.1.1

See Also:

• ForeignKeys.getEntityIdentifierIfNotUnsaved(String, Object, SharedSessionContractImplementor)

API Note:

This method is called by OneToOneType and ManyToOneType to determine the id value which should be used for an object that may or may not be associated with the session. This does a "best guess" using any/all info available to use (not just the EntityEntry).

setIdentifier

void setIdentifier(@Nonnull
 Object entity,
 @Nullable
 Object id,
 @Nonnull
 SharedSessionContractImplementor session)

Inject an identifier value into an instance of the entity

isEntityIdentifierMapping

default boolean isEntityIdentifierMapping()

Specified by:

isEntityIdentifierMapping in interface ModelPart