HHH-19364 make Specification subtypes produce TypedQueryReferences

Author: gavinking

hibernate-core/src/main/java/org/hibernate/internal/AbstractSharedSessionContract.java

@@ -73,8 +73,8 @@
 import org.hibernate.query.hql.spi.SqmQueryImplementor;
 import org.hibernate.query.named.NamedObjectRepository;
 import org.hibernate.query.named.NamedResultSetMappingMemento;
-import org.hibernate.query.programmatic.MutationSpecification;
-import org.hibernate.query.programmatic.SelectionSpecification;
+import org.hibernate.query.specification.internal.MutationSpecificationImpl;
+import org.hibernate.query.specification.internal.SelectionSpecificationImpl;
 import org.hibernate.query.spi.HqlInterpretation;
 import org.hibernate.query.spi.QueryImplementor;
 import org.hibernate.query.sql.internal.NativeQueryImpl;
@@ -905,11 +905,11 @@ public <T> QueryImplementor<T> createQuery(String queryString, Class<T> expected
 	@Override
 	public <R> QueryImplementor<R> createQuery(TypedQueryReference<R> typedQueryReference) {
 		checksBeforeQueryCreation();
-		if ( typedQueryReference instanceof SelectionSpecification<R> specification ) {
+		if ( typedQueryReference instanceof SelectionSpecificationImpl<R> specification ) {
 			final CriteriaQuery<R> query = specification.buildCriteria( getCriteriaBuilder() );
 			return new QuerySqmImpl<>( (SqmStatement<R>) query, specification.getResultType(), this );
 		}
-		else if ( typedQueryReference instanceof MutationSpecification<?> specification ) {
+		else if ( typedQueryReference instanceof MutationSpecificationImpl<?> specification ) {
 			final CommonAbstractCriteria query = specification.buildCriteria( getCriteriaBuilder() );
 			return new QuerySqmImpl<>( (SqmStatement<R>) query, (Class<R>) specification.getResultType(), this );
 		}

hibernate-core/src/main/java/org/hibernate/query/specification/MutationSpecification.java

@@ -39,7 +39,7 @@
  * @since 7.0
  */
 @Incubating
-public interface MutationSpecification<T> extends QuerySpecification<T>, TypedQueryReference<Void> {
+public interface MutationSpecification<T> extends QuerySpecification<T> {
 
 	/**
 	 * Covariant override.
@@ -82,7 +82,7 @@ interface Augmentation<T> {
 	MutationSpecification<T> validate(CriteriaBuilder builder);
 
 	@Override
-	Class<Void> getResultType();
+	TypedQueryReference<Void> reference();
 
 	/**
 	 * Returns a specification reference which can be used to programmatically,

hibernate-core/src/main/java/org/hibernate/query/specification/QuerySpecification.java

@@ -5,6 +5,7 @@
 package org.hibernate.query.specification;
 
 import jakarta.persistence.EntityManager;
+import jakarta.persistence.TypedQueryReference;
 import jakarta.persistence.criteria.CriteriaBuilder;
 import jakarta.persistence.criteria.CommonAbstractCriteria;
 
@@ -87,4 +88,11 @@ public interface QuerySpecification<T> {
 	 * @throws Exception if it ain't all good
 	 */
 	QuerySpecification<T> validate(CriteriaBuilder builder);
+
+	/**
+	 * Obtain a {@linkplain TypedQueryReference reference}
+	 * to this specification which may be passed along to
+	 * {@link EntityManager#createQuery(TypedQueryReference)}.
+	 */
+	TypedQueryReference<?> reference();
 }

hibernate-core/src/main/java/org/hibernate/query/specification/SelectionSpecification.java

@@ -4,8 +4,8 @@
  */
 package org.hibernate.query.specification;
 
-import jakarta.persistence.EntityManager;
 import jakarta.persistence.TypedQueryReference;
+import jakarta.persistence.EntityManager;
 import jakarta.persistence.criteria.CriteriaQuery;
 import jakarta.persistence.criteria.CriteriaBuilder;
 import jakarta.persistence.criteria.Root;
@@ -60,7 +60,7 @@
  * @since 7.0
  */
 @Incubating
-public interface SelectionSpecification<T> extends QuerySpecification<T>, TypedQueryReference<T> {
+public interface SelectionSpecification<T> extends QuerySpecification<T> {
 	/**
 	 * Adds an ordering to the selection specification.
 	 * Appended to any previous ordering.
@@ -187,7 +187,7 @@ interface Augmentation<T> {
 	SelectionSpecification<T> validate(CriteriaBuilder builder);
 
 	@Override
-	Class<T> getResultType();
+	TypedQueryReference<T> reference();
 
 	/**
 	 * Returns a specification reference which can be used to programmatically,

hibernate-core/src/main/java/org/hibernate/query/specification/internal/MutationSpecificationImpl.java

@@ -5,6 +5,7 @@
 package org.hibernate.query.specification.internal;
 
 import jakarta.persistence.EntityManager;
+import jakarta.persistence.TypedQueryReference;
 import jakarta.persistence.criteria.CriteriaBuilder;
 import jakarta.persistence.criteria.CriteriaDelete;
 import jakarta.persistence.criteria.CriteriaUpdate;
@@ -46,7 +47,7 @@
  *
  * @author Steve Ebersole
  */
-public class MutationSpecificationImpl<T> implements MutationSpecification<T> {
+public class MutationSpecificationImpl<T> implements MutationSpecification<T>, TypedQueryReference<Void> {
 
 	private final List<BiConsumer<SqmDeleteOrUpdateStatement<T>, SqmRoot<T>>> specifications = new ArrayList<>();
 	private final String hql;
@@ -86,6 +87,11 @@ public Map<String,Object> getHints() {
 		return Collections.emptyMap();
 	}
 
+	@Override
+	public TypedQueryReference<Void> reference() {
+		return this;
+	}
+
 	@Override
 	public MutationSpecification<T> restrict(Restriction<? super T> restriction) {
 		specifications.add( (sqmStatement, mutationTargetRoot) -> {

hibernate-core/src/main/java/org/hibernate/query/specification/internal/SelectionSpecificationImpl.java

@@ -5,6 +5,7 @@
 package org.hibernate.query.specification.internal;
 
 import jakarta.persistence.EntityManager;
+import jakarta.persistence.TypedQueryReference;
 import jakarta.persistence.criteria.CriteriaQuery;
 import jakarta.persistence.criteria.CriteriaBuilder;
 
@@ -51,7 +52,7 @@
  *
  * @author Steve Ebersole
  */
-public class SelectionSpecificationImpl<T> implements SelectionSpecification<T> {
+public class SelectionSpecificationImpl<T> implements SelectionSpecification<T>, TypedQueryReference<T> {
 	private final Class<T> resultType;
 	private final String hql;
 	private final CriteriaQuery<T> criteriaQuery;
@@ -90,6 +91,11 @@ public Map<String,Object> getHints() {
 		return Collections.emptyMap();
 	}
 
+	@Override
+	public TypedQueryReference<T> reference() {
+		return this;
+	}
+
 	@Override
 	public SelectionSpecification<T> restrict(Restriction<? super T> restriction) {
 		specifications.add( (sqmStatement, root) -> {

hibernate-core/src/test/java/org/hibernate/orm/test/query/dynamic/SimpleQuerySpecificationTests.java

@@ -306,7 +306,7 @@ void testUseAsTypedQueryRef(SessionFactoryScope factoryScope) {
 			var spec = SelectionSpecification.create( BasicEntity.class )
 					.restrict( Restriction.restrict( BasicEntity_.position, Range.closed( 1, 5 ) ) )
 					.sort( Order.asc( BasicEntity_.position ) );
-			session.createQuery(spec).getResultList();
+			session.createQuery(spec.reference()).getResultList();
 		} );
 
 		assertThat( sqlCollector.getSqlQueries() ).hasSize( 1 );