org.hibernate.jpa.internal.metamodel

Class AbstractIdentifiableType<X>

java.lang.Object

org.hibernate.jpa.internal.metamodel.AbstractType<X>

org.hibernate.jpa.internal.metamodel.AbstractManagedType<X>

org.hibernate.jpa.internal.metamodel.AbstractIdentifiableType<X>

All Implemented Interfaces:

Serializable, IdentifiableType<X>, ManagedType<X>, Type<X>

Direct Known Subclasses:

EntityTypeImpl, MappedSuperclassTypeImpl

public abstract class AbstractIdentifiableType<X>
extends AbstractManagedType<X>
implements IdentifiableType<X>, 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.

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.

Author:

Steve Ebersole

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractIdentifiableType.Builder<X>

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

Type.PersistenceType

Constructor Summary

Constructors

Constructor and Description
AbstractIdentifiableType(Class<X> javaType, String typeName, AbstractIdentifiableType<? super X> superType, boolean hasIdClass, boolean hasIdentifierProperty, boolean versioned)

Method Summary

Modifier and Type	Method and Description
AbstractIdentifiableType.Builder<X>	getBuilder()
<Y> SingularAttribute<X,Y>	getDeclaredId(Class<Y> javaType) Return the attribute that corresponds to the id attribute declared by the entity or mapped superclass.
SingularAttribute<X,?>	getDeclaredVersion() For used to retrieve the declared version when populating the static metamodel.
<Y> SingularAttribute<X,Y>	getDeclaredVersion(Class<Y> javaType) Return the attribute that corresponds to the version attribute declared by the entity or mapped superclass.
<Y> SingularAttribute<? super X,Y>	getId(Class<Y> javaType) Return the attribute that corresponds to the id attribute of the entity or mapped superclass.
Set<SingularAttribute<? super X,?>>	getIdClassAttributes() Return the attributes corresponding to the id class of the identifiable type.
Set<SingularAttribute<? super X,?>>	getIdClassAttributesSafely() A form of getIdClassAttributes() which prefers to return null rather than throw exceptions
Type<?>	getIdType() Return the type that represents the type of the id.
AbstractIdentifiableType<? super X>	getSupertype() Return the identifiable type that corresponds to the most specific mapped superclass or entity extended by the entity or mapped superclass.
<Y> SingularAttribute<? super X,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 SingularAttributeImpl	internalGetId()
protected SingularAttributeImpl	internalGetVersion()

Methods inherited from class org.hibernate.jpa.internal.metamodel.AbstractManagedType

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

Methods inherited from class org.hibernate.jpa.internal.metamodel.AbstractType

getJavaType, getTypeName

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.persistence.metamodel.ManagedType

getAttribute, getAttributes, getCollection, getCollection, getDeclaredAttribute, 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 javax.persistence.metamodel.Type

getJavaType, getPersistenceType

Constructor Detail

AbstractIdentifiableType

public AbstractIdentifiableType(Class<X> javaType,
                                String typeName,
                                AbstractIdentifiableType<? super X> superType,
                                boolean hasIdClass,
                                boolean hasIdentifierProperty,
                                boolean versioned)

Method Detail

hasIdClass

public boolean hasIdClass()

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<X>

Returns:

boolean indicating whether the identifiable type has a single id attribute

getSupertype

public AbstractIdentifiableType<? super X> 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<X>

Overrides:

getSupertype in class AbstractManagedType<X>

Returns:

supertype of identifiable type or null if no such supertype

getId

public <Y> SingularAttribute<? super X,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 IdentifiableType<X>

Parameters:

javaType - the type of the represented id attribute

Returns:

id attribute

internalGetId

protected SingularAttributeImpl internalGetId()

getDeclaredId

public <Y> SingularAttribute<X,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 IdentifiableType<X>

Parameters:

javaType - the type of the represented declared id attribute

Returns:

declared id attribute

getIdType

public Type<?> getIdType()

Description copied from interface: IdentifiableType

Return the type that represents the type of the id.

Specified by:

getIdType in interface IdentifiableType<X>

Returns:

type of id

getIdClassAttributesSafely

public Set<SingularAttribute<? super X,?>> getIdClassAttributesSafely()

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

Returns:

IdClass attributes or null

getIdClassAttributes

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

Description copied from interface: IdentifiableType

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

Specified by:

getIdClassAttributes in interface IdentifiableType<X>

Returns:

id attributes

hasVersionAttribute

public boolean hasVersionAttribute()

Description copied from interface: IdentifiableType

Whether the identifiable type has a version attribute.

Specified by:

hasVersionAttribute in interface IdentifiableType<X>

Returns:

boolean indicating whether the identifiable type has a version attribute

hasDeclaredVersionAttribute

public boolean hasDeclaredVersionAttribute()

getVersion

public <Y> SingularAttribute<? super X,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 IdentifiableType<X>

Parameters:

javaType - the type of the represented version attribute

Returns:

version attribute

internalGetVersion

protected SingularAttributeImpl internalGetVersion()

getDeclaredVersion

public <Y> SingularAttribute<X,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 IdentifiableType<X>

Parameters:

javaType - the type of the represented declared version attribute

Returns:

declared version attribute

getDeclaredVersion

public SingularAttribute<X,?> getDeclaredVersion()

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

Returns:

The declared

getBuilder

public AbstractIdentifiableType.Builder<X> getBuilder()

Overrides:

getBuilder in class AbstractManagedType<X>