Adding WithFieldName interface for QueryBuilders with fieldName (opensearch-project#15705)

dzane17 · jainankitk · dzane17 · commit 7a7cb0978783 · 2024-09-05T12:26:16.000-07:00
Signed-off-by: David Zane <davizane@amazon.com> Signed-off-by: Ankit Jain <akjain@amazon.com> Co-authored-by: Ankit Jain <akjain@amazon.com> (cherry picked from commit f5c897c)
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -52,6 +52,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Relax the join validation for Remote State publication ([#15471](https://github.com/opensearch-project/OpenSearch/pull/15471))
 - Optimize NodeIndicesStats output behind flag ([#14454](https://github.com/opensearch-project/OpenSearch/pull/14454))
 - MultiTermQueries in keyword fields now default to `indexed` approach and gated behind cluster setting ([#15637](https://github.com/opensearch-project/OpenSearch/pull/15637))
+- Adding WithFieldName interface for QueryBuilders with fieldName ([#15705](https://github.com/opensearch-project/OpenSearch/pull/15705))
 
 ### Dependencies
 - Bump `netty` from 4.1.111.Final to 4.1.112.Final ([#15081](https://github.com/opensearch-project/OpenSearch/pull/15081))
diff --git a/server/src/main/java/org/opensearch/index/query/AbstractGeometryQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/AbstractGeometryQueryBuilder.java
@@ -67,7 +67,9 @@
  *
  * @opensearch.internal
  */
-public abstract class AbstractGeometryQueryBuilder<QB extends AbstractGeometryQueryBuilder<QB>> extends AbstractQueryBuilder<QB> {
+public abstract class AbstractGeometryQueryBuilder<QB extends AbstractGeometryQueryBuilder<QB>> extends AbstractQueryBuilder<QB>
+    implements
+        WithFieldName {
 
     public static final String DEFAULT_SHAPE_INDEX_NAME = "shapes";
     public static final String DEFAULT_SHAPE_FIELD_NAME = "shape";
@@ -218,6 +220,7 @@ protected void doWriteTo(StreamOutput out) throws IOException {
     /**
      * @return the name of the field that will be queried
      */
+    @Override
     public String fieldName() {
         return fieldName;
     }
diff --git a/server/src/main/java/org/opensearch/index/query/BaseTermQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/BaseTermQueryBuilder.java
@@ -47,7 +47,7 @@
  *
  * @opensearch.internal
  */
-public abstract class BaseTermQueryBuilder<QB extends BaseTermQueryBuilder<QB>> extends AbstractQueryBuilder<QB> {
+public abstract class BaseTermQueryBuilder<QB extends BaseTermQueryBuilder<QB>> extends AbstractQueryBuilder<QB> implements WithFieldName {
 
     public static final ParseField VALUE_FIELD = new ParseField("value");
 
@@ -153,6 +153,7 @@ protected void doWriteTo(StreamOutput out) throws IOException {
     }
 
     /** Returns the field name used in this query. */
+    @Override
     public String fieldName() {
         return this.fieldName;
     }
diff --git a/server/src/main/java/org/opensearch/index/query/CommonTermsQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/CommonTermsQueryBuilder.java
@@ -67,7 +67,7 @@
  * @opensearch.internal
  */
 @Deprecated
-public class CommonTermsQueryBuilder extends AbstractQueryBuilder<CommonTermsQueryBuilder> {
+public class CommonTermsQueryBuilder extends AbstractQueryBuilder<CommonTermsQueryBuilder> implements WithFieldName {
 
     public static final String COMMON_TERMS_QUERY_DEPRECATION_MSG = "[match] query which can efficiently "
         + "skip blocks of documents if the total number of hits is not tracked";
@@ -152,6 +152,7 @@ protected void doWriteTo(StreamOutput out) throws IOException {
         out.writeFloat(cutoffFrequency);
     }
 
+    @Override
     public String fieldName() {
         return this.fieldName;
     }
diff --git a/server/src/main/java/org/opensearch/index/query/DistanceFeatureQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/DistanceFeatureQueryBuilder.java
@@ -57,7 +57,7 @@
  *
  * @opensearch.internal
  */
-public class DistanceFeatureQueryBuilder extends AbstractQueryBuilder<DistanceFeatureQueryBuilder> {
+public class DistanceFeatureQueryBuilder extends AbstractQueryBuilder<DistanceFeatureQueryBuilder> implements WithFieldName {
     public static final String NAME = "distance_feature";
 
     private static final ParseField FIELD_FIELD = new ParseField("field");
@@ -136,7 +136,8 @@ protected Query doToQuery(QueryShardContext context) throws IOException {
         return fieldType.distanceFeatureQuery(origin.origin(), pivot, 1.0f, context);
     }
 
-    String fieldName() {
+    @Override
+    public String fieldName() {
         return field;
     }
 
diff --git a/server/src/main/java/org/opensearch/index/query/ExistsQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/ExistsQueryBuilder.java
@@ -59,7 +59,7 @@
  *
  * @opensearch.internal
  */
-public class ExistsQueryBuilder extends AbstractQueryBuilder<ExistsQueryBuilder> {
+public class ExistsQueryBuilder extends AbstractQueryBuilder<ExistsQueryBuilder> implements WithFieldName {
     public static final String NAME = "exists";
 
     public static final ParseField FIELD_FIELD = new ParseField("field");
@@ -89,6 +89,7 @@ protected void doWriteTo(StreamOutput out) throws IOException {
     /**
      * @return the field name that has to exist for this query to match
      */
+    @Override
     public String fieldName() {
         return this.fieldName;
     }
diff --git a/server/src/main/java/org/opensearch/index/query/FieldMaskingSpanQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/FieldMaskingSpanQueryBuilder.java
@@ -53,7 +53,10 @@
  *
  * @opensearch.internal
  */
-public class FieldMaskingSpanQueryBuilder extends AbstractQueryBuilder<FieldMaskingSpanQueryBuilder> implements SpanQueryBuilder {
+public class FieldMaskingSpanQueryBuilder extends AbstractQueryBuilder<FieldMaskingSpanQueryBuilder>
+    implements
+        SpanQueryBuilder,
+        WithFieldName {
 
     public static final String NAME = "span_field_masking";
     public static final ParseField SPAN_FIELD_MASKING_FIELD = new ParseField(NAME, "field_masking_span");
@@ -100,6 +103,7 @@ protected void doWriteTo(StreamOutput out) throws IOException {
     /**
      * @return the field name for this query
      */
+    @Override
     public String fieldName() {
         return this.fieldName;
     }
diff --git a/server/src/main/java/org/opensearch/index/query/GeoBoundingBoxQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/GeoBoundingBoxQueryBuilder.java
@@ -66,7 +66,7 @@
  *
  * @opensearch.internal
  * */
-public class GeoBoundingBoxQueryBuilder extends AbstractQueryBuilder<GeoBoundingBoxQueryBuilder> {
+public class GeoBoundingBoxQueryBuilder extends AbstractQueryBuilder<GeoBoundingBoxQueryBuilder> implements WithFieldName {
     public static final String NAME = "geo_bounding_box";
 
     /** Default type for executing this query (memory as of this writing). */
@@ -263,6 +263,7 @@ public GeoExecType type() {
     }
 
     /** Returns the name of the field to base the bounding box computation on. */
+    @Override
     public String fieldName() {
         return this.fieldName;
     }
diff --git a/server/src/main/java/org/opensearch/index/query/GeoDistanceQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/GeoDistanceQueryBuilder.java
@@ -63,7 +63,7 @@
  *
  * @opensearch.internal
  */
-public class GeoDistanceQueryBuilder extends AbstractQueryBuilder<GeoDistanceQueryBuilder> {
+public class GeoDistanceQueryBuilder extends AbstractQueryBuilder<GeoDistanceQueryBuilder> implements WithFieldName {
     public static final String NAME = "geo_distance";
 
     /** Default for distance unit computation. */
@@ -129,6 +129,7 @@ protected void doWriteTo(StreamOutput out) throws IOException {
     }
 
     /** Name of the field this query is operating on. */
+    @Override
     public String fieldName() {
         return this.fieldName;
     }
diff --git a/server/src/main/java/org/opensearch/index/query/GeoPolygonQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/GeoPolygonQueryBuilder.java
@@ -61,7 +61,7 @@
  *
  * @opensearch.internal
  */
-public class GeoPolygonQueryBuilder extends AbstractQueryBuilder<GeoPolygonQueryBuilder> {
+public class GeoPolygonQueryBuilder extends AbstractQueryBuilder<GeoPolygonQueryBuilder> implements WithFieldName {
     public static final String NAME = "geo_polygon";
 
     /**
@@ -131,6 +131,7 @@ protected void doWriteTo(StreamOutput out) throws IOException {
         out.writeBoolean(ignoreUnmapped);
     }
 
+    @Override
     public String fieldName() {
         return fieldName;
     }
diff --git a/server/src/main/java/org/opensearch/index/query/MatchBoolPrefixQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/MatchBoolPrefixQueryBuilder.java
@@ -61,7 +61,7 @@
  *
  * @opensearch.internal
  */
-public class MatchBoolPrefixQueryBuilder extends AbstractQueryBuilder<MatchBoolPrefixQueryBuilder> {
+public class MatchBoolPrefixQueryBuilder extends AbstractQueryBuilder<MatchBoolPrefixQueryBuilder> implements WithFieldName {
 
     public static final String NAME = "match_bool_prefix";
 
@@ -127,6 +127,7 @@ protected void doWriteTo(StreamOutput out) throws IOException {
     }
 
     /** Returns the field name used in this query. */
+    @Override
     public String fieldName() {
         return this.fieldName;
     }
diff --git a/server/src/main/java/org/opensearch/index/query/MatchPhrasePrefixQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/MatchPhrasePrefixQueryBuilder.java
@@ -53,7 +53,7 @@
  *
  * @opensearch.internal
  */
-public class MatchPhrasePrefixQueryBuilder extends AbstractQueryBuilder<MatchPhrasePrefixQueryBuilder> {
+public class MatchPhrasePrefixQueryBuilder extends AbstractQueryBuilder<MatchPhrasePrefixQueryBuilder> implements WithFieldName {
     public static final String NAME = "match_phrase_prefix";
     public static final ParseField MAX_EXPANSIONS_FIELD = new ParseField("max_expansions");
     public static final ParseField ZERO_TERMS_QUERY_FIELD = new ParseField("zero_terms_query");
@@ -109,6 +109,7 @@ protected void doWriteTo(StreamOutput out) throws IOException {
     }
 
     /** Returns the field name used in this query. */
+    @Override
     public String fieldName() {
         return this.fieldName;
     }
diff --git a/server/src/main/java/org/opensearch/index/query/MatchPhraseQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/MatchPhraseQueryBuilder.java
@@ -52,7 +52,7 @@
  *
  * @opensearch.internal
  */
-public class MatchPhraseQueryBuilder extends AbstractQueryBuilder<MatchPhraseQueryBuilder> {
+public class MatchPhraseQueryBuilder extends AbstractQueryBuilder<MatchPhraseQueryBuilder> implements WithFieldName {
     public static final String NAME = "match_phrase";
     public static final ParseField SLOP_FIELD = new ParseField("slop");
     public static final ParseField ZERO_TERMS_QUERY_FIELD = new ParseField("zero_terms_query");
@@ -100,6 +100,7 @@ protected void doWriteTo(StreamOutput out) throws IOException {
     }
 
     /** Returns the field name used in this query. */
+    @Override
     public String fieldName() {
         return this.fieldName;
     }
diff --git a/server/src/main/java/org/opensearch/index/query/MatchQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/MatchQueryBuilder.java
@@ -56,7 +56,7 @@
  *
  * @opensearch.internal
  */
-public class MatchQueryBuilder extends AbstractQueryBuilder<MatchQueryBuilder> {
+public class MatchQueryBuilder extends AbstractQueryBuilder<MatchQueryBuilder> implements WithFieldName {
 
     private static final String CUTOFF_FREQUENCY_DEPRECATION_MSG = "you can omit this option, "
         + "the [match] query can skip block of documents efficiently if the total number of hits is not tracked";
@@ -171,6 +171,7 @@ protected void doWriteTo(StreamOutput out) throws IOException {
     }
 
     /** Returns the field name used in this query. */
+    @Override
     public String fieldName() {
         return this.fieldName;
     }
diff --git a/server/src/main/java/org/opensearch/index/query/MultiTermQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/MultiTermQueryBuilder.java
@@ -36,9 +36,4 @@
  *
  * @opensearch.internal
  */
-public interface MultiTermQueryBuilder extends QueryBuilder {
-    /**
-     * Get the field name for this query.
-     */
-    String fieldName();
-}
+public interface MultiTermQueryBuilder extends QueryBuilder, WithFieldName {}
diff --git a/server/src/main/java/org/opensearch/index/query/SpanNearQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/SpanNearQueryBuilder.java
@@ -322,7 +322,7 @@ public void visit(QueryBuilderVisitor visitor) {
      *
      * @opensearch.internal
      */
-    public static class SpanGapQueryBuilder implements SpanQueryBuilder {
+    public static class SpanGapQueryBuilder implements SpanQueryBuilder, WithFieldName {
         public static final String NAME = "span_gap";
 
         /** Name of field to match against. */
@@ -358,6 +358,7 @@ public SpanGapQueryBuilder(StreamInput in) throws IOException {
         /**
          * @return fieldName  The name of the field
          */
+        @Override
         public String fieldName() {
             return fieldName;
         }
diff --git a/server/src/main/java/org/opensearch/index/query/TermsQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/TermsQueryBuilder.java
@@ -79,7 +79,7 @@
  *
  * @opensearch.internal
  */
-public class TermsQueryBuilder extends AbstractQueryBuilder<TermsQueryBuilder> {
+public class TermsQueryBuilder extends AbstractQueryBuilder<TermsQueryBuilder> implements WithFieldName {
     public static final String NAME = "terms";
 
     private final String fieldName;
@@ -269,6 +269,7 @@ protected void doWriteTo(StreamOutput out) throws IOException {
         }
     }
 
+    @Override
     public String fieldName() {
         return this.fieldName;
     }
diff --git a/server/src/main/java/org/opensearch/index/query/WithFieldName.java b/server/src/main/java/org/opensearch/index/query/WithFieldName.java
@@ -0,0 +1,21 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+package org.opensearch.index.query;
+
+/**
+ * Interface for classes with a fieldName method
+ *
+ * @opensearch.internal
+ */
+public interface WithFieldName {
+    /**
+     * Get the field name for this query.
+     */
+    String fieldName();
+}

Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@`
`47`	`47`	`*`
`48`	`48`	`* @opensearch.internal`
`49`	`49`	`*/`
`50`		`-public abstract class BaseTermQueryBuilder<QB extends BaseTermQueryBuilder<QB>> extends AbstractQueryBuilder<QB> {`
	`50`	`+public abstract class BaseTermQueryBuilder<QB extends BaseTermQueryBuilder<QB>> extends AbstractQueryBuilder<QB> implements WithFieldName {`
`51`	`51`
`52`	`52`	`public static final ParseField VALUE_FIELD = new ParseField("value");`
`53`	`53`
`@@ -153,6 +153,7 @@ protected void doWriteTo(StreamOutput out) throws IOException {`
`153`	`153`	`}`
`154`	`154`
`155`	`155`	`/** Returns the field name used in this query. */`
	`156`	`+ @Override`
`156`	`157`	`public String fieldName() {`
`157`	`158`	`return this.fieldName;`
`158`	`159`	`}`
Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@`
`67`	`67`	`* @opensearch.internal`
`68`	`68`	`*/`
`69`	`69`	`@Deprecated`
`70`		`-public class CommonTermsQueryBuilder extends AbstractQueryBuilder<CommonTermsQueryBuilder> {`
	`70`	`+public class CommonTermsQueryBuilder extends AbstractQueryBuilder<CommonTermsQueryBuilder> implements WithFieldName {`
`71`	`71`
`72`	`72`	`public static final String COMMON_TERMS_QUERY_DEPRECATION_MSG = "[match] query which can efficiently "`
`73`	`73`	`+ "skip blocks of documents if the total number of hits is not tracked";`
`@@ -152,6 +152,7 @@ protected void doWriteTo(StreamOutput out) throws IOException {`
`152`	`152`	`out.writeFloat(cutoffFrequency);`
`153`	`153`	`}`
`154`	`154`
	`155`	`+ @Override`
`155`	`156`	`public String fieldName() {`
`156`	`157`	`return this.fieldName;`
`157`	`158`	`}`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@`
`57`	`57`	`*`
`58`	`58`	`* @opensearch.internal`
`59`	`59`	`*/`
`60`		`-public class DistanceFeatureQueryBuilder extends AbstractQueryBuilder<DistanceFeatureQueryBuilder> {`
	`60`	`+public class DistanceFeatureQueryBuilder extends AbstractQueryBuilder<DistanceFeatureQueryBuilder> implements WithFieldName {`
`61`	`61`	`public static final String NAME = "distance_feature";`
`62`	`62`
`63`	`63`	`private static final ParseField FIELD_FIELD = new ParseField("field");`
`@@ -136,7 +136,8 @@ protected Query doToQuery(QueryShardContext context) throws IOException {`
`136`	`136`	`return fieldType.distanceFeatureQuery(origin.origin(), pivot, 1.0f, context);`
`137`	`137`	`}`
`138`	`138`
`139`		`- String fieldName() {`
	`139`	`+ @Override`
	`140`	`+ public String fieldName() {`
`140`	`141`	`return field;`
`141`	`142`	`}`
`142`	`143`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@`
`66`	`66`	`*`
`67`	`67`	`* @opensearch.internal`
`68`	`68`	`* */`
`69`		`-public class GeoBoundingBoxQueryBuilder extends AbstractQueryBuilder<GeoBoundingBoxQueryBuilder> {`
	`69`	`+public class GeoBoundingBoxQueryBuilder extends AbstractQueryBuilder<GeoBoundingBoxQueryBuilder> implements WithFieldName {`
`70`	`70`	`public static final String NAME = "geo_bounding_box";`
`71`	`71`
`72`	`72`	`/** Default type for executing this query (memory as of this writing). */`
`@@ -263,6 +263,7 @@ public GeoExecType type() {`
`263`	`263`	`}`
`264`	`264`
`265`	`265`	`/** Returns the name of the field to base the bounding box computation on. */`
	`266`	`+ @Override`
`266`	`267`	`public String fieldName() {`
`267`	`268`	`return this.fieldName;`
`268`	`269`	`}`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@`
`63`	`63`	`*`
`64`	`64`	`* @opensearch.internal`
`65`	`65`	`*/`
`66`		`-public class GeoDistanceQueryBuilder extends AbstractQueryBuilder<GeoDistanceQueryBuilder> {`
	`66`	`+public class GeoDistanceQueryBuilder extends AbstractQueryBuilder<GeoDistanceQueryBuilder> implements WithFieldName {`
`67`	`67`	`public static final String NAME = "geo_distance";`
`68`	`68`
`69`	`69`	`/** Default for distance unit computation. */`
`@@ -129,6 +129,7 @@ protected void doWriteTo(StreamOutput out) throws IOException {`
`129`	`129`	`}`
`130`	`130`
`131`	`131`	`/** Name of the field this query is operating on. */`
	`132`	`+ @Override`
`132`	`133`	`public String fieldName() {`
`133`	`134`	`return this.fieldName;`
`134`	`135`	`}`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@`
`61`	`61`	`*`
`62`	`62`	`* @opensearch.internal`
`63`	`63`	`*/`
`64`		`-public class GeoPolygonQueryBuilder extends AbstractQueryBuilder<GeoPolygonQueryBuilder> {`
	`64`	`+public class GeoPolygonQueryBuilder extends AbstractQueryBuilder<GeoPolygonQueryBuilder> implements WithFieldName {`
`65`	`65`	`public static final String NAME = "geo_polygon";`
`66`	`66`
`67`	`67`	`/**`
`@@ -131,6 +131,7 @@ protected void doWriteTo(StreamOutput out) throws IOException {`
`131`	`131`	`out.writeBoolean(ignoreUnmapped);`
`132`	`132`	`}`
`133`	`133`
	`134`	`+ @Override`
`134`	`135`	`public String fieldName() {`
`135`	`136`	`return fieldName;`
`136`	`137`	`}`