HSEARCH-3319 Create reference traits interfaces

Author: marko-bekhta

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

@@ -0,0 +1,20 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+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,15 @@
+/*
+ * 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.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 create(P scopeProvider);
+}

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

@@ -0,0 +1,10 @@
+/*
+ * 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.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,8 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+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,8 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+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,16 @@
+/*
+ * 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;
+
+public interface TypedAggregationFieldReference<SR, T> extends AggregationFieldReference<SR> {
+
+	Class<T> aggregationType();
+
+	default ValueModel valueModel() {
+		return ValueModel.MAPPING;
+	}
+}

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

@@ -0,0 +1,8 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+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,8 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+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,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+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,8 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.search.engine.search.reference.predicate;
+
+public interface ExistsPredicateFieldReference<SR> extends PredicateFieldReference<SR> {
+}