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, javax.persistence.metamodel.IdentifiableType<X>, javax.persistence.metamodel.ManagedType<X>, javax.persistence.metamodel.Type<X>

Direct Known Subclasses:

EntityTypeImpl, MappedSuperclassTypeImpl

public abstract class AbstractIdentifiableType<X>
extends AbstractManagedType<X>
implements javax.persistence.metamodel.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

javax.persistence.metamodel.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> javax.persistence.metamodel.SingularAttribute<X,Y>	getDeclaredId(Class<Y> javaType)
javax.persistence.metamodel.SingularAttribute<X,?>	getDeclaredVersion() For used to retrieve the declared version when populating the static metamodel.
<Y> javax.persistence.metamodel.SingularAttribute<X,Y>	getDeclaredVersion(Class<Y> javaType)
<Y> javax.persistence.metamodel.SingularAttribute<? super X,Y>	getId(Class<Y> javaType)
Set<javax.persistence.metamodel.SingularAttribute<? super X,?>>	getIdClassAttributes()
Set<javax.persistence.metamodel.SingularAttribute<? super X,?>>	getIdClassAttributesSafely() A form of getIdClassAttributes() which prefers to return null rather than throw exceptions
javax.persistence.metamodel.Type<?>	getIdType()
AbstractIdentifiableType<? super X>	getSupertype()
<Y> javax.persistence.metamodel.SingularAttribute<? super X,Y>	getVersion(Class<Y> javaType)
boolean	hasDeclaredVersionAttribute()
boolean	hasIdClass()
boolean	hasSingleIdAttribute()
boolean	hasVersionAttribute()
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()

Specified by:

hasSingleIdAttribute in interface javax.persistence.metamodel.IdentifiableType<X>

getSupertype

public AbstractIdentifiableType<? super X> getSupertype()

Specified by:

getSupertype in interface javax.persistence.metamodel.IdentifiableType<X>

Overrides:

getSupertype in class AbstractManagedType<X>

getId

public <Y> javax.persistence.metamodel.SingularAttribute<? super X,Y> getId(Class<Y> javaType)

Specified by:

getId in interface javax.persistence.metamodel.IdentifiableType<X>

internalGetId

protected SingularAttributeImpl internalGetId()

getDeclaredId

public <Y> javax.persistence.metamodel.SingularAttribute<X,Y> getDeclaredId(Class<Y> javaType)

Specified by:

getDeclaredId in interface javax.persistence.metamodel.IdentifiableType<X>

getIdType

public javax.persistence.metamodel.Type<?> getIdType()

Specified by:

getIdType in interface javax.persistence.metamodel.IdentifiableType<X>

getIdClassAttributesSafely

public Set<javax.persistence.metamodel.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<javax.persistence.metamodel.SingularAttribute<? super X,?>> getIdClassAttributes()

Specified by:

getIdClassAttributes in interface javax.persistence.metamodel.IdentifiableType<X>

hasVersionAttribute

public boolean hasVersionAttribute()

Specified by:

hasVersionAttribute in interface javax.persistence.metamodel.IdentifiableType<X>

hasDeclaredVersionAttribute

public boolean hasDeclaredVersionAttribute()

getVersion

public <Y> javax.persistence.metamodel.SingularAttribute<? super X,Y> getVersion(Class<Y> javaType)

Specified by:

getVersion in interface javax.persistence.metamodel.IdentifiableType<X>

internalGetVersion

protected SingularAttributeImpl internalGetVersion()

getDeclaredVersion

public <Y> javax.persistence.metamodel.SingularAttribute<X,Y> getDeclaredVersion(Class<Y> javaType)

Specified by:

getDeclaredVersion in interface javax.persistence.metamodel.IdentifiableType<X>

getDeclaredVersion

public javax.persistence.metamodel.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>