HHH-19364 make a Specification convertible to a CriteriaQuery

Author: gavinking

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

@@ -5,6 +5,8 @@
 package org.hibernate.query.programmatic;
 
 import jakarta.persistence.EntityManager;
+import jakarta.persistence.criteria.CriteriaBuilder;
+import jakarta.persistence.criteria.CommonAbstractCriteria;
 
 import org.hibernate.Incubating;
 import org.hibernate.Session;
@@ -53,6 +55,18 @@ public interface QuerySpecification<T> {
 	 */
 	CommonQueryContract createQuery(EntityManager entityManager);
 
+	/**
+	 * Build a {@link CommonAbstractCriteria criteria query}
+	 * satisfying this specification, using the given
+	 * {@link CriteriaBuilder}.
+	 * <p>
+	 * If the returned criteria query is mutated, the mutations
+	 * will not be not reflected in this specification.
+	 *
+	 * @return a new criteria query
+	 */
+	CommonAbstractCriteria buildCriteriaQuery(CriteriaBuilder builder);
+
 	/**
 	 * Validate the query.
 	 */

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

@@ -8,6 +8,7 @@
 import jakarta.persistence.criteria.CriteriaQuery;
 import jakarta.persistence.criteria.CriteriaBuilder;
 import jakarta.persistence.criteria.Root;
+
 import org.hibernate.Incubating;
 import org.hibernate.Session;
 import org.hibernate.StatelessSession;
@@ -166,6 +167,18 @@ interface Augmentation<T> {
 	@Override
 	SelectionQuery<T> createQuery(EntityManager entityManager);
 
+	/**
+	 * Build a {@link CriteriaQuery criteria query}
+	 * satisfying this specification, using the given
+	 * {@link CriteriaBuilder}.
+	 * <p>
+	 * If the returned criteria query is mutated, the mutations
+	 * will not be not reflected in this specification.
+	 *
+	 * @return a new criteria query
+	 */
+	CriteriaQuery<T> buildCriteriaQuery(CriteriaBuilder builder);
+
 	/**
 	 * Returns a specification reference which can be used to programmatically,
 	 * iteratively build a {@linkplain SelectionQuery} for the given entity type,

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

@@ -5,8 +5,11 @@
 package org.hibernate.query.programmatic.internal;
 
 import jakarta.persistence.EntityManager;
+import jakarta.persistence.criteria.CriteriaBuilder;
 import jakarta.persistence.criteria.CriteriaDelete;
 import jakarta.persistence.criteria.CriteriaUpdate;
+import jakarta.persistence.criteria.CommonAbstractCriteria;
+
 import org.hibernate.AssertionFailure;
 import org.hibernate.Session;
 import org.hibernate.SharedSessionContract;
@@ -18,6 +21,7 @@
 import org.hibernate.query.restriction.Restriction;
 import org.hibernate.query.spi.HqlInterpretation;
 import org.hibernate.query.spi.QueryEngine;
+import org.hibernate.query.sqm.NodeBuilder;
 import org.hibernate.query.sqm.SqmQuerySource;
 import org.hibernate.query.sqm.internal.QuerySqmImpl;
 import org.hibernate.query.sqm.internal.SqmUtil;
@@ -95,10 +99,15 @@ public MutationQuery createQuery(StatelessSession session) {
 
 	public MutationQuery createQuery(SharedSessionContract session) {
 		final var sessionImpl = (SharedSessionContractImplementor) session;
+		final SqmDeleteOrUpdateStatement<T> sqmStatement = build( sessionImpl.getFactory().getQueryEngine() );
+		return new QuerySqmImpl<>( sqmStatement, true, null, sessionImpl );
+	}
+
+	private SqmDeleteOrUpdateStatement<T> build(QueryEngine queryEngine) {
 		final SqmDeleteOrUpdateStatement<T> sqmStatement;
 		final SqmRoot<T> mutationTargetRoot;
 		if ( hql != null ) {
-			sqmStatement = resolveSqmTree( hql, sessionImpl.getFactory().getQueryEngine() );
+			sqmStatement = resolveSqmTree( hql, queryEngine );
 			mutationTargetRoot = resolveSqmRoot( sqmStatement, mutationTarget );
 		}
 		else if ( deleteOrUpdateStatement != null ) {
@@ -110,14 +119,20 @@ else if ( deleteOrUpdateStatement != null ) {
 			throw new AssertionFailure( "No HQL or criteria" );
 		}
 		specifications.forEach( consumer -> consumer.accept( sqmStatement, mutationTargetRoot ) );
-		return new QuerySqmImpl<>( sqmStatement, true, null, sessionImpl );
+		return sqmStatement;
 	}
 
 	@Override
 	public MutationQuery createQuery(EntityManager entityManager) {
 		return createQuery( (SharedSessionContract) entityManager );
 	}
 
+	@Override
+	public CommonAbstractCriteria buildCriteriaQuery(CriteriaBuilder builder) {
+		final NodeBuilder nodeBuilder = (NodeBuilder) builder;
+		return build( nodeBuilder.getQueryEngine() );
+	}
+
 	/**
 	 * Used during construction to parse/interpret the incoming HQL
 	 * and produce the corresponding SQM tree.

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

@@ -6,6 +6,8 @@
 
 import jakarta.persistence.EntityManager;
 import jakarta.persistence.criteria.CriteriaQuery;
+import jakarta.persistence.criteria.CriteriaBuilder;
+
 import org.hibernate.QueryException;
 import org.hibernate.Session;
 import org.hibernate.SharedSessionContract;
@@ -19,6 +21,7 @@
 import org.hibernate.query.restriction.Restriction;
 import org.hibernate.query.spi.HqlInterpretation;
 import org.hibernate.query.spi.QueryEngine;
+import org.hibernate.query.sqm.NodeBuilder;
 import org.hibernate.query.sqm.SqmQuerySource;
 import org.hibernate.query.sqm.internal.SqmSelectionQueryImpl;
 import org.hibernate.query.sqm.internal.SqmUtil;
@@ -135,33 +138,44 @@ public SelectionQuery<T> createQuery(StatelessSession session) {
 
 	public SelectionQuery<T> createQuery(SharedSessionContract session) {
 		final var sessionImpl = (SharedSessionContractImplementor) session;
+		final SqmSelectStatement<T> sqmStatement = build( sessionImpl.getFactory().getQueryEngine() );
+		return new SqmSelectionQueryImpl<>( sqmStatement, true, resultType, sessionImpl );
+	}
+
+	private SqmSelectStatement<T> build(QueryEngine queryEngine) {
 		final SqmSelectStatement<T> sqmStatement;
 		final SqmRoot<T> sqmRoot;
 		if ( hql != null ) {
-			sqmStatement = resolveSqmTree( hql, resultType, sessionImpl.getFactory().getQueryEngine() );
+			sqmStatement = resolveSqmTree( hql, resultType, queryEngine );
 			sqmRoot = extractRoot( sqmStatement, resultType, hql );
 		}
 		else if ( criteriaQuery != null ) {
 			sqmStatement = (SqmSelectStatement<T>) criteriaQuery;
 			sqmRoot = extractRoot( sqmStatement, resultType, "criteria query" );
 		}
 		else {
-			var builder = sessionImpl.getCriteriaBuilder();
+			var builder = queryEngine.getCriteriaBuilder();
 			var query = builder.createQuery( resultType );
 			var root = query.from( resultType );
 			query.select( root );
 			sqmRoot = (SqmRoot<T>) root;
 			sqmStatement = (SqmSelectStatement<T>) query;
 		}
 		specifications.forEach( consumer -> consumer.accept( sqmStatement, sqmRoot ) );
-		return new SqmSelectionQueryImpl<>( sqmStatement, true, resultType, sessionImpl );
+		return sqmStatement;
 	}
 
 	@Override
 	public SelectionQuery<T> createQuery(EntityManager entityManager) {
 		return createQuery( (SharedSessionContract) entityManager );
 	}
 
+	@Override
+	public CriteriaQuery<T> buildCriteriaQuery(CriteriaBuilder builder) {
+		final NodeBuilder nodeBuilder = (NodeBuilder) builder;
+		return build( nodeBuilder.getQueryEngine() );
+	}
+
 	/**
 	 * Used during construction to parse/interpret the incoming HQL
 	 * and produce the corresponding SQM tree.