JCBC-1613: Add experimental support for FTS polygon queries.

To have a way to perform geo polygon query via the SDK, Added a GeoPolygonQuery class, as well as a geoPolygon factory method. Change-Id: I69659c5fb30d8260870a0087230cb390467900ce Reviewed-on: http://review.couchbase.org/c/couchbase-java-client/+/124218 Reviewed-by: David Nault <david.nault@couchbase.com> Tested-by: David Nault <david.nault@couchbase.com>

Author: JNS87

src/main/java/com/couchbase/client/java/search/SearchQuery.java

@@ -16,6 +16,7 @@
 package com.couchbase.client.java.search;
 
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 import java.util.concurrent.TimeUnit;
 
@@ -32,11 +33,13 @@
 import com.couchbase.client.java.search.queries.BooleanFieldQuery;
 import com.couchbase.client.java.search.queries.BooleanQuery;
 import com.couchbase.client.java.search.queries.ConjunctionQuery;
+import com.couchbase.client.java.search.queries.Coordinate;
 import com.couchbase.client.java.search.queries.DateRangeQuery;
 import com.couchbase.client.java.search.queries.DisjunctionQuery;
 import com.couchbase.client.java.search.queries.DocIdQuery;
 import com.couchbase.client.java.search.queries.GeoBoundingBoxQuery;
 import com.couchbase.client.java.search.queries.GeoDistanceQuery;
+import com.couchbase.client.java.search.queries.GeoPolygonQuery;
 import com.couchbase.client.java.search.queries.MatchAllQuery;
 import com.couchbase.client.java.search.queries.MatchNoneQuery;
 import com.couchbase.client.java.search.queries.MatchPhraseQuery;
@@ -53,7 +56,6 @@
 import com.couchbase.client.java.search.result.SearchQueryRow;
 import com.couchbase.client.java.search.sort.SearchSort;
 import com.couchbase.client.java.subdoc.DocumentFragment;
-import rx.Observable;
 
 /**
  * The FTS API entry point. Describes an FTS query entirely (index, query body and parameters) and can
@@ -614,4 +616,11 @@ public static GeoBoundingBoxQuery geoBoundingBox(double topLeftLon, double topLe
  public static GeoDistanceQuery geoDistance(double locationLon, double locationLat, String distance) {
  return new GeoDistanceQuery(locationLon, locationLat, distance);
  }
+
+ /** Prepare a {@link GeoPolygonQuery} body. */
+ @InterfaceStability.Experimental
+ public static GeoPolygonQuery geoPolygon(final List<Coordinate> points) {
+ return new GeoPolygonQuery(points);
+ }
+
 }

src/main/java/com/couchbase/client/java/search/queries/Coordinate.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright (c) 2020 Couchbase, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.couchbase.client.java.search.queries;
+
+import com.couchbase.client.core.annotations.InterfaceAudience;
+import com.couchbase.client.core.annotations.InterfaceStability;
+
+/**
+ * The {@link Coordinate} represents the longitude and latitude of a point.
+ *
+ * @author Jyotsna Nayak
+ */
+@InterfaceStability.Experimental
+@InterfaceAudience.Public
+public class Coordinate {
+
+ private final double lon;
+ private final double lat;
+
+ public static Coordinate ofLonLat(double lon, double lat) {
+ return new Coordinate(lon, lat);
+ }
+
+ private Coordinate(final double lon, final double lat) {
+ this.lon = lon;
+ this.lat = lat;
+ }
+
+ public double lon() {
+ return lon;
+ }
+
+ public double lat() {
+ return lat;
+ }
+
+}

src/main/java/com/couchbase/client/java/search/queries/GeoPolygonQuery.java

@@ -0,0 +1,65 @@
+/*
+ * Copyright (c) 2017 Couchbase, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.couchbase.client.java.search.queries;
+
+import java.util.List;
+
+import com.couchbase.client.core.annotations.InterfaceAudience;
+import com.couchbase.client.core.annotations.InterfaceStability;
+import com.couchbase.client.java.document.json.JsonArray;
+import com.couchbase.client.java.document.json.JsonObject;
+
+/**
+ * A FTS query which allows to match on geo polygons.
+ *
+ * @author Jyotsna Nayak
+ */
+@InterfaceStability.Experimental
+@InterfaceAudience.Public
+public class GeoPolygonQuery extends AbstractFtsQuery {
+
+ private final List<Coordinate> coordinates;
+
+ private String field;
+
+ public GeoPolygonQuery(final List<Coordinate> coordinates) {
+ this.coordinates = coordinates;
+ }
+
+ public GeoPolygonQuery field(final String field) {
+ this.field = field;
+ return this;
+ }
+
+ @Override
+ public GeoPolygonQuery boost(double boost) {
+ super.boost(boost);
+ return this;
+ }
+
+ @Override
+ protected void injectParams(final JsonObject input) {
+ JsonArray points = JsonArray.empty();
+ for (Coordinate coordinate : coordinates) {
+ points.add(JsonArray.from(coordinate.lon(), coordinate.lat()));
+ }
+ input.put("polygon_points", points);
+
+ if (field != null) {
+ input.put("field", field);
+ }
+ }
+}