HSEARCH-5300 Introduce "generic" Any*Reference mostly for simple cases/tests

Author: marko-bekhta

engine/src/main/java/org/hibernate/search/engine/search/reference/FieldReferences.java

@@ -0,0 +1,44 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.search.engine.search.reference;
+
+import org.hibernate.search.engine.search.common.ValueModel;
+import org.hibernate.search.engine.search.reference.aggregation.AnyAggregationReference;
+import org.hibernate.search.engine.search.reference.predicate.AnyPredicateReference;
+import org.hibernate.search.engine.search.reference.projection.AnyProjectionReference;
+import org.hibernate.search.engine.search.reference.sort.AnySortReference;
+import org.hibernate.search.util.common.annotation.Incubating;
+
+/**
+ * A set of util methods to create generic field references, mostly for testing purposes or trivial cases where just a few references are required.
+ * <p>
+ * While it is expected that the generated Hibernate Search static metamodel will contain
+ * more precise field references that would match the actual field capabilities, these generic references can
+ * be used by the users if they decide to opt-out of using the generated static metamodel
+ * and would just want to create a few simple pre-defined references.
+ */
+@Incubating
+public interface FieldReferences {
+
+	static <SR, T> AnySortReference<SR, T> anySortReference(String absolutePath, Class<SR> scopeRootType, ValueModel valueModel,
+			Class<T> sortType) {
+		return new AnySortReference<>( absolutePath, scopeRootType, valueModel, sortType );
+	}
+
+	static <SR, T> AnyProjectionReference<SR, T> anyProjectionReference(String absolutePath, Class<SR> scopeRootType,
+			ValueModel valueModel, Class<T> projectionType) {
+		return new AnyProjectionReference<>( absolutePath, scopeRootType, valueModel, projectionType );
+	}
+
+	static <SR, T> AnyPredicateReference<SR, T> anyPredicateReference(String absolutePath, Class<SR> scopeRootType,
+			ValueModel valueModel, Class<T> predicateType) {
+		return new AnyPredicateReference<>( absolutePath, scopeRootType, valueModel, predicateType );
+	}
+
+	static <SR, T> AnyAggregationReference<SR, T> anyAggregationReference(String absolutePath, Class<SR> scopeRootType,
+			ValueModel valueModel, Class<T> aggregationType) {
+		return new AnyAggregationReference<>( absolutePath, scopeRootType, valueModel, aggregationType );
+	}
+}

engine/src/main/java/org/hibernate/search/engine/search/reference/aggregation/AnyAggregationReference.java

@@ -0,0 +1,36 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.search.engine.search.reference.aggregation;
+
+import org.hibernate.search.engine.search.common.ValueModel;
+import org.hibernate.search.util.common.annotation.Incubating;
+
+/**
+ * A generic aggregated-field reference that can be manually created and passed to any aggregation-DSL methods that require a field reference.
+ * <p>
+ * While it is expected that the generated Hibernate Search static metamodel will contain
+ * more precise field references that would match the actual field capabilities, this generic reference can
+ * be used by the users if they decide to opt-out of using the generated static metamodel
+ * and would just want to create a few simple pre-defined references.
+ *
+ * @param absolutePath The absolut field path.
+ * @param scopeRootType The class representing the scope root type.
+ * @param valueModel The model of aggregated values. See {@link ValueModel}.
+ * @param aggregationType The class representing the type of the aggregated field, as per {@code valueModel}.
+ * @param <SR> Scope root type
+ * @param <T> The type of the aggregated field.
+ */
+@Incubating
+public record AnyAggregationReference<SR, T>(   String absolutePath, Class<SR> scopeRootType, ValueModel valueModel,
+												Class<T> aggregationType)
+		implements AvgAggregationFieldReference<SR, T>,
+		CountAggregationFieldReference<SR>,
+		CountDistinctAggregationFieldReference<SR>,
+		MaxAggregationFieldReference<SR, T>,
+		MinAggregationFieldReference<SR, T>,
+		RangeAggregationFieldReference<SR, T>,
+		SumAggregationFieldReference<SR, T>,
+		TermsAggregationFieldReference<SR, T> {
+}

engine/src/main/java/org/hibernate/search/engine/search/reference/predicate/AnyPredicateReference.java

@@ -0,0 +1,41 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.search.engine.search.reference.predicate;
+
+import org.hibernate.search.engine.search.common.ValueModel;
+import org.hibernate.search.util.common.annotation.Incubating;
+
+/**
+ * A generic predicate-field reference that can be manually created and passed to any predicate-DSL methods that require a field reference.
+ * <p>
+ * While it is expected that the generated Hibernate Search static metamodel will contain
+ * more precise field references that would match the actual field capabilities, this generic reference can
+ * be used by the users if they decide to opt-out of using the generated static metamodel
+ * and would just want to create a few simple pre-defined references.
+ *
+ * @param absolutePath The absolut field path.
+ * @param scopeRootType The class representing the scope root type.
+ * @param valueModel The model of values used in the predicate. See {@link ValueModel}.
+ * @param predicateType The class representing the type of the field used in a predicate, as per {@code valueModel}.
+ * @param <SR> Scope root type
+ * @param <T> The type of the field used in a predicate.
+ */
+@Incubating
+public record AnyPredicateReference<SR, T>( String absolutePath, Class<SR> scopeRootType, ValueModel valueModel,
+											Class<T> predicateType)
+		implements ExistsPredicateFieldReference<SR>,
+		KnnPredicateFieldReference<SR, T>,
+		MatchPredicateFieldReference<SR, T>,
+		NestedPredicateFieldReference<SR>,
+		PhrasePredicateFieldReference<SR, T>,
+		PrefixPredicateFieldReference<SR>,
+		QueryStringPredicateFieldReference<SR, T>,
+		RangePredicateFieldReference<SR, T>,
+		RegexpPredicateFieldReference<SR>,
+		SimpleQueryStringPredicateFieldReference<SR, T>,
+		SpatialPredicateFieldReference<SR>,
+		TermsPredicateFieldReference<SR>,
+		WildcardPredicateFieldReference<SR> {
+}

engine/src/main/java/org/hibernate/search/engine/search/reference/projection/AnyProjectionReference.java

@@ -0,0 +1,32 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.search.engine.search.reference.projection;
+
+import org.hibernate.search.engine.search.common.ValueModel;
+import org.hibernate.search.util.common.annotation.Incubating;
+
+/**
+ * A generic projected-field reference that can be manually created and passed to any projection-DSL methods that require a field reference.
+ * <p>
+ * While it is expected that the generated Hibernate Search static metamodel will contain
+ * more precise field references that would match the actual field capabilities, this generic reference can
+ * be used by the users if they decide to opt-out of using the generated static metamodel
+ * and would just want to create a few simple pre-defined references.
+ *
+ * @param absolutePath The absolut field path.
+ * @param scopeRootType The class representing the scope root type.
+ * @param valueModel The model of projected values. See {@link ValueModel}.
+ * @param projectionType The class representing the type of the projected field, as per {@code valueModel}.
+ * @param <SR> Scope root type
+ * @param <T> The type of the projected field.
+ */
+@Incubating
+public record AnyProjectionReference<SR, T>(String absolutePath, Class<SR> scopeRootType, ValueModel valueModel,
+											Class<T> projectionType)
+		implements DistanceProjectionFieldReference<SR>,
+		FieldProjectionFieldReference<SR, T>,
+		HighlightProjectionFieldReference<SR>,
+		ObjectProjectionFieldReference<SR> {
+}

engine/src/main/java/org/hibernate/search/engine/search/reference/sort/AnySortReference.java

@@ -0,0 +1,30 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.search.engine.search.reference.sort;
+
+import org.hibernate.search.engine.search.common.ValueModel;
+import org.hibernate.search.util.common.annotation.Incubating;
+
+/**
+ * A generic sort-field reference that can be manually created and passed to any sort-DSL methods that require a field reference.
+ * <p>
+ * While it is expected that the generated Hibernate Search static metamodel will contain
+ * more precise field references that would match the actual field capabilities, this generic reference can
+ * be used by the users if they decide to opt-out of using the generated static metamodel
+ * and would just want to create a few simple pre-defined references.
+ *
+ * @param absolutePath The absolut field path.
+ * @param scopeRootType The class representing the scope root type.
+ * @param valueModel The model of sort values. See {@link ValueModel}.
+ * @param sortType The class representing the type of the sorted field, as per {@code valueModel}.
+ * @param <SR> Scope root type
+ * @param <T> The type of the sorted field.
+ */
+@Incubating
+public record AnySortReference<SR, T>(String absolutePath, Class<SR> scopeRootType, ValueModel valueModel, Class<T> sortType)
+		implements DistanceSortFieldReference<SR>,
+		FieldSortFieldReference<SR, T>,
+		ScoreSortFieldReference<SR, T> {
+}