sort out typing issues with NamedCriteriaQueryMemento

gavinking · gavinking · commit 5f4ab632fbe2 · 2025-04-08T10:51:44.000+02:00
check the result type
diff --git a/hibernate-core/src/main/java/org/hibernate/query/criteria/internal/NamedCriteriaQueryMementoImpl.java b/hibernate-core/src/main/java/org/hibernate/query/criteria/internal/NamedCriteriaQueryMementoImpl.java
@@ -5,12 +5,15 @@
 package org.hibernate.query.criteria.internal;
 
 import java.io.Serializable;
+import java.util.Locale;
 import java.util.Map;
 
 import org.hibernate.CacheMode;
 import org.hibernate.FlushMode;
 import org.hibernate.LockOptions;
 import org.hibernate.engine.spi.SharedSessionContractImplementor;
+import org.hibernate.query.IllegalSelectQueryException;
+import org.hibernate.query.QueryTypeMismatchException;
 import org.hibernate.query.hql.spi.SqmQueryImplementor;
 import org.hibernate.query.named.AbstractNamedQueryMemento;
 import org.hibernate.query.spi.QueryEngine;
@@ -21,6 +24,7 @@
 import org.hibernate.query.sqm.tree.SqmStatement;
 
 import org.checkerframework.checker.nullness.qual.Nullable;
+import org.hibernate.query.sqm.tree.select.SqmSelectStatement;
 
 public class NamedCriteriaQueryMementoImpl<E> extends AbstractNamedQueryMemento<E>
 		implements NamedSqmQueryMemento<E>, Serializable {
@@ -60,12 +64,33 @@ public NamedCriteriaQueryMementoImpl(
 
 	@Override
 	public void validate(QueryEngine queryEngine) {
+		// nothing to do
+	}
 
+	private static <T> void checkResultType(Class<T> resultType, SqmSelectStatement<?> selectStatement) {
+		final Class<?> expectedResultType = selectStatement.getResultType();
+		if ( expectedResultType != null ) {
+			if ( !resultType.isAssignableFrom( expectedResultType ) ) {
+				throw new QueryTypeMismatchException(
+						String.format(
+								Locale.ROOT,
+								"Incorrect query result type: query produces '%s' but type '%s' was given",
+								expectedResultType.getName(),
+								resultType.getName()
+						)
+				);
+			}
+		}
 	}
 
 	@Override
 	public <T> SqmQueryImplementor<T> toQuery(SharedSessionContractImplementor session, Class<T> resultType) {
-		return new QuerySqmImpl<>( this, resultType, session );
+		if ( sqmStatement instanceof SqmSelectStatement<?> selectStatement ) {
+			checkResultType( resultType, selectStatement );
+		}
+		@SuppressWarnings("unchecked") // we just checked the result type
+		final SqmStatement<T> statement = (SqmStatement<T>) sqmStatement;
+		return new QuerySqmImpl<>( this, statement, resultType, session );
 	}
 
 	@Override
@@ -75,7 +100,13 @@ public SqmQueryImplementor<E> toQuery(SharedSessionContractImplementor session)
 
 	@Override
 	public <T> SqmSelectionQuery<T> toSelectionQuery(Class<T> resultType, SharedSessionContractImplementor session) {
-		return new SqmSelectionQueryImpl<>( this, resultType, session );
+		if ( !( sqmStatement instanceof SqmSelectStatement<?> selectStatement ) ) {
+			throw new IllegalSelectQueryException( "Named query is not a SELECT statement: " + getName() );
+		}
+		checkResultType( resultType, selectStatement );
+		@SuppressWarnings("unchecked") // we just checked the result type
+		final SqmSelectStatement<T> statement = (SqmSelectStatement<T>) selectStatement;
+		return new SqmSelectionQueryImpl<>( this, statement, resultType, session );
 	}
 
 	@Override
@@ -110,7 +141,7 @@ public Map<String, String> getParameterTypes() {
 
 	@Override
 	public NamedSqmQueryMemento<E> makeCopy(String name) {
-		return new NamedCriteriaQueryMementoImpl<E>(
+		return new NamedCriteriaQueryMementoImpl<>(
 				name,
 				getResultType(),
 				sqmStatement,
diff --git a/hibernate-core/src/main/java/org/hibernate/query/sqm/internal/AbstractSqmSelectionQuery.java b/hibernate-core/src/main/java/org/hibernate/query/sqm/internal/AbstractSqmSelectionQuery.java
@@ -16,7 +16,6 @@
 import org.hibernate.query.restriction.Restriction;
 import org.hibernate.query.SelectionQuery;
 import org.hibernate.query.criteria.JpaSelection;
-import org.hibernate.query.hql.internal.NamedHqlQueryMementoImpl;
 import org.hibernate.query.hql.internal.QuerySplitter;
 import org.hibernate.query.spi.AbstractSelectionQuery;
 import org.hibernate.query.spi.HqlInterpretation;
@@ -169,7 +168,7 @@ public KeyedResultList<R> getKeyedResultList(KeyedPage<R> keyedPage) {
 		final List<KeyedResult<R>> results =
 				new SqmSelectionQueryImpl<KeyedResult<R>>( this, keyedPage )
 						.getResultList();
-		int pageSize = keyedPage.getPage().getSize();
+		final int pageSize = keyedPage.getPage().getSize();
 		return new KeyedResultList<>(
 				collectResults( results, pageSize, keyedPage.getKeyInterpretation() ),
 				collectKeys( results, pageSize ),
@@ -388,7 +387,7 @@ else if ( queryPart instanceof SqmQueryGroup<?> queryGroup ) {
 	}
 
 	protected static <T> HqlInterpretation<T> interpretation(
-			NamedHqlQueryMementoImpl<?> memento,
+			NamedSqmQueryMemento<?> memento,
 			Class<T> expectedResultType,
 			SharedSessionContractImplementor session) {
 		final QueryEngine queryEngine = session.getFactory().getQueryEngine();
diff --git a/hibernate-core/src/main/java/org/hibernate/query/sqm/internal/QuerySqmImpl.java b/hibernate-core/src/main/java/org/hibernate/query/sqm/internal/QuerySqmImpl.java
@@ -132,27 +132,31 @@ public class QuerySqmImpl<R>
 	private final TupleMetadata tupleMetadata;
 
 	/**
-	 * Creates a Query instance from a named HQL memento
+	 * Creates a {@link org.hibernate.query.Query}
+	 * instance from a named HQL memento.
+	 * Form used from {@link NamedHqlQueryMementoImpl}.
 	 */
 	public QuerySqmImpl(
-			NamedHqlQueryMementoImpl<?> memento,
+			NamedSqmQueryMemento<?> memento,
 			Class<R> expectedResultType,
 			SharedSessionContractImplementor session) {
-		this(
-				memento.getHqlString(),
+		this( memento.getHqlString(),
 				interpretation( memento, expectedResultType, session ),
-				expectedResultType,
-				session
-		);
+				expectedResultType, session );
 		applySqmOptions( memento );
 	}
 
+	/**
+	 * Creates a {@link org.hibernate.query.Query}
+	 * instance from a named criteria query memento.
+	 * Form used from {@link NamedCriteriaQueryMementoImpl}
+	 */
 	public QuerySqmImpl(
-			NamedCriteriaQueryMementoImpl<?> memento,
+			NamedSqmQueryMemento<?> memento,
+			SqmStatement<R> statement,
 			Class<R> resultType,
 			SharedSessionContractImplementor session) {
-		this( (SqmStatement<R>) memento.getSqmStatement(), resultType, session );
-
+		this( statement, resultType, session );
 		applySqmOptions( memento );
 	}
 
@@ -177,10 +181,8 @@ public QuerySqmImpl(
 		if ( sqm instanceof SqmSelectStatement<?> ) {
 			hqlInterpretation.validateResultType( resultType );
 		}
-		else {
-			if ( resultType != null ) {
-				throw new IllegalQueryOperationException( "Result type given for a non-SELECT Query", hql, null );
-			}
+		else if ( resultType != null ) {
+			throw new IllegalQueryOperationException( "Result type given for a non-SELECT Query", hql, null );
 		}
 		setComment( hql );
 
diff --git a/hibernate-core/src/main/java/org/hibernate/query/sqm/internal/SqmSelectionQueryImpl.java b/hibernate-core/src/main/java/org/hibernate/query/sqm/internal/SqmSelectionQueryImpl.java
@@ -99,6 +99,9 @@ public class SqmSelectionQueryImpl<R> extends AbstractSqmSelectionQuery<R>
 	private final Class<?> resultType;
 	private final TupleMetadata tupleMetadata;
 
+	/**
+	 * Form used for HQL queries
+	 */
 	public SqmSelectionQueryImpl(
 			String hql,
 			HqlInterpretation<R> hqlInterpretation,
@@ -114,7 +117,6 @@ public SqmSelectionQueryImpl(
 		this.domainParameterXref = hqlInterpretation.getDomainParameterXref();
 		this.parameterBindings = parameterMetadata.createBindings( session.getFactory() );
 
-
 		this.expectedResultType = expectedResultType;
 		this.resultType = determineResultType( sqm, expectedResultType );
 		this.tupleMetadata = buildTupleMetadata( sqm, expectedResultType );
@@ -123,29 +125,38 @@ public SqmSelectionQueryImpl(
 		setComment( hql );
 	}
 
+	/**
+	 * Creates a {@link org.hibernate.query.SelectionQuery}
+	 * instance from a named HQL memento.
+	 * Form used from {@link NamedHqlQueryMementoImpl}.
+	 */
 	public SqmSelectionQueryImpl(
 			NamedHqlQueryMementoImpl<?> memento,
 			Class<R> resultType,
 			SharedSessionContractImplementor session) {
-		this(
-				memento.getHqlString(),
+		this( memento.getHqlString(),
 				interpretation( memento, resultType, session ),
-				resultType,
-				session
-		);
-
+				resultType, session );
 		applySqmOptions( memento );
 	}
 
+	/**
+	 * Creates a {@link org.hibernate.query.SelectionQuery}
+	 * instance from a named criteria query memento.
+	 * Form used from {@link NamedCriteriaQueryMementoImpl}
+	 */
 	public SqmSelectionQueryImpl(
 			NamedCriteriaQueryMementoImpl<?> memento,
+			SqmSelectStatement<R> selectStatement,
 			Class<R> expectedResultType,
 			SharedSessionContractImplementor session) {
-		//noinspection unchecked
-		this( (SqmSelectStatement<R>) memento.getSqmStatement(), expectedResultType, session );
+		this( selectStatement, expectedResultType, session );
 		applySqmOptions( memento );
 	}
 
+	/**
+	 * Form used for criteria queries
+	 */
 	public SqmSelectionQueryImpl(
 			SqmSelectStatement<R> criteria,
 			Class<R> expectedResultType,
diff --git a/hibernate-core/src/main/java/org/hibernate/query/sqm/tree/select/SqmSelectStatement.java b/hibernate-core/src/main/java/org/hibernate/query/sqm/tree/select/SqmSelectStatement.java
@@ -124,10 +124,7 @@ private SqmSelectStatement(
 	@Override
 	public SqmSelectStatement<T> copy(SqmCopyContext context) {
 		final SqmSelectStatement<T> existing = context.getCopy( this );
-		if ( existing != null ) {
-			return existing;
-		}
-		return createCopy( context, getResultType() );
+		return existing != null ? existing : createCopy( context, getResultType() );
 	}
 
 	@Internal
