Merge pull request #1613 from marklogic/feature/563-optic-part-1

rjrudin · web-flow · commit 1b0bb02ce8c4 · 2023-10-24T18:13:01.000-04:00
DEVEXP-563 Added geohashSubhashes to Optic plan builder
diff --git a/marklogic-client-api/src/main/java/com/marklogic/client/expression/CtsExpr.java b/marklogic-client-api/src/main/java/com/marklogic/client/expression/CtsExpr.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 MarkLogic Corporation
+ * Copyright (c) 2023 MarkLogic Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -3240,7 +3240,7 @@ public interface CtsExpr {
   * @return  a CtsCircleSeqExpr sequence
   */
   public CtsCircleSeqExpr circleSeq(CtsCircleExpr... items);
-
+ 
 /**
   * Constructs a sequence of CtsPeriodExpr items.
   * @param items  the CtsPeriodExpr items collected by the sequence
diff --git a/marklogic-client-api/src/main/java/com/marklogic/client/expression/FnExpr.java b/marklogic-client-api/src/main/java/com/marklogic/client/expression/FnExpr.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 MarkLogic Corporation
+ * Copyright (c) 2023 MarkLogic Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/marklogic-client-api/src/main/java/com/marklogic/client/expression/GeoExpr.java b/marklogic-client-api/src/main/java/com/marklogic/client/expression/GeoExpr.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 MarkLogic Corporation
+ * Copyright (c) 2023 MarkLogic Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -767,6 +767,17 @@ public interface GeoExpr {
   * @return  a server expression with the <a href="{@docRoot}/doc-files/types/xs_double.html">xs:double</a> server data type
   */
   public ServerExpression geohashPrecisionDimensions(ServerExpression precision);
+/**
+  * Given a geohash string, return the 32 subhashes.
+  *
+  * <a name="ml-server-type-geohash-subhashes"></a>
+  
+  * <p>
+  * Provides a client interface to the <a href="http://docs.marklogic.com/geo:geohash-subhashes" target="mlserverdoc">geo:geohash-subhashes</a> server function.
+  * @param hash  The geohash string, as produced from the function geo:geohash-encode.  (of <a href="{@docRoot}/doc-files/types/xs_string.html">xs:string</a>)
+  * @return  a server expression with the <a href="{@docRoot}/doc-files/types/xs_string.html">xs:string</a> server data type
+  */
+  public ServerExpression geohashSubhashes(ServerExpression hash);
 /**
   * Given a geohash string, return the 32 subhashes.
   * <p>
@@ -778,9 +789,6 @@ public interface GeoExpr {
   public ServerExpression geohashSubhashes(ServerExpression hash, String which);
 /**
   * Given a geohash string, return the 32 subhashes.
-  *
-  * <a name="ml-server-type-geohash-subhashes"></a>
-  
   * <p>
   * Provides a client interface to the <a href="http://docs.marklogic.com/geo:geohash-subhashes" target="mlserverdoc">geo:geohash-subhashes</a> server function.
   * @param hash  The geohash string, as produced from the function geo:geohash-encode.  (of <a href="{@docRoot}/doc-files/types/xs_string.html">xs:string</a>)
diff --git a/marklogic-client-api/src/main/java/com/marklogic/client/expression/JsonExpr.java b/marklogic-client-api/src/main/java/com/marklogic/client/expression/JsonExpr.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 MarkLogic Corporation
+ * Copyright (c) 2023 MarkLogic Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/marklogic-client-api/src/main/java/com/marklogic/client/expression/MapExpr.java b/marklogic-client-api/src/main/java/com/marklogic/client/expression/MapExpr.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 MarkLogic Corporation
+ * Copyright (c) 2023 MarkLogic Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/marklogic-client-api/src/main/java/com/marklogic/client/expression/MathExpr.java b/marklogic-client-api/src/main/java/com/marklogic/client/expression/MathExpr.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 MarkLogic Corporation
+ * Copyright (c) 2023 MarkLogic Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/marklogic-client-api/src/main/java/com/marklogic/client/expression/PlanBuilder.java b/marklogic-client-api/src/main/java/com/marklogic/client/expression/PlanBuilder.java
diff --git a/marklogic-client-api/src/main/java/com/marklogic/client/expression/RdfExpr.java b/marklogic-client-api/src/main/java/com/marklogic/client/expression/RdfExpr.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 MarkLogic Corporation
+ * Copyright (c) 2023 MarkLogic Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/marklogic-client-api/src/main/java/com/marklogic/client/expression/SemExpr.java b/marklogic-client-api/src/main/java/com/marklogic/client/expression/SemExpr.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 MarkLogic Corporation
+ * Copyright (c) 2023 MarkLogic Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/marklogic-client-api/src/main/java/com/marklogic/client/expression/SpellExpr.java b/marklogic-client-api/src/main/java/com/marklogic/client/expression/SpellExpr.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 MarkLogic Corporation
+ * Copyright (c) 2023 MarkLogic Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/marklogic-client-api/src/main/java/com/marklogic/client/expression/SqlExpr.java b/marklogic-client-api/src/main/java/com/marklogic/client/expression/SqlExpr.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 MarkLogic Corporation
+ * Copyright (c) 2023 MarkLogic Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/marklogic-client-api/src/main/java/com/marklogic/client/expression/XdmpExpr.java b/marklogic-client-api/src/main/java/com/marklogic/client/expression/XdmpExpr.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 MarkLogic Corporation
+ * Copyright (c) 2023 MarkLogic Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -177,7 +177,7 @@ public interface XdmpExpr {
   * <p>
   * Provides a client interface to the <a href="http://docs.marklogic.com/xdmp:describe" target="mlserverdoc">xdmp:describe</a> server function.
   * @param item  The item sequence whose description is returned.  (of <a href="{@docRoot}/doc-files/types/item.html">item</a>)
-  * @param maxSequenceLength  Represents the maximum number of items per sequence to print. The default is 3. () means no maximum.  (of <a href="{@docRoot}/doc-files/types/xs_unsignedInt.html">xs:unsignedInt</a>)
+  * @param maxSequenceLength  Represents the maximum number of items per sequence to print. The default is 3.  (of <a href="{@docRoot}/doc-files/types/xs_unsignedInt.html">xs:unsignedInt</a>)
   * @return  a server expression with the <a href="{@docRoot}/doc-files/types/xs_string.html">xs:string</a> server data type
   */
   public ServerExpression describe(ServerExpression item, ServerExpression maxSequenceLength);
@@ -186,8 +186,8 @@ public interface XdmpExpr {
   * <p>
   * Provides a client interface to the <a href="http://docs.marklogic.com/xdmp:describe" target="mlserverdoc">xdmp:describe</a> server function.
   * @param item  The item sequence whose description is returned.  (of <a href="{@docRoot}/doc-files/types/item.html">item</a>)
-  * @param maxSequenceLength  Represents the maximum number of items per sequence to print. The default is 3. () means no maximum.  (of <a href="{@docRoot}/doc-files/types/xs_unsignedInt.html">xs:unsignedInt</a>)
-  * @param maxItemLength  Represents the maximum number of characters per item to print. The default is 64. The minimum is 8. () means no limit.  (of <a href="{@docRoot}/doc-files/types/xs_unsignedInt.html">xs:unsignedInt</a>)
+  * @param maxSequenceLength  Represents the maximum number of items per sequence to print. The default is 3.  (of <a href="{@docRoot}/doc-files/types/xs_unsignedInt.html">xs:unsignedInt</a>)
+  * @param maxItemLength  Represents the maximum number of characters per item to print. The default is 64. The minimum is 8.  (of <a href="{@docRoot}/doc-files/types/xs_unsignedInt.html">xs:unsignedInt</a>)
   * @return  a server expression with the <a href="{@docRoot}/doc-files/types/xs_string.html">xs:string</a> server data type
   */
   public ServerExpression describe(ServerExpression item, ServerExpression maxSequenceLength, ServerExpression maxItemLength);
diff --git a/marklogic-client-api/src/main/java/com/marklogic/client/expression/XsExpr.java b/marklogic-client-api/src/main/java/com/marklogic/client/expression/XsExpr.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 MarkLogic Corporation
+ * Copyright (c) 2023 MarkLogic Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/marklogic-client-api/src/main/java/com/marklogic/client/impl/CtsExprImpl.java b/marklogic-client-api/src/main/java/com/marklogic/client/impl/CtsExprImpl.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 MarkLogic Corporation
+ * Copyright (c) 2023 MarkLogic Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -184,7 +184,7 @@ public ServerExpression boxWest(ServerExpression box) {
     return new XsExprImpl.NumericCallImpl("cts", "box-west", new Object[]{ box });
   }
 
-
+  
   @Override
   public CtsCircleExpr circle(double radius, ServerExpression center) {
     return circle(xs.doubleVal(radius), center);
diff --git a/marklogic-client-api/src/main/java/com/marklogic/client/impl/FnExprImpl.java b/marklogic-client-api/src/main/java/com/marklogic/client/impl/FnExprImpl.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 MarkLogic Corporation
+ * Copyright (c) 2023 MarkLogic Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/marklogic-client-api/src/main/java/com/marklogic/client/impl/GeoExprImpl.java b/marklogic-client-api/src/main/java/com/marklogic/client/impl/GeoExprImpl.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 MarkLogic Corporation
+ * Copyright (c) 2023 MarkLogic Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -686,6 +686,15 @@ public ServerExpression geohashPrecisionDimensions(ServerExpression precision) {
   }
 
   
+  @Override
+  public ServerExpression geohashSubhashes(ServerExpression hash) {
+    if (hash == null) {
+      throw new IllegalArgumentException("hash parameter for geohashSubhashes() cannot be null");
+    }
+    return new XsExprImpl.StringSeqCallImpl("geo", "geohash-subhashes", new Object[]{ hash });
+  }
+
+  
   @Override
   public ServerExpression geohashSubhashes(ServerExpression hash, String which) {
     return geohashSubhashes(hash, (which == null) ? (ServerExpression) null : xs.string(which));
diff --git a/marklogic-client-api/src/main/java/com/marklogic/client/impl/JsonExprImpl.java b/marklogic-client-api/src/main/java/com/marklogic/client/impl/JsonExprImpl.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 MarkLogic Corporation
+ * Copyright (c) 2023 MarkLogic Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/marklogic-client-api/src/main/java/com/marklogic/client/impl/MapExprImpl.java b/marklogic-client-api/src/main/java/com/marklogic/client/impl/MapExprImpl.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 MarkLogic Corporation
+ * Copyright (c) 2023 MarkLogic Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/marklogic-client-api/src/main/java/com/marklogic/client/impl/MathExprImpl.java b/marklogic-client-api/src/main/java/com/marklogic/client/impl/MathExprImpl.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 MarkLogic Corporation
+ * Copyright (c) 2023 MarkLogic Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/marklogic-client-api/src/main/java/com/marklogic/client/impl/PlanBuilderImpl.java b/marklogic-client-api/src/main/java/com/marklogic/client/impl/PlanBuilderImpl.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 MarkLogic Corporation
+ * Copyright (c) 2023 MarkLogic Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/marklogic-client-api/src/main/java/com/marklogic/client/impl/RdfExprImpl.java b/marklogic-client-api/src/main/java/com/marklogic/client/impl/RdfExprImpl.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 MarkLogic Corporation
+ * Copyright (c) 2023 MarkLogic Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/marklogic-client-api/src/main/java/com/marklogic/client/impl/SemExprImpl.java b/marklogic-client-api/src/main/java/com/marklogic/client/impl/SemExprImpl.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 MarkLogic Corporation
+ * Copyright (c) 2023 MarkLogic Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/marklogic-client-api/src/main/java/com/marklogic/client/impl/SpellExprImpl.java b/marklogic-client-api/src/main/java/com/marklogic/client/impl/SpellExprImpl.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 MarkLogic Corporation
+ * Copyright (c) 2023 MarkLogic Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/marklogic-client-api/src/main/java/com/marklogic/client/impl/SqlExprImpl.java b/marklogic-client-api/src/main/java/com/marklogic/client/impl/SqlExprImpl.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 MarkLogic Corporation
+ * Copyright (c) 2023 MarkLogic Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/marklogic-client-api/src/main/java/com/marklogic/client/impl/XdmpExprImpl.java b/marklogic-client-api/src/main/java/com/marklogic/client/impl/XdmpExprImpl.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 MarkLogic Corporation
+ * Copyright (c) 2023 MarkLogic Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/marklogic-client-api/src/main/java/com/marklogic/client/impl/XsExprImpl.java b/marklogic-client-api/src/main/java/com/marklogic/client/impl/XsExprImpl.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 MarkLogic Corporation
+ * Copyright (c) 2023 MarkLogic Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/marklogic-client-api/src/test/java/com/marklogic/client/test/PlanGeneratedTest.java b/marklogic-client-api/src/test/java/com/marklogic/client/test/PlanGeneratedTest.java

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Copyright (c) 2022 MarkLogic Corporation`
	`2`	`+ * Copyright (c) 2023 MarkLogic Corporation`
`3`	`3`	`*`
`4`	`4`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`* you may not use this file except in compliance with the License.`