Package org.hibernate.metamodel.model.domain

Interface IdentifiableDomainType<J>

All Superinterfaces:

BindableType<J>, DomainType<J>, IdentifiableType<J>, ManagedDomainType<J>, ManagedType<J>, SqmExpressible<J>, Type<J>

All Known Subinterfaces:

EntityDomainType<J>, MappedSuperclassDomainType<J>

All Known Implementing Classes:

AbstractIdentifiableType, EntityTypeImpl, MappedSuperclassTypeImpl, SqmPolymorphicRootDescriptor

public interface IdentifiableDomainType<J>
extends ManagedDomainType<J>, IdentifiableType<J>

Extension to the JPA IdentifiableType contract.

Author:

Steve Ebersole

Nested Class Summary

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

Type.PersistenceType

Method Summary

Modifier and Type	Method	Description
SingularPersistentAttribute<? super J,?>	findIdAttribute()
List<? extends PersistentAttribute<? super J,?>>	findNaturalIdAttributes()
SingularPersistentAttribute<? super J,?>	findVersionAttribute()
<Y> SingularPersistentAttribute<J,Y>	getDeclaredId(Class<Y> type)	Return the attribute that corresponds to the id attribute declared by the entity or mapped superclass.
<Y> SingularPersistentAttribute<J,Y>	getDeclaredVersion(Class<Y> type)	Return the attribute that corresponds to the version attribute declared by the entity or mapped superclass.
<Y> SingularPersistentAttribute<? super J,Y>	getId(Class<Y> type)	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.
SqmPathSource<?>	getIdentifierDescriptor()
SimpleDomainType<?>	getIdType()	Return the type that represents the type of the id.
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.
<Y> SingularPersistentAttribute<? super J,Y>	getVersion(Class<Y> type)	Return the attribute that corresponds to the version attribute of the entity or mapped superclass.
boolean	hasIdClass()
void	visitIdClassAttributes(Consumer<SingularPersistentAttribute<? super J,?>> action)

Methods inherited from interface org.hibernate.query.BindableType

getBindableJavaType

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

getSqmType, getTupleLength

Methods inherited from interface jakarta.persistence.metamodel.IdentifiableType

hasSingleIdAttribute, hasVersionAttribute

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, getSuperType, 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

Method Details

getIdentifierDescriptor

SqmPathSource<?> getIdentifierDescriptor()

getId

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

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 IdentifiableType<J>

Parameters:

type - the type of the represented id attribute

Returns:

id attribute

getDeclaredId

<Y> SingularPersistentAttribute<J,Y> getDeclaredId(Class<Y> type)

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 IdentifiableType<J>

Parameters:

type - the type of the represented declared id attribute

Returns:

declared id attribute

getVersion

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

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 IdentifiableType<J>

Parameters:

type - the type of the represented version attribute

Returns:

version attribute

getDeclaredVersion

<Y> SingularPersistentAttribute<J,Y> getDeclaredVersion(Class<Y> type)

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 IdentifiableType<J>

Parameters:

type - the type of the represented declared version attribute

Returns:

declared version attribute

getIdClassAttributes

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 IdentifiableType<J>

Returns:

id attributes

getIdType

SimpleDomainType<?> getIdType()

Description copied from interface: IdentifiableType

Return the type that represents the type of the id.

Specified by:

getIdType in interface IdentifiableType<J>

Returns:

type of id

getSupertype

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 IdentifiableType<J>

Returns:

supertype of identifiable type or null if no such supertype

hasIdClass

boolean hasIdClass()

findIdAttribute

SingularPersistentAttribute<? super J,?> findIdAttribute()

visitIdClassAttributes

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

findVersionAttribute

SingularPersistentAttribute<? super J,?> findVersionAttribute()

findNaturalIdAttributes

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