HHH-18979 allow Range parameters in query methods

gavinking · gavinking · commit 5f50c992f981 · 2024-12-26T10:52:07.000+01:00
diff --git a/tooling/metamodel-generator/src/main/java/org/hibernate/processor/annotation/AbstractQueryMethod.java b/tooling/metamodel-generator/src/main/java/org/hibernate/processor/annotation/AbstractQueryMethod.java
@@ -19,6 +19,7 @@
 import static org.hibernate.processor.util.Constants.HIB_ORDER;
 import static org.hibernate.processor.util.Constants.HIB_PAGE;
 import static org.hibernate.processor.util.Constants.HIB_QUERY;
+import static org.hibernate.processor.util.Constants.HIB_RANGE;
 import static org.hibernate.processor.util.Constants.HIB_RESTRICTION;
 import static org.hibernate.processor.util.Constants.HIB_SELECTION_QUERY;
 import static org.hibernate.processor.util.Constants.HIB_SORT_DIRECTION;
@@ -288,8 +289,7 @@ void handlePageParameters(
 	}
 
 	void handleRestrictionParameters(
-			StringBuilder declaration, List<String> paramTypes,
-			@Nullable String containerType) {
+			StringBuilder declaration, List<String> paramTypes) {
 		for ( int i = 0; i < paramNames.size(); i ++ ) {
 			final String paramName = paramNames.get(i);
 			final String paramType = paramTypes.get(i);
@@ -299,6 +299,18 @@ void handleRestrictionParameters(
 						.append(paramName)
 						.append(")\n");
 			}
+			else if ( isRangeParam(paramType) ) {
+				declaration
+						.append("\t\t\t.addRestriction(")
+						.append(annotationMetaEntity.importType(HIB_RESTRICTION))
+						.append(".restrict(")
+						.append(annotationMetaEntity.importType(returnTypeName + '_'))
+						.append('.')
+						.append(paramName)
+						.append(", ")
+						.append(paramName)
+						.append("))\n");
+			}
 		}
 	}
 
@@ -346,6 +358,7 @@ void unwrapQuery(StringBuilder declaration, boolean unwrapped) {
 	static boolean isSpecialParam(String parameterType) {
 		return isPageParam(parameterType)
 			|| isRestrictionParam(parameterType)
+			|| isRangeParam(parameterType)
 			|| isOrderParam(parameterType)
 			|| isKeyedPageParam(parameterType)
 			|| isSessionParameter(parameterType);
@@ -372,6 +385,10 @@ static boolean isRestrictionParam(String parameterType) {
 		return parameterType.startsWith(HIB_RESTRICTION);
 	}
 
+	static boolean isRangeParam(String parameterType) {
+		return parameterType.startsWith(HIB_RANGE);
+	}
+
 	static boolean isJakartaCursoredPage(@Nullable String containerType) {
 		return JD_CURSORED_PAGE.equals(containerType);
 	}
diff --git a/tooling/metamodel-generator/src/main/java/org/hibernate/processor/annotation/AnnotationMetaEntity.java b/tooling/metamodel-generator/src/main/java/org/hibernate/processor/annotation/AnnotationMetaEntity.java
@@ -75,6 +75,7 @@
 import static org.hibernate.grammars.hql.HqlLexer.WHERE;
 import static org.hibernate.internal.util.StringHelper.qualify;
 import static org.hibernate.internal.util.StringHelper.unqualify;
+import static org.hibernate.processor.annotation.AbstractQueryMethod.isRangeParam;
 import static org.hibernate.processor.annotation.AbstractQueryMethod.isRestrictionParam;
 import static org.hibernate.processor.annotation.AbstractQueryMethod.isSessionParameter;
 import static org.hibernate.processor.annotation.AbstractQueryMethod.isSpecialParam;
@@ -1819,7 +1820,9 @@ private OrderBy orderByExpression(AnnotationMirror orderBy, TypeElement entityTy
 	}
 
 	private static boolean isFinderParameterMappingToAttribute(VariableElement param) {
-		return !isSpecialParam(typeName(param.asType()));
+		final String typeName = typeName( param.asType() );
+		return !isSpecialParam(typeName)
+			|| isRangeParam(typeName);
 	}
 
 	private String[] sessionTypeFromParameters(List<String> paramNames, List<String> paramTypes) {
@@ -2134,14 +2137,18 @@ private boolean checkParameterType(TypeElement entityType, VariableElement param
 						parameterType = typeVariable.getUpperBound();
 						// INTENTIONAL FALL-THROUGH
 					case DECLARED:
-						if ( types.isSameType( parameterType, attributeType) ) {
+						if ( types.isSameType(parameterType, attributeType) ) {
 							return false;
 						}
 						else {
 							final TypeElement list = context.getTypeElementForFullyQualifiedName(LIST);
-							if ( types.isSameType( parameterType, types.getDeclaredType( list, attributeType) ) ) {
+							final TypeElement range = context.getTypeElementForFullyQualifiedName(HIB_RANGE);
+							if ( types.isSameType( parameterType, types.getDeclaredType(list, attributeType) ) ) {
 								return true;
 							}
+							else if ( types.isSameType( parameterType, types.getDeclaredType(range, attributeType) ) ) {
+								return false;
+							}
 							else {
 								parameterTypeError( entityType, param, attributeType );
 								return false;
@@ -2174,11 +2181,21 @@ private boolean checkParameterType(TypeElement entityType, VariableElement param
 
 	private void parameterTypeError(TypeElement entityType, VariableElement param, TypeMirror attributeType) {
 		message(param,
-				"matching field has type '" + attributeType
+				"matching field has type '" + stripAnnotations(typeAsString(attributeType))
 						+ "' in entity class '" + entityType + "'",
 				Diagnostic.Kind.ERROR );
 	}
 
+	private String stripAnnotations(String type) {
+		if ( type.startsWith("@") ) {
+			final int index = type.lastIndexOf(' ');
+			return index > 0 ? type.substring( index + 1 ) : type;
+		}
+		else {
+			return type;
+		}
+	}
+
 	private boolean finderParameterNullable(TypeElement entity, VariableElement param) {
 		final Element member = memberMatchingPath( entity, parameterName( param ) );
 		return isNullable( param )
diff --git a/tooling/metamodel-generator/src/main/java/org/hibernate/processor/annotation/CriteriaFinderMethod.java b/tooling/metamodel-generator/src/main/java/org/hibernate/processor/annotation/CriteriaFinderMethod.java
@@ -58,7 +58,7 @@ void executeQuery(StringBuilder declaration, List<String> paramTypes) {
 		tryReturn( declaration, paramTypes, containerType );
 		castResult( declaration );
 		createQuery( declaration );
-		handleRestrictionParameters( declaration, paramTypes, containerType );
+		handleRestrictionParameters( declaration, paramTypes );
 		handlePageParameters( declaration, paramTypes, containerType );
 		boolean unwrapped = !isUsingEntityManager();
 		unwrapped = enableFetchProfile( declaration, unwrapped );
diff --git a/tooling/metamodel-generator/src/main/java/org/hibernate/processor/annotation/QueryMethod.java b/tooling/metamodel-generator/src/main/java/org/hibernate/processor/annotation/QueryMethod.java
@@ -97,7 +97,7 @@ public String getAttributeDeclarationString() {
 		tryReturn( declaration, paramTypes, containerType );
 		castResult( declaration );
 		createQuery( declaration );
-		handleRestrictionParameters( declaration, paramTypes, containerType );
+		handleRestrictionParameters( declaration, paramTypes );
 		setParameters( declaration, paramTypes, "");
 		handlePageParameters( declaration, paramTypes, containerType );
 		boolean unwrapped = !isUsingEntityManager();
diff --git a/tooling/metamodel-generator/src/main/java/org/hibernate/processor/util/Constants.java b/tooling/metamodel-generator/src/main/java/org/hibernate/processor/util/Constants.java
@@ -92,6 +92,7 @@ public final class Constants {
 	public static final String HIB_KEYED_RESULT_LIST = "org.hibernate.query.KeyedResultList";
 	public static final String HIB_SORT_DIRECTION = "org.hibernate.query.SortDirection";
 	public static final String HIB_RESTRICTION = "org.hibernate.query.Restriction";
+	public static final String HIB_RANGE = "org.hibernate.query.range.Range";
 
 	public static final String CHECK_HQL = "org.hibernate.annotations.processing.CheckHQL";
 
