org.hibernate.id.ForeignGenerator 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 .
*/
package org.hibernate.id;
import java.io.Serializable;
import java.util.Properties;
import org.hibernate.MappingException;
import org.hibernate.Session;
import org.hibernate.TransientObjectException;
import org.hibernate.engine.internal.ForeignKeys;
import org.hibernate.engine.spi.SharedSessionContractImplementor;
import org.hibernate.internal.CoreMessageLogger;
import org.hibernate.loader.PropertyPath;
import org.hibernate.persister.entity.EntityPersister;
import org.hibernate.service.ServiceRegistry;
import org.hibernate.type.EntityType;
import org.hibernate.type.Type;
import static org.hibernate.internal.CoreLogging.logger;
import static org.hibernate.internal.CoreLogging.messageLogger;
/**
* foreign
*
* An Identifier generator that uses the value of the id property of an
* associated object
*
* One mapping parameter is required: property.
*
* @author Gavin King
*/
public class ForeignGenerator implements IdentifierGenerator, Configurable {
private static final CoreMessageLogger LOG = messageLogger( ForeignGenerator.class );
private String entityName;
private String propertyName;
/**
* Getter for property 'entityName'.
*
* @return Value for property 'entityName'.
*/
public String getEntityName() {
return entityName;
}
/**
* Getter for property 'propertyName'.
*
* @return Value for property 'propertyName'.
*/
public String getPropertyName() {
return propertyName;
}
/**
* Getter for property 'role'. Role is the {@link #getPropertyName property name} qualified by the
* {@link #getEntityName entity name}.
*
* @return Value for property 'role'.
*/
public String getRole() {
return getEntityName() + '.' + getPropertyName();
}
@Override
public void configure(Type type, Properties params, ServiceRegistry serviceRegistry) throws MappingException {
propertyName = params.getProperty( "property" );
entityName = params.getProperty( ENTITY_NAME );
if ( propertyName==null ) {
throw new MappingException( "param named \"property\" is required for foreign id generation strategy" );
}
}
@Override
public Serializable generate(SharedSessionContractImplementor sessionImplementor, Object object) {
// needs to be a Session for the #save and #contains calls below...
final Session session = ( Session ) sessionImplementor;
final EntityPersister persister = sessionImplementor.getFactory().getMetamodel().entityPersister( entityName );
Object associatedObject = persister.getPropertyValue( object, propertyName );
if ( associatedObject == null ) {
throw new IdentifierGenerationException(
"attempted to assign id from null one-to-one property [" + getRole() + "]"
);
}
final EntityType foreignValueSourceType;
final Type propertyType = persister.getPropertyType( propertyName );
if ( propertyType.isEntityType() ) {
// the normal case
foreignValueSourceType = (EntityType) propertyType;
}
else {
// try identifier mapper
foreignValueSourceType = (EntityType) persister.getPropertyType( PropertyPath.IDENTIFIER_MAPPER_PROPERTY + "." + propertyName );
}
Serializable id;
try {
id = ForeignKeys.getEntityIdentifierIfNotUnsaved(
foreignValueSourceType.getAssociatedEntityName(),
associatedObject,
sessionImplementor
);
}
catch (TransientObjectException toe) {
if ( LOG.isDebugEnabled() ) {
LOG.debugf(
"ForeignGenerator detected a transient entity [%s]",
foreignValueSourceType.getAssociatedEntityName()
);
}
id = session.save( foreignValueSourceType.getAssociatedEntityName(), associatedObject );
}
if ( session.contains( entityName, object ) ) {
//abort the save (the object is already saved by a circular cascade)
return IdentifierGeneratorHelper.SHORT_CIRCUIT_INDICATOR;
//throw new IdentifierGenerationException("save associated object first, or disable cascade for inverse association");
}
return id;
}
}