HHH-8415 - Throw exception types expected by JPA spec wrt StoredProcedureQuery

Author: sebersole

hibernate-core/src/main/java/org/hibernate/procedure/NoSuchParameterException.java

@@ -0,0 +1,35 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * Copyright (c) 2013, Red Hat Inc. 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 Inc.
+ *
+ * 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.procedure;
+
+import org.hibernate.HibernateException;
+
+/**
+ * @author Steve Ebersole
+ */
+public class NoSuchParameterException extends HibernateException {
+	public NoSuchParameterException(String message) {
+		super( message );
+	}
+}

hibernate-core/src/main/java/org/hibernate/procedure/ParameterStrategyException.java

@@ -0,0 +1,35 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * Copyright (c) 2013, Red Hat Inc. 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 Inc.
+ *
+ * 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.procedure;
+
+import org.hibernate.HibernateException;
+
+/**
+ * @author Steve Ebersole
+ */
+public class ParameterStrategyException extends HibernateException {
+	public ParameterStrategyException(String message) {
+		super( message );
+	}
+}

hibernate-core/src/main/java/org/hibernate/procedure/ProcedureCall.java

@@ -82,6 +82,9 @@ public interface ProcedureCall extends BasicQueryContract, SynchronizeableQuery
 	 * @param position The parameter position
 	 *
 	 * @return The parameter registration memento
+	 *
+	 * @throws ParameterStrategyException If the ProcedureCall is defined using named parameters
+	 * @throws NoSuchParameterException If no parameter with that position exists
 	 */
 	public ParameterRegistration getParameterRegistration(int position);
 
@@ -122,6 +125,9 @@ public ProcedureCall registerParameter0(String parameterName, Class type, Parame
 	 * @param name The parameter name
 	 *
 	 * @return The parameter registration memento
+	 *
+	 * @throws ParameterStrategyException If the ProcedureCall is defined using positional parameters
+	 * @throws NoSuchParameterException If no parameter with that name exists
 	 */
 	public ParameterRegistration getParameterRegistration(String name);
 

hibernate-core/src/main/java/org/hibernate/procedure/ProcedureOutputs.java

@@ -53,6 +53,9 @@ public interface ProcedureOutputs extends Outputs {
 	 *
 	 * @return The output value.
 	 *
+	 * @throws ParameterStrategyException If the ProcedureCall is defined using positional parameters
+	 * @throws NoSuchParameterException If no parameter with that name exists
+	 *
 	 * @see ProcedureCall#registerParameter(String, Class, javax.persistence.ParameterMode)
 	 */
 	public Object getOutputParameterValue(String name);
@@ -64,6 +67,9 @@ public interface ProcedureOutputs extends Outputs {
 	 *
 	 * @return The output value.
 	 *
+	 * @throws ParameterStrategyException If the ProcedureCall is defined using named parameters
+	 * @throws NoSuchParameterException If no parameter with that position exists
+	 *
 	 * @see ProcedureCall#registerParameter(int, Class, javax.persistence.ParameterMode)
 	 */
 	public Object getOutputParameterValue(int position);

hibernate-core/src/main/java/org/hibernate/procedure/internal/ProcedureCallImpl.java

@@ -50,7 +50,9 @@
 import org.hibernate.internal.util.collections.CollectionHelper;
 import org.hibernate.persister.entity.EntityPersister;
 import org.hibernate.procedure.NamedParametersNotSupportedException;
+import org.hibernate.procedure.NoSuchParameterException;
 import org.hibernate.procedure.ParameterRegistration;
+import org.hibernate.procedure.ParameterStrategyException;
 import org.hibernate.procedure.ProcedureCall;
 import org.hibernate.procedure.ProcedureCallMemento;
 import org.hibernate.procedure.ProcedureOutputs;
@@ -321,21 +323,22 @@ private void prepareForNamedParameters() {
 	@Override
 	public ParameterRegistrationImplementor getParameterRegistration(int position) {
 		if ( parameterStrategy != ParameterStrategy.POSITIONAL ) {
-			throw new IllegalArgumentException( "Positions were not used to register parameters with this stored procedure call" );
-		}
-		try {
-			return registeredParameters.get( position );
+			throw new ParameterStrategyException(
+					"Attempt to access positional parameter [" + position + "] but ProcedureCall using named parameters"
+			);
 		}
-		catch ( Exception e ) {
-			throw new QueryException( "Could not locate parameter registered using that position [" + position + "]" );
+		for ( ParameterRegistrationImplementor parameter : registeredParameters ) {
+			if ( position == parameter.getPosition() ) {
+				return parameter;
+			}
 		}
+		throw new NoSuchParameterException( "Could not locate parameter registered using that position [" + position + "]" );
 	}
 
 	@Override
 	@SuppressWarnings("unchecked")
 	public <T> ParameterRegistration<T> registerParameter(String name, Class<T> type, ParameterMode mode) {
-		final NamedParameterRegistration parameterRegistration
-				= new NamedParameterRegistration( this, name, mode, type );
+		final NamedParameterRegistration parameterRegistration = new NamedParameterRegistration( this, name, mode, type );
 		registerParameter( parameterRegistration );
 		return parameterRegistration;
 	}
@@ -350,14 +353,14 @@ public ProcedureCall registerParameter0(String name, Class type, ParameterMode m
 	@Override
 	public ParameterRegistrationImplementor getParameterRegistration(String name) {
 		if ( parameterStrategy != ParameterStrategy.NAMED ) {
-			throw new IllegalArgumentException( "Names were not used to register parameters with this stored procedure call" );
+			throw new ParameterStrategyException( "Names were not used to register parameters with this stored procedure call" );
 		}
 		for ( ParameterRegistrationImplementor parameter : registeredParameters ) {
 			if ( name.equals( parameter.getName() ) ) {
 				return parameter;
 			}
 		}
-		throw new IllegalArgumentException( "Could not locate parameter registered under that name [" + name + "]" );
+		throw new NoSuchParameterException( "Could not locate parameter registered under that name [" + name + "]" );
 	}
 
 	@Override

hibernate-core/src/main/java/org/hibernate/procedure/internal/ProcedureOutputsImpl.java

@@ -68,7 +68,7 @@ public Object getOutputParameterValue(int position) {
 	}
 
 	@Override
-	protected CurrentReturnState buildCurrentReturnDescriptor(boolean isResultSet, int updateCount) {
+	protected CurrentReturnState buildCurrentReturnState(boolean isResultSet, int updateCount) {
 		return new ProcedureCurrentReturnState( isResultSet, updateCount, refCursorParamIndex );
 	}
 
@@ -81,8 +81,8 @@ private ProcedureCurrentReturnState(boolean isResultSet, int updateCount, int re
 		}
 
 		@Override
-		public boolean indicatesMoreReturns() {
-			return super.indicatesMoreReturns()
+		public boolean indicatesMoreOutputs() {
+			return super.indicatesMoreOutputs()
 					|| ProcedureOutputsImpl.this.refCursorParamIndex < ProcedureOutputsImpl.this.refCursorParameters.length;
 		}
 
@@ -106,7 +106,7 @@ protected Output buildExtendedReturn() {
 						.getService( RefCursorSupport.class )
 						.getResultSet( ProcedureOutputsImpl.this.callableStatement, refCursorParam.getPosition() );
 			}
-			return new ResultSetOutputImpl( extractResults( resultSet ) );
+			return buildResultSetOutput( extractResults( resultSet ) );
 		}
 	}
 

hibernate-core/src/main/java/org/hibernate/result/Outputs.java

@@ -38,23 +38,18 @@ public interface Outputs {
 	 *
 	 * @return The current Output object.  Can be {@code null}
 	 */
-	public Output getCurrentOutput();
+	public Output getCurrent();
 
 	/**
-	 * Are there any more Output objects associated with {@code this}?
+	 * Go to the next Output object (if any), returning an indication of whether there was another (aka, will
+	 * the next call to {@link #getCurrent()} return {@code null}?
 	 *
-	 * @return {@code true} means there are more Output objects available via {@link #getNextOutput()}; {@code false}
-	 * indicates that calling {@link #getNextOutput()} will certainly result in an exception.
+	 * @return {@code true} if the next call to {@link #getCurrent()} will return a non-{@code null} value.
 	 */
-	public boolean hasMoreOutput();
+	public boolean goToNext();
 
 	/**
-	 * Retrieve the next return
-	 *
-	 * @return The next return.
-	 *
-	 * @throws NoMoreReturnsException Thrown if there are no more returns associated with this Result, as would
-	 * have been indicated by a {@code false} return from {@link #hasMoreOutput()}.
+	 * Eagerly release any resources held by this Outputs.
 	 */
-	public Output getNextOutput() throws NoMoreReturnsException;
+	public void release();
 }