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

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

Method Summary

Modifier and Type	Method and Description
public String	getAttributeName() The name of the attribute defining the id, if one
public Object	getIdentifier(Object entity) Extract the identifier from an instance of the entity
public default Object	Returns: The identifier getIdentifierIfNotUnsaved(Object The entity instance entity, SharedSessionContractImplementor The session session) Return the identifier of the persistent or transient object, or throw an exception if the instance is "unsaved" Used by OneToOneType and ManyToOneType to determine what id value should be used for an object that may or may not be associated with the session.
public EntityIdentifierMapping.Nature	getNature()
public default String	getPartName() Implements org.hibernate.metamodel.mapping.ModelPart.getPartName. The local part name, which is generally the unqualified role name
public IdentifierValue	getUnsavedStrategy() The strategy for distinguishing between detached and transient state based on the identifier mapping
public Object	instantiate() Instantiate an instance of the identifier.
public default boolean	isEntityIdentifierMapping() Overrides default org.hibernate.metamodel.mapping.ModelPart.isEntityIdentifierMapping.
public static boolean	matchesRoleName(String name)
public void	setIdentifier(Object entity, Object id, SharedSessionContractImplementor session) Inject an identifier value into an instance of the entity

Inherited from org.hibernate.metamodel.mapping.ValuedModelPart:: forEachInsertable forEachNonFormula forEachSelectable forEachSelectable forEachUpdatable getContainingTableExpression getJdbcTypeCount getSingleJdbcMapping

Field Detail

ID_ROLE_NAME	back to summary
public static final String ID_ROLE_NAME

LEGACY_ID_NAME	back to summary
public static final String LEGACY_ID_NAME

Method Detail

getAttributeName	back to summary
public String getAttributeName() The name of the attribute defining the id, if one

getIdentifier	back to summary
public Object getIdentifier(Object entity) Extract the identifier from an instance of the entity

getIdentifierIfNotUnsaved back to summary

getIdentifierIfNotUnsaved	back to summary
public 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" Used by OneToOneType and ManyToOneType to determine what id value 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). Parameters entity:Object The entity instance session:SharedSessionContractImplementor The session Returns:Object The identifier Exceptions TransientObjectException: if the entity is transient (does not yet have an identifier) Since 6.1.1 See Also `org.hibernate.engine.internal.ForeignKeys#getEntityIdentifierIfNotUnsaved(String, Object, SharedSessionContractImplementor)`

public 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"

Used by OneToOneType and ManyToOneType to determine what id value 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).

Parameters

entity:Object: The entity instance
session:SharedSessionContractImplementor: The session

Returns:Object

The identifier

Exceptions

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

Since

6.1.1

See Also

org.hibernate.engine.internal.ForeignKeys#getEntityIdentifierIfNotUnsaved(String, Object, SharedSessionContractImplementor)

getNature	back to summary
public EntityIdentifierMapping.Nature getNature() See Also `Nature`

getPartName	back 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

getPartName

back 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

getUnsavedStrategy back to summary

getUnsavedStrategy	back to summary
public IdentifierValue getUnsavedStrategy() The strategy for distinguishing between detached and transient state based on the identifier mapping See Also `EntityVersionMapping#getUnsavedStrategy()`

public IdentifierValue getUnsavedStrategy()

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

See Also: EntityVersionMapping#getUnsavedStrategy()

instantiate	back to summary
public Object instantiate() Instantiate an instance of the identifier. API Note This is really only valid on composite identifiers

isEntityIdentifierMapping	back to summary
public default boolean isEntityIdentifierMapping() Overrides default org.hibernate.metamodel.mapping.ModelPart.isEntityIdentifierMapping. Annotations @Override

isEntityIdentifierMapping

back to summary

public default boolean isEntityIdentifierMapping()

Overrides default org.hibernate.metamodel.mapping.ModelPart.isEntityIdentifierMapping.

Annotations

@Override

matchesRoleName	back to summary
public static boolean matchesRoleName(String name)

setIdentifier	back to summary
public void setIdentifier(Object entity, Object id, SharedSessionContractImplementor session) Inject an identifier value into an instance of the entity

org.hibernate.metamodel.mapping back to summary

public final Enum EntityIdentifierMapping.Nature

Class Inheritance

extends Enum<EntityIdentifierMapping.Nature>

java.lang.Object
java.lang.Enum
org.hibernate.metamodel.mapping.EntityIdentifierMapping.Nature

The style of identifier used.

Field Summary

Modifier and Type	Field and Description
public static final EntityIdentifierMapping.Nature	COMPOSITE An "aggregated" composite identifier, which is another way to say that the identifier is represented as an embeddable.
public static final EntityIdentifierMapping.Nature	SIMPLE Simple, single-column identifier.
public static final EntityIdentifierMapping.Nature	VIRTUAL Composite identifier defined with multiple `Id` mappings.

Constructor Summary

Access	Constructor and Description
private	Nature()

Method Summary

Modifier and Type	Method and Description
public static EntityIdentifierMapping.Nature	valueOf(String name)
public static EntityIdentifierMapping.Nature[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

COMPOSITE back to summary

COMPOSITE	back to summary
public static final EntityIdentifierMapping.Nature COMPOSITE An "aggregated" composite identifier, which is another way to say that the identifier is represented as an embeddable. See Also `EmbeddedId`, `AggregatedIdentifierMapping`

public static final EntityIdentifierMapping.Nature COMPOSITE

An "aggregated" composite identifier, which is another way to say that the identifier is represented as an embeddable.

See Also: EmbeddedId, AggregatedIdentifierMapping

SIMPLE back to summary

SIMPLE	back to summary
public static final EntityIdentifierMapping.Nature SIMPLE Simple, single-column identifier. See Also `Id`, `BasicEntityIdentifierMapping`

public static final EntityIdentifierMapping.Nature SIMPLE

Simple, single-column identifier.

See Also: Id, BasicEntityIdentifierMapping

VIRTUAL back to summary

VIRTUAL	back to summary
public static final EntityIdentifierMapping.Nature VIRTUAL Composite identifier defined with multiple `Id` mappings. Often used in conjunction with an `IdClass` See Also `Id`, `IdClass`, `NonAggregatedIdentifierMapping`

public static final EntityIdentifierMapping.Nature VIRTUAL

Composite identifier defined with multiple Id mappings. Often used in conjunction with an IdClass

See Also: Id, IdClass, NonAggregatedIdentifierMapping

Constructor Detail

Nature	back to summary
private Nature()

Method Detail

valueOf	back to summary
public static EntityIdentifierMapping.Nature valueOf(String name)

values	back to summary
public static EntityIdentifierMapping.Nature[] values()

public Interface EntityIdentifierMapping

Nested and Inner Type Summary

Field Summary

Method Summary

Field Detail

Method Detail

public final Enum EntityIdentifierMapping.Nature

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail