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>, AttributeContainer<J>, ManagedDomainType<J>, SimpleDomainType<J>, BindableType<J>, SqmExpressible<J>

Direct Known Subclasses:

EntityTypeImpl, MappedSuperclassTypeImpl

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

Functionality common to all implementations of IdentifiableType.

An identifiable type is one which may have an identifier attribute, that is, an entity type or a mapped superclass.

Author:

Steve Ebersole

See Also:

• Serialized Form

Nested Class Summary

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

AttributeContainer.InFlightAccess<J>

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 metamodel)

Method Summary

Modifier and Type	Method	Description
protected AbstractIdentifiableType<J>.org.hibernate.metamodel.model.domain.AbstractIdentifiableType.InFlightAccessImpl	createInFlightAccess()
SingularPersistentAttribute<? super J,?>	findIdAttribute()
List<? extends PersistentAttribute<? super J,?>>	findNaturalIdAttributes()
SingularPersistentAttribute<? super J,?>	findVersionAttribute()
<Y> SingularPersistentAttribute<J,Y>	getDeclaredId(Class<Y> javaType)	Return the attribute that corresponds to the id attribute declared by the entity or mapped superclass.
SingularAttribute<J,?>	getDeclaredVersion()	For used to retrieve the declared version when populating the static metamodel.
<Y> SingularPersistentAttribute<J,Y>	getDeclaredVersion(Class<Y> javaType)	Return the attribute that corresponds to the version attribute declared by the entity or mapped superclass.
<Y> SingularPersistentAttribute<? super J,Y>	getId(Class<Y> javaType)	Return the attribute that corresponds to the id attribute of the entity or mapped superclass.
Set<SingularAttribute<? super J,?>>	getIdClassAttributes()	Return the attributes corresponding to the id class of the identifiable type.
Set<SingularPersistentAttribute<? super J,?>>	getIdClassAttributesSafely()	A form of getIdClassAttributes() which prefers to return null rather than throw exceptions
SqmPathSource<?>	getIdentifierDescriptor()
SimpleDomainType<?>	getIdType()	Return the type that represents the type of the id.
AbstractIdentifiableType<J>.org.hibernate.metamodel.model.domain.AbstractIdentifiableType.InFlightAccessImpl	getInFlightAccess()
IdentifiableDomainType<? super J>	getSupertype()	Return the identifiable type that corresponds to the most specific mapped superclass or entity extended by the entity or mapped superclass.
IdentifiableDomainType<? super J>	getSuperType()	The descriptor of the supertype of this type.
<Y> SingularPersistentAttribute<? super J,Y>	getVersion(Class<Y> javaType)	Return the attribute that corresponds to the version attribute of the entity or mapped superclass.
boolean	hasDeclaredVersionAttribute()
boolean	hasIdClass()
boolean	hasSingleIdAttribute()	Whether the identifiable type has a single id attribute.
boolean	hasVersionAttribute()	Whether the identifiable type has a version attribute.
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, 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, toString, visitAttributes, visitDeclaredAttributes, writeReplace

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

getBindableJavaType, getExpressibleJavaType, getJavaType

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

getSqmType, getTupleLength

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

addSubType, findAttribute, findAttributeInSuperTypes, findConcreteGenericAttribute, findDeclaredAttribute, findDeclaredConcreteGenericAttribute, findDeclaredPluralAttribute, findDeclaredSingularAttribute, findPluralAttribute, findSingularAttribute, findSubTypesAttribute, getAttribute, getDeclaredAttribute, getRepresentationMode, getSubTypes, getTypeName, 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

getExpressibleJavaType, getRelationalJavaType, isInstance, resolveExpressible

Methods inherited from interface jakarta.persistence.metamodel.Type

getJavaType, getPersistenceType

Constructor Details

AbstractIdentifiableType

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

Method Details

createInFlightAccess

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

Overrides:

createInFlightAccess in class AbstractManagedType<J>

getInFlightAccess

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

Specified by:

getInFlightAccess in interface 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()

Description copied from interface: IdentifiableType

Whether the identifiable type has a single id attribute. Returns true for a simple id or embedded id; returns false for an idclass.

Specified by:

hasSingleIdAttribute in interface IdentifiableType<J>

Returns:

boolean indicating whether the identifiable type has a single id attribute

getSuperType

public IdentifiableDomainType<? super J> getSuperType()

Description copied from interface: ManagedDomainType

The descriptor of the supertype of this type.

Specified by:

getSuperType in interface ManagedDomainType<J>

Overrides:

getSuperType in class AbstractManagedType<J>

getSupertype

public IdentifiableDomainType<? super J> getSupertype()

Description copied from interface: IdentifiableType

Return the identifiable type that corresponds to the most specific mapped superclass or entity extended by the entity or mapped superclass.

Specified by:

getSupertype in interface IdentifiableDomainType<J>

Specified by:

getSupertype in interface IdentifiableType<J>

Returns:

supertype of identifiable type or null if no such supertype

getId

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

Description copied from interface: IdentifiableType

Return the attribute that corresponds to the id attribute of the entity or mapped superclass.

Specified by:

getId in interface IdentifiableDomainType<J>

Specified by:

getId in interface IdentifiableType<J>

Parameters:

javaType - the type of the represented id attribute

Returns:

id attribute

findIdAttribute

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

Specified by:

findIdAttribute in interface IdentifiableDomainType<J>

getDeclaredId

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

Description copied from interface: IdentifiableType

Return the attribute that corresponds to the id attribute declared by the entity or mapped superclass.

Specified by:

getDeclaredId in interface IdentifiableDomainType<J>

Specified by:

getDeclaredId in interface IdentifiableType<J>

Parameters:

javaType - the type of the represented declared id attribute

Returns:

declared id attribute

getIdType

public SimpleDomainType<?> getIdType()

Description copied from interface: IdentifiableType

Return the type that represents the type of the id.

Specified by:

getIdType in interface IdentifiableDomainType<J>

Specified by:

getIdType in interface IdentifiableType<J>

Returns:

type of id

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()

Description copied from interface: IdentifiableType

Return the attributes corresponding to the id class of the identifiable type.

Specified by:

getIdClassAttributes in interface IdentifiableDomainType<J>

Specified by:

getIdClassAttributes in interface IdentifiableType<J>

Returns:

id attributes

visitIdClassAttributes

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

Specified by:

visitIdClassAttributes in interface IdentifiableDomainType<J>

hasVersionAttribute

public boolean hasVersionAttribute()

Description copied from interface: IdentifiableType

Whether the identifiable type has a version attribute.

Specified by:

hasVersionAttribute in interface IdentifiableType<J>

Returns:

boolean indicating whether the identifiable type has a version attribute

hasDeclaredVersionAttribute

public boolean hasDeclaredVersionAttribute()

getVersion

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

Description copied from interface: IdentifiableType

Return the attribute that corresponds to the version attribute of the entity or mapped superclass.

Specified by:

getVersion in interface IdentifiableDomainType<J>

Specified by:

getVersion in interface IdentifiableType<J>

Parameters:

javaType - the type of the represented version attribute

Returns:

version attribute

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)

Description copied from interface: IdentifiableType

Return the attribute that corresponds to the version attribute declared by the entity or mapped superclass.

Specified by:

getDeclaredVersion in interface IdentifiableDomainType<J>

Specified by:

getDeclaredVersion in interface IdentifiableType<J>

Parameters:

javaType - the type of the represented declared version attribute

Returns:

declared version attribute

getDeclaredVersion

public SingularAttribute<J,?> getDeclaredVersion()

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

Returns:

The declared

isIdMappingRequired

protected boolean isIdMappingRequired()