[hibernate-commits] Hibernate SVN: r15366 - in core/trunk/core/src/main/java/org/hibernate: event/def and 4 other directories.

Author: steve.ebersole(a)jboss.com Date: 2008-10-21 15:10:17 -0400 (Tue, 21 Oct 2008) New Revision: 15366 Added: core/trunk/core/src/main/java/org/hibernate/id/IdentifierGeneratorHelper.java Modified: core/trunk/core/src/main/java/org/hibernate/engine/VersionValue.java core/trunk/core/src/main/java/org/hibernate/event/def/AbstractSaveEventListener.java core/trunk/core/src/main/java/org/hibernate/id/AbstractPostInsertGenerator.java core/trunk/core/src/main/java/org/hibernate/id/ForeignGenerator.java core/trunk/core/src/main/java/org/hibernate/id/IdentityGenerator.java core/trunk/core/src/main/java/org/hibernate/id/IncrementGenerator.java core/trunk/core/src/main/java/org/hibernate/id/MultipleHiLoPerTableGenerator.java core/trunk/core/src/main/java/org/hibernate/id/SequenceGenerator.java core/trunk/core/src/main/java/org/hibernate/id/SequenceHiLoGenerator.java core/trunk/core/src/main/java/org/hibernate/id/SequenceIdentityGenerator.java core/trunk/core/src/main/java/org/hibernate/id/TableHiLoGenerator.java core/trunk/core/src/main/java/org/hibernate/id/enhanced/OptimizerFactory.java core/trunk/core/src/main/java/org/hibernate/id/factory/IdentifierGeneratorFactory.java core/trunk/core/src/main/java/org/hibernate/impl/StatelessSessionImpl.java Log: HHH-3512 : id generator short-naming Modified: core/trunk/core/src/main/java/org/hibernate/engine/VersionValue.java =================================================================== --- core/trunk/core/src/main/java/org/hibernate/engine/VersionValue.java 2008-10-21 18:46:51 UTC (rev 15365) +++ core/trunk/core/src/main/java/org/hibernate/engine/VersionValue.java 2008-10-21 19:10:17 UTC (rev 15366) @@ -27,7 +27,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.hibernate.MappingException; -import org.hibernate.id.IdentifierGeneratorFactory; +import org.hibernate.id.IdentifierGeneratorHelper; /** * A strategy for determining if a version value is an version of @@ -91,7 +91,7 @@ } } public Object getDefaultValue(Object currentValue) { - return IdentifierGeneratorFactory.createNumber( -1l, currentValue.getClass() ); + return IdentifierGeneratorHelper.createNumber( -1l, currentValue.getClass() ); } public String toString() { return "VERSION_NEGATIVE"; Modified: core/trunk/core/src/main/java/org/hibernate/event/def/AbstractSaveEventListener.java =================================================================== --- core/trunk/core/src/main/java/org/hibernate/event/def/AbstractSaveEventListener.java 2008-10-21 18:46:51 UTC (rev 15365) +++ core/trunk/core/src/main/java/org/hibernate/event/def/AbstractSaveEventListener.java 2008-10-21 19:10:17 UTC (rev 15366) @@ -47,7 +47,7 @@ import org.hibernate.engine.Versioning; import org.hibernate.event.EventSource; import org.hibernate.id.IdentifierGenerationException; -import org.hibernate.id.IdentifierGeneratorFactory; +import org.hibernate.id.IdentifierGeneratorHelper; import org.hibernate.intercept.FieldInterceptionHelper; import org.hibernate.intercept.FieldInterceptor; import org.hibernate.persister.entity.EntityPersister; @@ -123,10 +123,10 @@ if ( generatedId == null ) { throw new IdentifierGenerationException( "null id generated for:" + entity.getClass() ); } - else if ( generatedId == IdentifierGeneratorFactory.SHORT_CIRCUIT_INDICATOR ) { + else if ( generatedId == IdentifierGeneratorHelper.SHORT_CIRCUIT_INDICATOR ) { return source.getIdentifier( entity ); } - else if ( generatedId == IdentifierGeneratorFactory.POST_INSERT_INDICATOR ) { + else if ( generatedId == IdentifierGeneratorHelper.POST_INSERT_INDICATOR ) { return performSave( entity, null, persister, true, anything, source, requiresImmediateIdAccess ); } else { Modified: core/trunk/core/src/main/java/org/hibernate/id/AbstractPostInsertGenerator.java =================================================================== --- core/trunk/core/src/main/java/org/hibernate/id/AbstractPostInsertGenerator.java 2008-10-21 18:46:51 UTC (rev 15365) +++ core/trunk/core/src/main/java/org/hibernate/id/AbstractPostInsertGenerator.java 2008-10-21 19:10:17 UTC (rev 15366) @@ -39,6 +39,6 @@ * {@inheritDoc} */ public Serializable generate(SessionImplementor s, Object obj) { - return IdentifierGeneratorFactory.POST_INSERT_INDICATOR; + return IdentifierGeneratorHelper.POST_INSERT_INDICATOR; } } Modified: core/trunk/core/src/main/java/org/hibernate/id/ForeignGenerator.java =================================================================== --- core/trunk/core/src/main/java/org/hibernate/id/ForeignGenerator.java 2008-10-21 18:46:51 UTC (rev 15365) +++ core/trunk/core/src/main/java/org/hibernate/id/ForeignGenerator.java 2008-10-21 19:10:17 UTC (rev 15366) @@ -27,7 +27,6 @@ import java.io.Serializable; import java.util.Properties; -import org.hibernate.HibernateException; import org.hibernate.MappingException; import org.hibernate.Session; import org.hibernate.TransientObjectException; @@ -48,27 +47,61 @@ * @author Gavin King */ public class ForeignGenerator implements IdentifierGenerator, Configurable { - + private String entityName; private String propertyName; - private String entityName; /** - * @see org.hibernate.id.IdentifierGenerator#generate(org.hibernate.engine.SessionImplementor, java.lang.Object) + * Getter for property 'entityName'. + * + * @return Value for property 'entityName'. */ - public Serializable generate(SessionImplementor sessionImplementor, Object object) - throws HibernateException { - - Session session = (Session) sessionImplementor; + 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(); + } + + /** + * {@inheritDoc} + */ + public void configure(Type type, Properties params, Dialect d) { + 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" ); + } + } + + /** + * {@inheritDoc} + */ + public Serializable generate(SessionImplementor sessionImplementor, Object object) { + Session session = ( Session ) sessionImplementor; + Object associatedObject = sessionImplementor.getFactory() - .getClassMetadata( entityName ) + .getClassMetadata( entityName ) .getPropertyValue( object, propertyName, session.getEntityMode() ); - if ( associatedObject == null ) { throw new IdentifierGenerationException( - "attempted to assign id from null one-to-one property: " + - propertyName - ); + "attempted to assign id from null one-to-one property [" + getRole() + "]" + ); } EntityType type = (EntityType) sessionImplementor.getFactory() @@ -81,7 +114,7 @@ type.getAssociatedEntityName(), associatedObject, sessionImplementor - ); + ); } catch (TransientObjectException toe) { id = session.save( type.getAssociatedEntityName(), associatedObject ); @@ -89,23 +122,9 @@ if ( session.contains(object) ) { //abort the save (the object is already saved by a circular cascade) - return IdentifierGeneratorFactory.SHORT_CIRCUIT_INDICATOR; + return IdentifierGeneratorHelper.SHORT_CIRCUIT_INDICATOR; //throw new IdentifierGenerationException("save associated object first, or disable cascade for inverse association"); } return id; } - - /** - * @see org.hibernate.id.Configurable#configure(org.hibernate.type.Type, java.util.Properties, org.hibernate.dialect.Dialect) - */ - public void configure(Type type, Properties params, Dialect d) - 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" - ); - } - } Copied: core/trunk/core/src/main/java/org/hibernate/id/IdentifierGeneratorHelper.java (from rev 15266, core/trunk/core/src/main/java/org/hibernate/id/IdentifierGeneratorFactory.java) =================================================================== --- core/trunk/core/src/main/java/org/hibernate/id/IdentifierGeneratorHelper.java (rev 0) +++ core/trunk/core/src/main/java/org/hibernate/id/IdentifierGeneratorHelper.java 2008-10-21 19:10:17 UTC (rev 15366) @@ -0,0 +1,145 @@ +/* + * Hibernate, Relational Persistence for Idiomatic Java + * + * Copyright (c) 2008, Red Hat Middleware LLC or third-party contributors as + * indicated by the @author tags or express copyright attribution + * statements applied by the authors. All third-party contributions are + * distributed under license by Red Hat Middleware LLC. + * + * This copyrighted material is made available to anyone wishing to use, modify, + * copy, or redistribute it subject to the terms and conditions of the GNU + * Lesser General Public License, as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY + * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License + * for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this distribution; if not, write to: + * Free Software Foundation, Inc. + * 51 Franklin Street, Fifth Floor + * Boston, MA 02110-1301 USA + * + */ +package org.hibernate.id; + +import java.io.Serializable; +import java.sql.ResultSet; +import java.sql.SQLException; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import org.hibernate.HibernateException; +import org.hibernate.type.Type; + +/** + * Factory and helper methods for <tt>IdentifierGenerator</tt> framework. + * + * @author Gavin King + */ +public final class IdentifierGeneratorHelper { + private static final Logger log = LoggerFactory.getLogger( IdentifierGeneratorHelper.class ); + + /** + * Marker object returned from {@link IdentifierGenerator#generate} to indicate that we should short-circuit any + * continued generated id checking. Currently this is only used in the case of the + * {@link org.hibernate.id.ForeignGenerator foreign} generator as a way to signal that we should use the associated + * entity's id value. + */ + public static final Serializable SHORT_CIRCUIT_INDICATOR = new Serializable() { + public String toString() { + return "SHORT_CIRCUIT_INDICATOR"; + } + }; + + /** + * Marker object returned from {@link IdentifierGenerator#generate} to indicate that the entity's identifier will + * be generated as part of the datbase insertion. + */ + public static final Serializable POST_INSERT_INDICATOR = new Serializable() { + public String toString() { + return "POST_INSERT_INDICATOR"; + } + }; + + + /** + * Get the generated identifier when using identity columns + * + * @param rs The result set from which to extract the the generated identity. + * @param type The expected type mapping for the identity value. + * @return The generated identity value + * @throws SQLException Can be thrown while accessing the result set + * @throws HibernateException Indicates a problem reading back a generated identity value. + */ + public static Serializable getGeneratedIdentity(ResultSet rs, Type type) throws SQLException, HibernateException { + if ( !rs.next() ) { + throw new HibernateException( "The database returned no natively generated identity value" ); + } + final Serializable id = IdentifierGeneratorHelper.get( rs, type ); + log.debug( "Natively generated identity: " + id ); + return id; + } + + /** + * Extract the value from the result set (which is assumed to already have been positioned to the apopriate row) + * and wrp it in the appropriate Java numeric type. + * + * @param rs The result set from which to extract the value. + * @param type The expected type of the value. + * @return The extracted value. + * @throws SQLException Indicates problems access the result set + * @throws IdentifierGenerationException Indicates an unknown type. + */ + public static Serializable get(ResultSet rs, Type type) throws SQLException, IdentifierGenerationException { + Class clazz = type.getReturnedClass(); + if ( clazz == Long.class ) { + return new Long( rs.getLong( 1 ) ); + } + else if ( clazz == Integer.class ) { + return new Integer( rs.getInt( 1 ) ); + } + else if ( clazz == Short.class ) { + return new Short( rs.getShort( 1 ) ); + } + else if ( clazz == String.class ) { + return rs.getString( 1 ); + } + else { + throw new IdentifierGenerationException( "this id generator generates long, integer, short or string" ); + } + + } + + /** + * Wrap the given value in the given Java numeric class. + * + * @param value The primitive value to wrap. + * @param clazz The Java numeric type in which to wrap the value. + * @return The wrapped type. + * @throws IdentifierGenerationException Indicates an unhandled 'clazz'. + */ + public static Number createNumber(long value, Class clazz) throws IdentifierGenerationException { + if ( clazz == Long.class ) { + return new Long( value ); + } + else if ( clazz == Integer.class ) { + return new Integer( ( int ) value ); + } + else if ( clazz == Short.class ) { + return new Short( ( short ) value ); + } + else { + throw new IdentifierGenerationException( "this id generator generates long, integer, short" ); + } + } + + /** + * Disallow instantiation of IdentifierGeneratorHelper. + */ + private IdentifierGeneratorHelper() { + } + +} Modified: core/trunk/core/src/main/java/org/hibernate/id/IdentityGenerator.java =================================================================== --- core/trunk/core/src/main/java/org/hibernate/id/IdentityGenerator.java 2008-10-21 18:46:51 UTC (rev 15365) +++ core/trunk/core/src/main/java/org/hibernate/id/IdentityGenerator.java 2008-10-21 19:10:17 UTC (rev 15366) @@ -95,7 +95,7 @@ ResultSet rs = null; try { rs = insert.getGeneratedKeys(); - return IdentifierGeneratorFactory.getGeneratedIdentity( + return IdentifierGeneratorHelper.getGeneratedIdentity( rs, persister.getIdentifierType() ); @@ -142,7 +142,7 @@ } ResultSet rs = insert.getResultSet(); try { - return IdentifierGeneratorFactory.getGeneratedIdentity( rs, persister.getIdentifierType() ); + return IdentifierGeneratorHelper.getGeneratedIdentity( rs, persister.getIdentifierType() ); } finally { rs.close(); @@ -184,7 +184,7 @@ SessionImplementor session, ResultSet rs, Object object) throws SQLException { - return IdentifierGeneratorFactory.getGeneratedIdentity( rs, persister.getIdentifierType() ); + return IdentifierGeneratorHelper.getGeneratedIdentity( rs, persister.getIdentifierType() ); } } Modified: core/trunk/core/src/main/java/org/hibernate/id/IncrementGenerator.java =================================================================== --- core/trunk/core/src/main/java/org/hibernate/id/IncrementGenerator.java 2008-10-21 18:46:51 UTC (rev 15365) +++ core/trunk/core/src/main/java/org/hibernate/id/IncrementGenerator.java 2008-10-21 19:10:17 UTC (rev 15366) @@ -67,7 +67,7 @@ if (sql!=null) { getNext( session ); } - return IdentifierGeneratorFactory.createNumber(next++, returnClass); + return IdentifierGeneratorHelper.createNumber(next++, returnClass); } public void configure(Type type, Properties params, Dialect dialect) Modified: core/trunk/core/src/main/java/org/hibernate/id/MultipleHiLoPerTableGenerator.java =================================================================== --- core/trunk/core/src/main/java/org/hibernate/id/MultipleHiLoPerTableGenerator.java 2008-10-21 18:46:51 UTC (rev 15365) +++ core/trunk/core/src/main/java/org/hibernate/id/MultipleHiLoPerTableGenerator.java 2008-10-21 19:10:17 UTC (rev 15366) @@ -209,7 +209,7 @@ //keep the behavior consistent even for boundary usages int val = ( (Integer) doWorkInNewTransaction(session) ).intValue(); if (val == 0) val = ( (Integer) doWorkInNewTransaction(session) ).intValue(); - return IdentifierGeneratorFactory.createNumber( val, returnClass ); + return IdentifierGeneratorHelper.createNumber( val, returnClass ); } if (lo>maxLo) { int hival = ( (Integer) doWorkInNewTransaction(session) ).intValue(); @@ -217,7 +217,7 @@ hi = hival * (maxLo+1); log.debug("new hi value: " + hival); } - return IdentifierGeneratorFactory.createNumber( hi + lo++, returnClass ); + return IdentifierGeneratorHelper.createNumber( hi + lo++, returnClass ); } public void configure(Type type, Properties params, Dialect dialect) throws MappingException { Modified: core/trunk/core/src/main/java/org/hibernate/id/SequenceGenerator.java =================================================================== --- core/trunk/core/src/main/java/org/hibernate/id/SequenceGenerator.java 2008-10-21 18:46:51 UTC (rev 15365) +++ core/trunk/core/src/main/java/org/hibernate/id/SequenceGenerator.java 2008-10-21 19:10:17 UTC (rev 15366) @@ -98,7 +98,7 @@ ResultSet rs = st.executeQuery(); try { rs.next(); - Serializable result = IdentifierGeneratorFactory.get( + Serializable result = IdentifierGeneratorHelper.get( rs, identifierType ); if ( log.isDebugEnabled() ) { Modified: core/trunk/core/src/main/java/org/hibernate/id/SequenceHiLoGenerator.java =================================================================== --- core/trunk/core/src/main/java/org/hibernate/id/SequenceHiLoGenerator.java 2008-10-21 18:46:51 UTC (rev 15365) +++ core/trunk/core/src/main/java/org/hibernate/id/SequenceHiLoGenerator.java 2008-10-21 19:10:17 UTC (rev 15366) @@ -75,7 +75,7 @@ //keep the behavior consistent even for boundary usages long val = ( (Number) super.generate(session, obj) ).longValue(); if (val == 0) val = ( (Number) super.generate(session, obj) ).longValue(); - return IdentifierGeneratorFactory.createNumber( val, returnClass ); + return IdentifierGeneratorHelper.createNumber( val, returnClass ); } if ( lo>maxLo ) { long hival = ( (Number) super.generate(session, obj) ).longValue(); @@ -85,7 +85,7 @@ log.debug("new hi value: " + hival); } - return IdentifierGeneratorFactory.createNumber( hi + lo++, returnClass ); + return IdentifierGeneratorHelper.createNumber( hi + lo++, returnClass ); } } Modified: core/trunk/core/src/main/java/org/hibernate/id/SequenceIdentityGenerator.java =================================================================== --- core/trunk/core/src/main/java/org/hibernate/id/SequenceIdentityGenerator.java 2008-10-21 18:46:51 UTC (rev 15365) +++ core/trunk/core/src/main/java/org/hibernate/id/SequenceIdentityGenerator.java 2008-10-21 19:10:17 UTC (rev 15366) @@ -60,7 +60,7 @@ private static final Logger log = LoggerFactory.getLogger( SequenceIdentityGenerator.class ); public Serializable generate(SessionImplementor s, Object obj) { - return IdentifierGeneratorFactory.POST_INSERT_INDICATOR; + return IdentifierGeneratorHelper.POST_INSERT_INDICATOR; } public InsertGeneratedIdentifierDelegate getInsertGeneratedIdentifierDelegate( @@ -101,7 +101,7 @@ protected Serializable executeAndExtract(PreparedStatement insert) throws SQLException { insert.executeUpdate(); - return IdentifierGeneratorFactory.getGeneratedIdentity( + return IdentifierGeneratorHelper.getGeneratedIdentity( insert.getGeneratedKeys(), getPersister().getIdentifierType() ); Modified: core/trunk/core/src/main/java/org/hibernate/id/TableHiLoGenerator.java =================================================================== --- core/trunk/core/src/main/java/org/hibernate/id/TableHiLoGenerator.java 2008-10-21 18:46:51 UTC (rev 15365) +++ core/trunk/core/src/main/java/org/hibernate/id/TableHiLoGenerator.java 2008-10-21 19:10:17 UTC (rev 15366) @@ -78,7 +78,7 @@ //keep the behavior consistent even for boundary usages long val = ( (Number) super.generate(session, obj) ).longValue(); if (val == 0) val = ( (Number) super.generate(session, obj) ).longValue(); - return IdentifierGeneratorFactory.createNumber( val, returnClass ); + return IdentifierGeneratorHelper.createNumber( val, returnClass ); } if (lo>maxLo) { long hival = ( (Number) super.generate(session, obj) ).longValue(); @@ -87,7 +87,7 @@ log.debug("new hi value: " + hival); } - return IdentifierGeneratorFactory.createNumber( hi + lo++, returnClass ); + return IdentifierGeneratorHelper.createNumber( hi + lo++, returnClass ); } Modified: core/trunk/core/src/main/java/org/hibernate/id/enhanced/OptimizerFactory.java =================================================================== --- core/trunk/core/src/main/java/org/hibernate/id/enhanced/OptimizerFactory.java 2008-10-21 18:46:51 UTC (rev 15365) +++ core/trunk/core/src/main/java/org/hibernate/id/enhanced/OptimizerFactory.java 2008-10-21 19:10:17 UTC (rev 15366) @@ -32,7 +32,7 @@ import org.hibernate.HibernateException; import org.hibernate.util.ReflectHelper; -import org.hibernate.id.IdentifierGeneratorFactory; +import org.hibernate.id.IdentifierGeneratorHelper; /** * Factory for {@link Optimizer} instances. @@ -105,7 +105,7 @@ * @return The wrapped value. */ protected final Serializable make(long value) { - return IdentifierGeneratorFactory.createNumber( value, returnClass ); + return IdentifierGeneratorHelper.createNumber( value, returnClass ); } /** Modified: core/trunk/core/src/main/java/org/hibernate/id/factory/IdentifierGeneratorFactory.java =================================================================== --- core/trunk/core/src/main/java/org/hibernate/id/factory/IdentifierGeneratorFactory.java 2008-10-21 18:46:51 UTC (rev 15365) +++ core/trunk/core/src/main/java/org/hibernate/id/factory/IdentifierGeneratorFactory.java 2008-10-21 19:10:17 UTC (rev 15366) @@ -39,28 +39,6 @@ public interface IdentifierGeneratorFactory { /** - * Marker object returned from {@link IdentifierGenerator#generate} to indicate that we should short-circuit any - * continued generated id checking. Currently this is only used in the case of the - * {@link org.hibernate.id.ForeignGenerator foreign} generator as a way to signal that we should use the associated - * entity's id value. - */ - public static final Serializable SHORT_CIRCUIT_INDICATOR = new Serializable() { - public String toString() { - return "SHORT_CIRCUIT_INDICATOR"; - } - }; - - /** - * Marker object returned from {@link IdentifierGenerator#generate} to indicate that the entity's identifier will - * be generated as part of the datbase insertion. - */ - public static final Serializable POST_INSERT_INDICATOR = new Serializable() { - public String toString() { - return "POST_INSERT_INDICATOR"; - } - }; - - /** * Allow injection of the dialect to use. * * @param dialect The dialect Modified: core/trunk/core/src/main/java/org/hibernate/impl/StatelessSessionImpl.java =================================================================== --- core/trunk/core/src/main/java/org/hibernate/impl/StatelessSessionImpl.java 2008-10-21 18:46:51 UTC (rev 15365) +++ core/trunk/core/src/main/java/org/hibernate/impl/StatelessSessionImpl.java 2008-10-21 19:10:17 UTC (rev 15366) @@ -62,7 +62,7 @@ import org.hibernate.engine.query.NativeSQLQueryPlan; import org.hibernate.engine.query.sql.NativeSQLQuerySpecification; import org.hibernate.event.EventListeners; -import org.hibernate.id.IdentifierGeneratorFactory; +import org.hibernate.id.IdentifierGeneratorHelper; import org.hibernate.jdbc.Batcher; import org.hibernate.jdbc.JDBCContext; import org.hibernate.loader.criteria.CriteriaLoader; @@ -110,7 +110,7 @@ persister.setPropertyValues( entity, state, EntityMode.POJO ); } } - if ( id == IdentifierGeneratorFactory.POST_INSERT_INDICATOR ) { + if ( id == IdentifierGeneratorHelper.POST_INSERT_INDICATOR ) { id = persister.insert(state, entity, this); } else {