HSEARCH-3319 Create reference traits interfaces

Author: marko-bekhta

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

@@ -0,0 +1,22 @@
+/*
+ * Hibernate Search, full-text search for your domain model
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.search.engine.search.reference;
+
+import org.hibernate.search.util.common.annotation.Incubating;
+
+/**
+ * The most common interface for the field reference hierarchy.
+ * @param <SR> Containing type.
+ */
+@Incubating
+public interface FieldReference<SR> {
+
+	String absolutePath();
+
+	Class<SR> scopeRootType();
+
+}

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

@@ -0,0 +1,17 @@
+/*
+ * Hibernate Search, full-text search for your domain model
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.search.engine.search.reference;
+
+import org.hibernate.search.engine.common.EntityReference;
+import org.hibernate.search.engine.mapper.scope.SearchScope;
+import org.hibernate.search.engine.mapper.scope.SearchScopeProvider;
+
+public interface RootReferenceScope<SR, T> {
+	Class<SR> rootReferenceType();
+
+	<ER extends EntityReference, S extends SearchScope<T, ER>, P extends SearchScopeProvider<ER>> S scope(P scopeProvider);
+}

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

@@ -0,0 +1,12 @@
+/*
+ * Hibernate Search, full-text search for your domain model
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.search.engine.search.reference.aggregation;
+
+import org.hibernate.search.engine.search.reference.FieldReference;
+
+public interface AggregationFieldReference<SR> extends FieldReference<SR> {
+}

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

@@ -0,0 +1,10 @@
+/*
+ * Hibernate Search, full-text search for your domain model
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.search.engine.search.reference.aggregation;
+
+public interface RangeAggregationFieldReference<SR, T> extends TypedAggregationFieldReference<SR, T> {
+}

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

@@ -0,0 +1,10 @@
+/*
+ * Hibernate Search, full-text search for your domain model
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.search.engine.search.reference.aggregation;
+
+public interface TermsAggregationFieldReference<SR, T> extends TypedAggregationFieldReference<SR, T> {
+}

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

@@ -0,0 +1,18 @@
+/*
+ * Hibernate Search, full-text search for your domain model
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.search.engine.search.reference.aggregation;
+
+import org.hibernate.search.engine.search.common.ValueConvert;
+
+public interface TypedAggregationFieldReference<SR, T> extends AggregationFieldReference<SR> {
+
+	Class<T> aggregationType();
+
+	default ValueConvert valueConvert() {
+		return ValueConvert.YES;
+	}
+}

engine/src/main/java/org/hibernate/search/engine/search/reference/object/FlattenedFieldReference.java

@@ -0,0 +1,10 @@
+/*
+ * Hibernate Search, full-text search for your domain model
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.search.engine.search.reference.object;
+
+public interface FlattenedFieldReference<SR> extends ObjectFieldReference<SR> {
+}

engine/src/main/java/org/hibernate/search/engine/search/reference/object/NestedFieldReference.java

@@ -0,0 +1,10 @@
+/*
+ * Hibernate Search, full-text search for your domain model
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.search.engine.search.reference.object;
+
+public interface NestedFieldReference<SR> extends ObjectFieldReference<SR> {
+}

engine/src/main/java/org/hibernate/search/engine/search/reference/object/ObjectFieldReference.java

@@ -0,0 +1,12 @@
+/*
+ * Hibernate Search, full-text search for your domain model
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.search.engine.search.reference.object;
+
+import org.hibernate.search.engine.search.reference.FieldReference;
+
+public interface ObjectFieldReference<SR> extends FieldReference<SR> {
+}

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

@@ -0,0 +1,10 @@
+/*
+ * Hibernate Search, full-text search for your domain model
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.search.engine.search.reference.predicate;
+
+public interface ExistsPredicateFieldReference<SR> extends PredicateFieldReference<SR> {
+}

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

@@ -0,0 +1,10 @@
+/*
+ * Hibernate Search, full-text search for your domain model
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.search.engine.search.reference.predicate;
+
+public interface KnnPredicateFieldReference<SR, T> extends TypedPredicateFieldReference<SR, T> {
+}

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

@@ -0,0 +1,10 @@
+/*
+ * Hibernate Search, full-text search for your domain model
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.search.engine.search.reference.predicate;
+
+public interface MatchPredicateFieldReference<SR, T> extends TypedPredicateFieldReference<SR, T> {
+}

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

@@ -0,0 +1,10 @@
+/*
+ * Hibernate Search, full-text search for your domain model
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.search.engine.search.reference.predicate;
+
+public interface NestedPredicateFieldReference<SR> extends PredicateFieldReference<SR> {
+}

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

@@ -0,0 +1,10 @@
+/*
+ * Hibernate Search, full-text search for your domain model
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.search.engine.search.reference.predicate;
+
+public interface PhrasePredicateFieldReference<SR, T> extends TypedPredicateFieldReference<SR, T> {
+}

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

@@ -0,0 +1,12 @@
+/*
+ * Hibernate Search, full-text search for your domain model
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.search.engine.search.reference.predicate;
+
+import org.hibernate.search.engine.search.reference.FieldReference;
+
+public interface PredicateFieldReference<SR> extends FieldReference<SR> {
+}

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

@@ -0,0 +1,10 @@
+/*
+ * Hibernate Search, full-text search for your domain model
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.search.engine.search.reference.predicate;
+
+public interface QueryStringPredicateFieldReference<SR, T> extends TypedPredicateFieldReference<SR, T> {
+}

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

@@ -0,0 +1,10 @@
+/*
+ * Hibernate Search, full-text search for your domain model
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.search.engine.search.reference.predicate;
+
+public interface RangePredicateFieldReference<SR, T> extends TypedPredicateFieldReference<SR, T> {
+}

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

@@ -0,0 +1,10 @@
+/*
+ * Hibernate Search, full-text search for your domain model
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.search.engine.search.reference.predicate;
+
+public interface RegexpPredicateFieldReference<SR, T> extends TypedPredicateFieldReference<SR, T> {
+}

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

@@ -0,0 +1,10 @@
+/*
+ * Hibernate Search, full-text search for your domain model
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.search.engine.search.reference.predicate;
+
+public interface SimpleQueryStringPredicateFieldReference<SR, T> extends TypedPredicateFieldReference<SR, T> {
+}

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

@@ -0,0 +1,10 @@
+/*
+ * Hibernate Search, full-text search for your domain model
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.search.engine.search.reference.predicate;
+
+public interface SpatialWithinBoundingBoxPredicateFieldReference<SR, T> extends TypedPredicateFieldReference<SR, T> {
+}

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

@@ -0,0 +1,10 @@
+/*
+ * Hibernate Search, full-text search for your domain model
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.search.engine.search.reference.predicate;
+
+public interface SpatialWithinCirclePredicateFieldReference<SR, T> extends TypedPredicateFieldReference<SR, T> {
+}

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

@@ -0,0 +1,10 @@
+/*
+ * Hibernate Search, full-text search for your domain model
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.search.engine.search.reference.predicate;
+
+public interface SpatialWithinPolygonPredicateFieldReference<SR, T> extends TypedPredicateFieldReference<SR, T> {
+}

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

@@ -0,0 +1,10 @@
+/*
+ * Hibernate Search, full-text search for your domain model
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.search.engine.search.reference.predicate;
+
+public interface TermsPredicateFieldReference<SR, T> extends TypedPredicateFieldReference<SR, T> {
+}

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

@@ -0,0 +1,19 @@
+/*
+ * Hibernate Search, full-text search for your domain model
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.search.engine.search.reference.predicate;
+
+import org.hibernate.search.engine.search.common.ValueConvert;
+import org.hibernate.search.engine.search.reference.FieldReference;
+
+public interface TypedPredicateFieldReference<SR, T> extends FieldReference<SR> {
+
+	Class<T> predicateType();
+
+	default ValueConvert valueConvert() {
+		return ValueConvert.YES;
+	}
+}

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

@@ -0,0 +1,10 @@
+/*
+ * Hibernate Search, full-text search for your domain model
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.search.engine.search.reference.predicate;
+
+public interface WildcardPredicateFieldReference<SR, T> extends TypedPredicateFieldReference<SR, T> {
+}

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

@@ -0,0 +1,10 @@
+/*
+ * Hibernate Search, full-text search for your domain model
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.search.engine.search.reference.projection;
+
+public interface DistanceProjectionFieldReference<SR, T> extends TypedProjectionFieldReference<SR, T> {
+}

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

@@ -0,0 +1,10 @@
+/*
+ * Hibernate Search, full-text search for your domain model
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.search.engine.search.reference.projection;
+
+public interface FieldProjectionFieldReference<SR, T> extends TypedProjectionFieldReference<SR, T> {
+}

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

@@ -0,0 +1,10 @@
+/*
+ * Hibernate Search, full-text search for your domain model
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.search.engine.search.reference.projection;
+
+public interface HighlightProjectionFieldReference<SR> extends ProjectionFieldReference<SR> {
+}

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

@@ -0,0 +1,10 @@
+/*
+ * Hibernate Search, full-text search for your domain model
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.search.engine.search.reference.projection;
+
+public interface ObjectProjectionFieldReference<SR> extends ProjectionFieldReference<SR> {
+}

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

@@ -0,0 +1,12 @@
+/*
+ * Hibernate Search, full-text search for your domain model
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.search.engine.search.reference.projection;
+
+import org.hibernate.search.engine.search.reference.FieldReference;
+
+public interface ProjectionFieldReference<SR> extends FieldReference<SR> {
+}

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

@@ -0,0 +1,18 @@
+/*
+ * Hibernate Search, full-text search for your domain model
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.search.engine.search.reference.projection;
+
+import org.hibernate.search.engine.search.common.ValueConvert;
+
+public interface TypedProjectionFieldReference<SR, T> extends ProjectionFieldReference<SR> {
+
+	Class<T> projectionType();
+
+	default ValueConvert valueConvert() {
+		return ValueConvert.YES;
+	}
+}