Package org.hibernate.metamodel.model.domain

Class AbstractIdentifiableType<J>

java.lang.Object

org.hibernate.metamodel.model.domain.AbstractDomainType<J>

org.hibernate.metamodel.model.domain.AbstractManagedType<J>

org.hibernate.metamodel.model.domain.AbstractIdentifiableType<J>

All Implemented Interfaces:

IdentifiableType<J>, ManagedType<J>, Type<J>, Serializable, DomainType<J>, IdentifiableDomainType<J>, org.hibernate.metamodel.model.domain.internal.AttributeContainer<J>, ManagedDomainType<J>, SimpleDomainType<J>, BindableType<J>, SqmExpressible<J>

public abstract class AbstractIdentifiableType<J>
extends AbstractManagedType<J>
implements IdentifiableDomainType<J>, Serializable

Defines commonality for the JPA IdentifiableType types. JPA defines identifiable types as entities or mapped-superclasses. Basically things to which an identifier can be attached.

See Also:

Serialized Form

API Note:

Currently we only really have support for direct entities in the Hibernate metamodel as the information for them is consumed into the closest actual entity subclass(es) in the internal Hibernate mapping-metamodel.

Nested Class Summary

Nested classes/interfaces inherited from interface org.hibernate.metamodel.model.domain.internal.AttributeContainer

org.hibernate.metamodel.model.domain.internal.AttributeContainer.InFlightAccess<J extends Object>

Nested classes/interfaces inherited from interface jakarta.persistence.metamodel.Type

Type.PersistenceType

Constructor Summary

Constructors

Constructor	Description
AbstractIdentifiableType(String typeName, JavaType<J> javaType, IdentifiableDomainType<? super J> superType, boolean hasIdClass, boolean hasIdentifierProperty, boolean versioned, JpaMetamodelImplementor jpaMetamodel)

Method Summary

Modifier and Type	Method	Description
protected org.hibernate.metamodel.model.domain.AbstractIdentifiableType.InFlightAccessImpl	createInFlightAccess()
SingularPersistentAttribute<J,?>	findIdAttribute()
List<? extends PersistentAttribute<? super J,?>>	findNaturalIdAttributes()
SingularPersistentAttribute<? super J,?>	findVersionAttribute()
<Y> SingularPersistentAttribute<J,Y>	getDeclaredId(Class<Y> javaType)
SingularAttribute<J,?>	getDeclaredVersion()	For used to retrieve the declared version when populating the static metamodel.
<Y> SingularPersistentAttribute<J,Y>	getDeclaredVersion(Class<Y> javaType)
<Y> SingularPersistentAttribute<? super J,Y>	getId(Class<Y> javaType)
Set<SingularAttribute<? super J,?>>	getIdClassAttributes()
Set<SingularPersistentAttribute<? super J,?>>	getIdClassAttributesSafely()	A form of getIdClassAttributes() which prefers to return null rather than throw exceptions
SqmPathSource<?>	getIdentifierDescriptor()
SimpleDomainType<?>	getIdType()
org.hibernate.metamodel.model.domain.AbstractIdentifiableType.InFlightAccessImpl	getInFlightAccess()
IdentifiableDomainType<? super J>	getSupertype()
IdentifiableDomainType<? super J>	getSuperType()	This type's super type descriptor.
<Y> SingularPersistentAttribute<? super J,Y>	getVersion(Class<Y> javaType)
boolean	hasDeclaredVersionAttribute()
boolean	hasIdClass()
boolean	hasSingleIdAttribute()
boolean	hasVersionAttribute()
protected boolean	isIdMappingRequired()
void	visitIdClassAttributes(Consumer<SingularPersistentAttribute<? super J,?>> attributeConsumer)

Methods inherited from class org.hibernate.metamodel.model.domain.AbstractManagedType

addSubType, findAttribute, findAttributeInSuperTypes, findConcreteGenericAttribute, findDeclaredAttribute, findDeclaredConcreteGenericAttribute, findDeclaredPluralAttribute, findDeclaredSingularAttribute, findPluralAttribute, findSingularAttribute, findSubType, findSubType, findSubTypesAttribute, getAttribute, getAttributes, getCollection, getCollection, getDeclaredAttribute, getDeclaredAttributes, getDeclaredCollection, getDeclaredCollection, getDeclaredList, getDeclaredList, getDeclaredMap, getDeclaredMap, getDeclaredPluralAttributes, getDeclaredSet, getDeclaredSet, getDeclaredSingularAttribute, getDeclaredSingularAttribute, getDeclaredSingularAttributes, getList, getList, getMap, getMap, getPluralAttributes, getRepresentationMode, getSet, getSet, getSingularAttribute, getSingularAttribute, getSingularAttributes, getSubTypes, getTypeName, isPrimitiveVariant, makeSubGraph, toString, visitAttributes, visitDeclaredAttributes, writeReplace

Methods inherited from class org.hibernate.metamodel.model.domain.AbstractDomainType

getBindableJavaType, getExpressibleJavaType, getJavaType, jpaMetamodel

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.metamodel.model.domain.DomainType

getExpressibleJavaType

Methods inherited from interface org.hibernate.metamodel.model.domain.ManagedDomainType

addSubType, findAttribute, findAttributeInSuperTypes, findConcreteGenericAttribute, findDeclaredAttribute, findDeclaredConcreteGenericAttribute, findDeclaredPluralAttribute, findDeclaredSingularAttribute, findPluralAttribute, findSingularAttribute, findSubType, findSubType, findSubTypesAttribute, getAttribute, getDeclaredAttribute, getRepresentationMode, getSubTypes, getTypeName, makeSubGraph, makeSubGraph, visitAttributes, visitDeclaredAttributes

Methods inherited from interface jakarta.persistence.metamodel.ManagedType

getAttributes, getCollection, getCollection, getDeclaredAttributes, getDeclaredCollection, getDeclaredCollection, getDeclaredList, getDeclaredList, getDeclaredMap, getDeclaredMap, getDeclaredPluralAttributes, getDeclaredSet, getDeclaredSet, getDeclaredSingularAttribute, getDeclaredSingularAttribute, getDeclaredSingularAttributes, getList, getList, getMap, getMap, getPluralAttributes, getSet, getSet, getSingularAttribute, getSingularAttribute, getSingularAttributes

Methods inherited from interface org.hibernate.query.sqm.SqmExpressible

getRelationalJavaType, isInstance, resolveExpressible

Methods inherited from interface jakarta.persistence.metamodel.Type

getJavaType, getPersistenceType

Constructor Detail

AbstractIdentifiableType

public AbstractIdentifiableType(String typeName,
                                JavaType<J> javaType,
                                IdentifiableDomainType<? super J> superType,
                                boolean hasIdClass,
                                boolean hasIdentifierProperty,
                                boolean versioned,
                                JpaMetamodelImplementor jpaMetamodel)

Method Detail

createInFlightAccess

protected org.hibernate.metamodel.model.domain.AbstractIdentifiableType.InFlightAccessImpl createInFlightAccess()

Overrides:

createInFlightAccess in class AbstractManagedType<J>

getInFlightAccess

public org.hibernate.metamodel.model.domain.AbstractIdentifiableType.InFlightAccessImpl getInFlightAccess()

Specified by:

getInFlightAccess in interface org.hibernate.metamodel.model.domain.internal.AttributeContainer<J>

Overrides:

getInFlightAccess in class AbstractManagedType<J>

getIdentifierDescriptor

public SqmPathSource<?> getIdentifierDescriptor()

Specified by:

getIdentifierDescriptor in interface IdentifiableDomainType<J>

hasIdClass

public boolean hasIdClass()

Specified by:

hasIdClass in interface IdentifiableDomainType<J>

hasSingleIdAttribute

public boolean hasSingleIdAttribute()

Specified by:

hasSingleIdAttribute in interface IdentifiableType<J>

getSuperType

public IdentifiableDomainType<? super J> getSuperType()

Description copied from interface: ManagedDomainType

This type's super type descriptor. Note : we define this on the managed type descriptor in anticipation of supporting embeddable inheritance

Specified by:

getSuperType in interface ManagedDomainType<J>

Overrides:

getSuperType in class AbstractManagedType<J>

getSupertype

public IdentifiableDomainType<? super J> getSupertype()

Specified by:

getSupertype in interface IdentifiableDomainType<J>

Specified by:

getSupertype in interface IdentifiableType<J>

getId

public <Y> SingularPersistentAttribute<? super J,Y> getId(Class<Y> javaType)

Specified by:

getId in interface IdentifiableDomainType<J>

Specified by:

getId in interface IdentifiableType<J>

findIdAttribute

public SingularPersistentAttribute<J,?> findIdAttribute()

Specified by:

findIdAttribute in interface IdentifiableDomainType<J>

getDeclaredId

public <Y> SingularPersistentAttribute<J,Y> getDeclaredId(Class<Y> javaType)

Specified by:

getDeclaredId in interface IdentifiableDomainType<J>

Specified by:

getDeclaredId in interface IdentifiableType<J>

getIdType

public SimpleDomainType<?> getIdType()

Specified by:

getIdType in interface IdentifiableDomainType<J>

Specified by:

getIdType in interface IdentifiableType<J>

getIdClassAttributesSafely

public Set<SingularPersistentAttribute<? super J,?>> getIdClassAttributesSafely()

A form of getIdClassAttributes() which prefers to return null rather than throw exceptions

Returns:

IdClass attributes or null

getIdClassAttributes

public Set<SingularAttribute<? super J,?>> getIdClassAttributes()

Specified by:

getIdClassAttributes in interface IdentifiableDomainType<J>

Specified by:

getIdClassAttributes in interface IdentifiableType<J>

visitIdClassAttributes

public void visitIdClassAttributes(Consumer<SingularPersistentAttribute<? super J,?>> attributeConsumer)

Specified by:

visitIdClassAttributes in interface IdentifiableDomainType<J>

hasVersionAttribute

public boolean hasVersionAttribute()

Specified by:

hasVersionAttribute in interface IdentifiableType<J>

hasDeclaredVersionAttribute

public boolean hasDeclaredVersionAttribute()

getVersion

public <Y> SingularPersistentAttribute<? super J,Y> getVersion(Class<Y> javaType)

Specified by:

getVersion in interface IdentifiableDomainType<J>

Specified by:

getVersion in interface IdentifiableType<J>

findVersionAttribute

public SingularPersistentAttribute<? super J,?> findVersionAttribute()

Specified by:

findVersionAttribute in interface IdentifiableDomainType<J>

findNaturalIdAttributes

public List<? extends PersistentAttribute<? super J,?>> findNaturalIdAttributes()

Specified by:

findNaturalIdAttributes in interface IdentifiableDomainType<J>

getDeclaredVersion

public <Y> SingularPersistentAttribute<J,Y> getDeclaredVersion(Class<Y> javaType)

Specified by:

getDeclaredVersion in interface IdentifiableDomainType<J>

Specified by:

getDeclaredVersion in interface IdentifiableType<J>

getDeclaredVersion

public SingularAttribute<J,?> getDeclaredVersion()

For used to retrieve the declared version when populating the static metamodel.

Returns:

The declared

isIdMappingRequired

protected boolean isIdMappingRequired()