org.hibernate.metamodel.model.domain.internal.AbstractIdentifiableType Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of hibernate-core Show documentation
Show all versions of hibernate-core Show documentation
Hibernate's core ORM functionality
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
*/
package org.hibernate.metamodel.model.domain.internal;
import java.io.Serializable;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;
import java.util.function.Consumer;
import javax.persistence.metamodel.IdentifiableType;
import javax.persistence.metamodel.SingularAttribute;
import org.hibernate.engine.spi.SessionFactoryImplementor;
import org.hibernate.metamodel.model.domain.spi.PersistentAttributeDescriptor;
import org.hibernate.metamodel.model.domain.spi.IdentifiableTypeDescriptor;
import org.hibernate.metamodel.model.domain.spi.ManagedTypeDescriptor;
import org.hibernate.metamodel.model.domain.spi.SimpleTypeDescriptor;
import org.hibernate.metamodel.model.domain.spi.SingularPersistentAttribute;
/**
* Defines commonality for the JPA {@link 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
*/
public abstract class AbstractIdentifiableType
extends AbstractManagedType
implements IdentifiableTypeDescriptor, Serializable {
private final boolean hasIdentifierProperty;
private final boolean hasIdClass;
private SingularPersistentAttribute id;
private Set> idClassAttributes;
private final boolean isVersioned;
private SingularPersistentAttribute versionAttribute;
public AbstractIdentifiableType(
Class javaType,
String typeName,
IdentifiableTypeDescriptor superType,
boolean hasIdClass,
boolean hasIdentifierProperty,
boolean versioned,
SessionFactoryImplementor sessionFactory) {
super( javaType, typeName, superType, sessionFactory );
this.hasIdClass = hasIdClass;
this.hasIdentifierProperty = hasIdentifierProperty;
this.isVersioned = versioned;
}
@Override
@SuppressWarnings("unchecked")
protected IdentifiableTypeDescriptor.InFlightAccess createInFlightAccess() {
return new InFlightAccessImpl( super.createInFlightAccess() );
}
@Override
public IdentifiableTypeDescriptor.InFlightAccess getInFlightAccess() {
return (IdentifiableTypeDescriptor.InFlightAccess) super.getInFlightAccess();
}
public boolean hasIdClass() {
return hasIdClass;
}
@Override
public boolean hasSingleIdAttribute() {
return !hasIdClass() && hasIdentifierProperty;
}
@Override
@SuppressWarnings("unchecked")
public IdentifiableTypeDescriptor getSuperType() {
// overridden simply to perform the cast
return (IdentifiableTypeDescriptor) super.getSuperType();
}
@Override
@SuppressWarnings({ "unchecked" })
public SingularPersistentAttribute getId(Class javaType) {
ensureNoIdClass();
SingularPersistentAttribute id = locateIdAttribute();
if ( id != null ) {
checkType( id, javaType );
}
return (SingularPersistentAttribute) id;
}
private void ensureNoIdClass() {
if ( hasIdClass() ) {
throw new IllegalArgumentException(
"Illegal call to IdentifiableType#getId for class [" + getTypeName() + "] defined with @IdClass"
);
}
}
@Override
@SuppressWarnings("unchecked")
public SingularPersistentAttribute locateIdAttribute() {
if ( id != null ) {
return id;
}
else {
if ( getSuperType() != null ) {
SingularPersistentAttribute id = getSuperType().locateIdAttribute();
if ( id != null ) {
return id;
}
}
}
return null;
}
@SuppressWarnings("unchecked")
private void checkType(SingularPersistentAttribute attribute, Class javaType) {
if ( ! javaType.isAssignableFrom( attribute.getType().getJavaType() ) ) {
throw new IllegalArgumentException(
String.format(
"Attribute [%s#%s : %s] not castable to requested type [%s]",
getTypeName(),
attribute.getName(),
attribute.getType().getJavaType().getName(),
javaType.getName()
)
);
}
}
@Override
@SuppressWarnings({ "unchecked" })
public SingularPersistentAttribute getDeclaredId(Class javaType) {
ensureNoIdClass();
if ( id == null ) {
throw new IllegalArgumentException( "The id attribute is not declared on this type [" + getTypeName() + "]" );
}
checkType( id, javaType );
return (SingularPersistentAttribute) id;
}
@Override
@SuppressWarnings("unchecked")
public SimpleTypeDescriptor getIdType() {
final SingularPersistentAttribute id = locateIdAttribute();
if ( id != null ) {
return id.getType();
}
Set> idClassAttributes = getIdClassAttributesSafely();
if ( idClassAttributes != null ) {
if ( idClassAttributes.size() == 1 ) {
return idClassAttributes.iterator().next().getType();
}
}
return null;
}
/**
* A form of {@link #getIdClassAttributes} which prefers to return {@code null} rather than throw exceptions
*
* @return IdClass attributes or {@code null}
*/
@SuppressWarnings("unchecked")
public Set> getIdClassAttributesSafely() {
if ( !hasIdClass() ) {
return null;
}
final Set> attributes = new HashSet<>();
collectIdClassAttributes( attributes );
if ( attributes.isEmpty() ) {
return null;
}
return (Set) attributes;
}
@Override
@SuppressWarnings("unchecked")
public Set> getIdClassAttributes() {
if ( !hasIdClass() ) {
throw new IllegalArgumentException( "This class [" + getJavaType() + "] does not define an IdClass" );
}
final Set> attributes = new HashSet<>();
collectIdClassAttributes( attributes );
if ( attributes.isEmpty() ) {
throw new IllegalArgumentException( "Unable to locate IdClass attributes [" + getJavaType() + "]" );
}
return (Set) attributes;
}
@Override
@SuppressWarnings("unchecked")
public void collectIdClassAttributes(Set> attributes) {
if ( idClassAttributes != null ) {
//Make it writeable, if it was using the EMPTY_SET marker.
// This is because there's a semantic difference in this class between a null and an empty Set.
if ( idClassAttributes == Collections.EMPTY_SET ) {
idClassAttributes = new HashSet<>();
}
attributes.addAll( idClassAttributes );
}
else if ( getSuperType() != null ) {
getSuperType().collectIdClassAttributes( (Set) attributes );
}
}
@Override
@SuppressWarnings("unchecked")
public void visitIdClassAttributes(Consumer> attributeConsumer) {
if ( idClassAttributes != null ) {
idClassAttributes.forEach( attributeConsumer );
}
else if ( getSuperType() != null ) {
getSuperType().visitIdClassAttributes( (Consumer) attributeConsumer );
}
}
@Override
public boolean hasVersionAttribute() {
return isVersioned;
}
public boolean hasDeclaredVersionAttribute() {
return isVersioned && versionAttribute != null;
}
@Override
@SuppressWarnings({ "unchecked" })
public SingularPersistentAttribute getVersion(Class javaType) {
if ( ! hasVersionAttribute() ) {
return null;
}
SingularPersistentAttribute version = locateVersionAttribute();
if ( version != null ) {
checkType( version, javaType );
}
return (SingularPersistentAttribute) version;
}
@Override
@SuppressWarnings({ "unchecked" })
public SingularPersistentAttribute locateVersionAttribute() {
if ( versionAttribute != null ) {
return versionAttribute;
}
if ( getSuperType() != null ) {
return getSuperType().locateVersionAttribute();
}
return null;
}
@Override
@SuppressWarnings({ "unchecked" })
public SingularPersistentAttribute getDeclaredVersion(Class javaType) {
checkDeclaredVersion();
checkType( versionAttribute, javaType );
return (SingularPersistentAttribute) versionAttribute;
}
private void checkDeclaredVersion() {
if ( versionAttribute == null || ( getSuperType() != null && getSuperType().hasVersionAttribute() )) {
throw new IllegalArgumentException(
"The version attribute is not declared by this type [" + getJavaType() + "]"
);
}
}
/**
* For used to retrieve the declared version when populating the static metamodel.
*
* @return The declared
*/
public SingularAttribute getDeclaredVersion() {
checkDeclaredVersion();
return versionAttribute;
}
private class InFlightAccessImpl implements IdentifiableTypeDescriptor.InFlightAccess {
private final AbstractManagedType.InFlightAccess managedTypeAccess;
private InFlightAccessImpl(ManagedTypeDescriptor.InFlightAccess managedTypeAccess) {
this.managedTypeAccess = managedTypeAccess;
}
@Override
@SuppressWarnings("unchecked")
public void applyIdAttribute(SingularPersistentAttribute idAttribute) {
AbstractIdentifiableType.this.id = idAttribute;
managedTypeAccess.addAttribute( idAttribute );
}
@Override
public void applyIdClassAttributes(Set> idClassAttributes) {
if ( idClassAttributes.isEmpty() ) {
AbstractIdentifiableType.this.idClassAttributes = Collections.EMPTY_SET;
}
else {
for ( SingularAttribute idClassAttribute : idClassAttributes ) {
if ( AbstractIdentifiableType.this == idClassAttribute.getDeclaringType() ) {
@SuppressWarnings({ "unchecked" })
SingularPersistentAttribute declaredAttribute = (SingularPersistentAttribute) idClassAttribute;
addAttribute( declaredAttribute );
}
}
AbstractIdentifiableType.this.idClassAttributes = idClassAttributes;
}
}
@Override
@SuppressWarnings("unchecked")
public void applyVersionAttribute(SingularPersistentAttribute versionAttribute) {
AbstractIdentifiableType.this.versionAttribute = versionAttribute;
managedTypeAccess.addAttribute( versionAttribute );
}
@Override
@SuppressWarnings("unchecked")
public void addAttribute(PersistentAttributeDescriptor attribute) {
managedTypeAccess.addAttribute( attribute );
}
@Override
public void finishUp() {
managedTypeAccess.finishUp();
}
}
}