relax parameters for expression casting on server #1263

Author: ehennum

marklogic-client-api/src/main/java/com/marklogic/client/expression/CtsExpr.java

@@ -175,13 +175,13 @@ protected PlanBuilder(
   */
   public abstract ServerExpression divide(ServerExpression left, ServerExpression right);
   /**
-  * This function returns true if the left and right expressions return the same value. Otherwise, it returns false. In expressions, the call should pass the result from an op:col function to identify a column.
+  * This function takes two or more expressions and returns true if all of the expressions return the same value. Otherwise, it returns false. The expressions can include calls to the op:col function to get the value of a column.
   * <p>
   * Provides a client interface to the <a href="http://docs.marklogic.com/op:eq" target="mlserverdoc">op:eq</a> server function.
-  * @param left  The left value expression.  (of <a href="{@docRoot}/doc-files/types/xs_anyAtomicType.html">xs:anyAtomicType</a>)
+  * @param operand  Two or more expressions.  (of <a href="{@docRoot}/doc-files/types/xs_anyAtomicType.html">xs:anyAtomicType</a>)
   * @return  a server expression with the <a href="{@docRoot}/doc-files/types/xs_boolean.html">xs:boolean</a> server data type
   */
-  public abstract ServerExpression eq(ServerExpression... left);
+  public abstract ServerExpression eq(ServerExpression... operand);
   /**
   * This function returns true if the value of the left expression is greater than or equal to the value of the right expression. Otherwise, it returns false.
   * <p>
@@ -981,14 +981,14 @@ protected PlanBuilder(
   */
   public abstract ServerExpression jsonDocument(ServerExpression root);
   /**
-  * This function specifies the key expression and value content for a JSON property of a JSON object contructed by the op:json-object function.
+  * This function specifies the key expression and value content for a JSON property of a JSON object constructed by the op:json-object function.
   * @param key  The key expression. This must evaluate to a string.  (of <a href="{@docRoot}/doc-files/types/xs_string.html">xs:string</a>)
   * @param value  The value content. This must be exactly one JSON node expression.  (of <a href="{@docRoot}/doc-files/types/json-content-node.html">json-content-node</a>)
   * @return  a PlanJsonProperty object
   */
   public abstract PlanJsonProperty prop(String key, ServerExpression value);
   /**
-  * This function specifies the key expression and value content for a JSON property of a JSON object contructed by the op:json-object function.
+  * This function specifies the key expression and value content for a JSON property of a JSON object constructed by the op:json-object function.
   * @param key  The key expression. This must evaluate to a string.  (of <a href="{@docRoot}/doc-files/types/xs_string.html">xs:string</a>)
   * @param value  The value content. This must be exactly one JSON node expression.  (of <a href="{@docRoot}/doc-files/types/json-content-node.html">json-content-node</a>)
   * @return  a PlanJsonProperty object

marklogic-client-api/src/main/java/com/marklogic/client/expression/GeoExpr.java

@@ -456,7 +456,7 @@ public interface SqlExpr {
   * <p>
   * Provides a client interface to the <a href="http://docs.marklogic.com/sql:sign" target="mlserverdoc">sql:sign</a> server function.
   * @param x  The number to be evaluated.  (of <a href="{@docRoot}/doc-files/types/xs_numeric.html">xs:numeric</a>)
-  * @return  a server expression with the <a href="{@docRoot}/doc-files/types/item.html">item</a> server data type
+  * @return  a server expression with the <a href="{@docRoot}/doc-files/types/xs_numeric.html">xs:numeric</a> server data type
   */
   public ServerExpression sign(ServerExpression x);
 /**

marklogic-client-api/src/main/java/com/marklogic/client/expression/PlanBuilder.java

@@ -268,11 +268,11 @@ public ServerExpression divide(ServerExpression left, ServerExpression right) {
 
 
   @Override
-  public ServerExpression eq(ServerExpression... left) {
-    if (left == null) {
-      throw new IllegalArgumentException("left parameter for eq() cannot be null");
+  public ServerExpression eq(ServerExpression... operand) {
+    if (operand == null) {
+      throw new IllegalArgumentException("operand parameter for eq() cannot be null");
     }
-    return new XsExprImpl.BooleanCallImpl("op", "eq", left);
+    return new XsExprImpl.BooleanCallImpl("op", "eq", operand);
   }
 
 

marklogic-client-api/src/main/java/com/marklogic/client/expression/SemExpr.java

@@ -208,7 +208,7 @@ public SemStoreExpr rulesetStore(String locations) {
 
 
   @Override
-  public SemStoreExpr rulesetStore(XsStringSeqVal locations) {
+  public SemStoreExpr rulesetStore(ServerExpression locations) {
     return new StoreCallImpl("sem", "ruleset-store", new Object[]{ locations });
   }
 
@@ -220,19 +220,19 @@ public SemStoreExpr rulesetStore(String locations, SemStoreExpr... store) {
 
 
   @Override
-  public SemStoreExpr rulesetStore(XsStringSeqVal locations, SemStoreSeqExpr store) {
+  public SemStoreExpr rulesetStore(ServerExpression locations, ServerExpression store) {
     return new StoreCallImpl("sem", "ruleset-store", new Object[]{ locations, store });
   }
 
 
   @Override
-  public SemStoreExpr rulesetStore(String locations, SemStoreSeqExpr store, String options) {
+  public SemStoreExpr rulesetStore(String locations, ServerExpression store, String options) {
     return rulesetStore((locations == null) ? (XsStringVal) null : xs.string(locations), store, (options == null) ? (XsStringVal) null : xs.string(options));
   }
 
 
   @Override
-  public SemStoreExpr rulesetStore(XsStringSeqVal locations, SemStoreSeqExpr store, XsStringSeqVal options) {
+  public SemStoreExpr rulesetStore(ServerExpression locations, ServerExpression store, ServerExpression options) {
     return new StoreCallImpl("sem", "ruleset-store", new Object[]{ locations, store, options });
   }
 
@@ -268,19 +268,19 @@ public SemStoreExpr store(String options) {
 
 
   @Override
-  public SemStoreExpr store(XsStringSeqVal options) {
+  public SemStoreExpr store(ServerExpression options) {
     return new StoreCallImpl("sem", "store", new Object[]{ options });
   }
 
 
   @Override
-  public SemStoreExpr store(String options, CtsQueryExpr query) {
+  public SemStoreExpr store(String options, ServerExpression query) {
     return store((options == null) ? (XsStringVal) null : xs.string(options), query);
   }
 
 
   @Override
-  public SemStoreExpr store(XsStringSeqVal options, CtsQueryExpr query) {
+  public SemStoreExpr store(ServerExpression options, ServerExpression query) {
     return new StoreCallImpl("sem", "store", new Object[]{ options, query });
   }
 

marklogic-client-api/src/main/java/com/marklogic/client/expression/SqlExpr.java

@@ -72,30 +72,12 @@ public ServerExpression dateadd(ServerExpression datepart, int number, ServerExp
 
   @Override
   public ServerExpression dateadd(ServerExpression datepart, ServerExpression number, ServerExpression date) {
-    if (datepart == null) {
-      throw new IllegalArgumentException("datepart parameter for dateadd() cannot be null");
-    }
-    if (number == null) {
-      throw new IllegalArgumentException("number parameter for dateadd() cannot be null");
-    }
-    if (date == null) {
-      throw new IllegalArgumentException("date parameter for dateadd() cannot be null");
-    }
     return new BaseTypeImpl.ItemCallImpl("sql", "dateadd", new Object[]{ datepart, number, date });
   }
 
 
   @Override
   public ServerExpression datediff(ServerExpression datepart, ServerExpression startdate, ServerExpression enddate) {
-    if (datepart == null) {
-      throw new IllegalArgumentException("datepart parameter for datediff() cannot be null");
-    }
-    if (startdate == null) {
-      throw new IllegalArgumentException("startdate parameter for datediff() cannot be null");
-    }
-    if (enddate == null) {
-      throw new IllegalArgumentException("enddate parameter for datediff() cannot be null");
-    }
     return new XsExprImpl.IntegerCallImpl("sql", "datediff", new Object[]{ datepart, startdate, enddate });
   }
 
@@ -201,9 +183,6 @@ public ServerExpression left(ServerExpression str, double n) {
 
   @Override
   public ServerExpression left(ServerExpression str, ServerExpression n) {
-    if (n == null) {
-      throw new IllegalArgumentException("n parameter for left() cannot be null");
-    }
     return new XsExprImpl.StringCallImpl("sql", "left", new Object[]{ str, n });
   }
 
@@ -243,9 +222,6 @@ public ServerExpression like(ServerExpression input, ServerExpression pattern, S
 
   @Override
   public ServerExpression ltrim(ServerExpression str) {
-    if (str == null) {
-      throw new IllegalArgumentException("str parameter for ltrim() cannot be null");
-    }
     return new XsExprImpl.StringCallImpl("sql", "ltrim", new Object[]{ str });
   }
 
@@ -318,9 +294,6 @@ public ServerExpression right(ServerExpression str, double n) {
 
   @Override
   public ServerExpression right(ServerExpression str, ServerExpression n) {
-    if (n == null) {
-      throw new IllegalArgumentException("n parameter for right() cannot be null");
-    }
     return new XsExprImpl.StringCallImpl("sql", "right", new Object[]{ str, n });
   }
 
@@ -333,9 +306,6 @@ public ServerExpression rowID(ServerExpression arg1) {
 
   @Override
   public ServerExpression rtrim(ServerExpression str) {
-    if (str == null) {
-      throw new IllegalArgumentException("str parameter for rtrim() cannot be null");
-    }
     return new XsExprImpl.StringCallImpl("sql", "rtrim", new Object[]{ str });
   }
 
@@ -348,7 +318,7 @@ public ServerExpression seconds(ServerExpression arg) {
 
   @Override
   public ServerExpression sign(ServerExpression x) {
-    return new BaseTypeImpl.ItemSeqCallImpl("sql", "sign", new Object[]{ x });
+    return new XsExprImpl.NumericCallImpl("sql", "sign", new Object[]{ x });
   }
 
 
@@ -360,9 +330,6 @@ public ServerExpression soundex(ServerExpression arg) {
 
   @Override
   public ServerExpression space(ServerExpression n) {
-    if (n == null) {
-      throw new IllegalArgumentException("n parameter for space() cannot be null");
-    }
     return new XsExprImpl.StringCallImpl("sql", "space", new Object[]{ n });
   }
 
@@ -399,30 +366,12 @@ public ServerExpression timestampadd(ServerExpression dateTimeType, int value, S
 
   @Override
   public ServerExpression timestampadd(ServerExpression dateTimeType, ServerExpression value, ServerExpression timestamp) {
-    if (dateTimeType == null) {
-      throw new IllegalArgumentException("dateTimeType parameter for timestampadd() cannot be null");
-    }
-    if (value == null) {
-      throw new IllegalArgumentException("value parameter for timestampadd() cannot be null");
-    }
-    if (timestamp == null) {
-      throw new IllegalArgumentException("timestamp parameter for timestampadd() cannot be null");
-    }
     return new BaseTypeImpl.ItemCallImpl("sql", "timestampadd", new Object[]{ dateTimeType, value, timestamp });
   }
 
 
   @Override
   public ServerExpression timestampdiff(ServerExpression dateTimeType, ServerExpression timestamp1, ServerExpression timestamp2) {
-    if (dateTimeType == null) {
-      throw new IllegalArgumentException("dateTimeType parameter for timestampdiff() cannot be null");
-    }
-    if (timestamp1 == null) {
-      throw new IllegalArgumentException("timestamp1 parameter for timestampdiff() cannot be null");
-    }
-    if (timestamp2 == null) {
-      throw new IllegalArgumentException("timestamp2 parameter for timestampdiff() cannot be null");
-    }
     return new XsExprImpl.IntegerCallImpl("sql", "timestampdiff", new Object[]{ dateTimeType, timestamp1, timestamp2 });
   }
 

marklogic-client-api/src/main/java/com/marklogic/client/expression/XdmpExpr.java

@@ -21,5 +21,5 @@
  * An instance of a column expression returned by a col() call
  * in a row pipeline.
  */
-public interface PlanColumn extends PlanExprCol, ServerExpression, PlanTriplePosition, PlanColumnSeq {
+public interface PlanColumn extends PlanExprCol, PlanTriplePosition, PlanColumnSeq {
 }

marklogic-client-api/src/main/java/com/marklogic/client/impl/CtsExprImpl.java

@@ -21,5 +21,5 @@
  * A sequence of column expressions returned by col() calls
  * for a row pipeline.
  */
-public interface PlanColumnSeq extends PlanExprColSeq  {
+public interface PlanColumnSeq extends PlanExprColSeq, ServerExpression  {
 }

marklogic-client-api/src/main/java/com/marklogic/client/impl/GeoExprImpl.java

@@ -23,5 +23,5 @@
  * in expressions and can be passed on a bind() call to be
  * assigned a literal value when invoking a row pipeline.
  */
-public interface PlanParamExpr extends ServerExpression, PlanParamSeqExpr, PlanTriplePosition {
+public interface PlanParamExpr extends PlanParamSeqExpr, PlanTriplePosition {
 }

marklogic-client-api/src/main/java/com/marklogic/client/impl/PlanBuilderImpl.java

@@ -23,5 +23,5 @@
  * in expressions and can be passed on bind() calls to be
  * assigned literal values when invoking a row pipeline.
  */
-public interface PlanParamSeqExpr {
+public interface PlanParamSeqExpr extends ServerExpression {
 }

marklogic-client-api/src/main/java/com/marklogic/client/impl/SemExprImpl.java

@@ -18,6 +18,6 @@
 /**
  * A sequence of semantic store expressions.
  */
-public interface SemStoreSeqExpr {
+public interface SemStoreSeqExpr extends ServerExpression {
 
 }

marklogic-client-api/src/main/java/com/marklogic/client/impl/SqlExprImpl.java

@@ -21,9 +21,6 @@
 	    <td class="colLast"><span class="memberNameLink">cts:box</span>(<span><a href="xs_double.html">xs:double</a> <i>south</i></span>, <span><a href="xs_double.html">xs:double</a> <i>west</i></span>, <span><a href="xs_double.html">xs:double</a> <i>north</i></span>, <span><a href="xs_double.html">xs:double</a> <i>east</i></span>)</td>
 	    <td><a href="../../com/marklogic/client/expression/CtsExpr.html#ml-server-type-box">java</a></td>
 	  </tr>
-</table></div><br/><div class="summary"><h3>Supertypes</h3><table class="memberSummary" border="0" cellpadding="3" cellspacing="0"><tr class="altColor">
-	    <td><a href="item.html">item</a></td>
-	  </tr>
 </table></div><br/><div class="summary"><h3>Parameter Of</h3><table class="memberSummary" border="0" cellpadding="3" cellspacing="0"><tr>
 	    <th class="colFirst" scope="col">Server Return Type</th>
 	    <th class="colLast" scope="col">Server Function</th>

marklogic-client-api/src/main/java/com/marklogic/client/type/PlanColumn.java

@@ -6,11 +6,14 @@
   </head>
   <body><div class="topNav"><ul class="navList" title="Navigation">
 	<li><a href="../../overview-summary.html">Overview</a></li>
+	<li><a href="../../com/marklogic/client/expression/package-summary.html">Package</a></li>
 	<li><a href="../../deprecated-list.html">Deprecated</a></li>
 	<li><a href="../../index-all.html">Index</a></li>
 	<li><a href="../../help-doc.html">Help</a></li>
-      </ul></div><div class="header"><h2>cts:collection-reference Server Expression</h2></div><div class="contentContainer"><p>A server expression that returns a value of (or implicitly castable to) the cts:collection-reference server type.</p><br/><div class="summary"><h3>Implicit Cast To</h3><table class="memberSummary" border="0" cellpadding="3" cellspacing="0"><tr class="altColor">
+      </ul></div><div class="header"><h2>cts:collection-reference Server Expression</h2></div><div class="contentContainer"><p>A server expression that returns a value of (or implicitly castable to) the cts:collection-reference server type.
+For all server types, see the <a href="ml-server-type-tree.html">Server Expression Type Hierarchy</a>.</p><br/><div class="summary"><h3>Supertypes</h3><table class="memberSummary" border="0" cellpadding="3" cellspacing="0"><tr class="altColor">
 	    <td><a href="cts_reference.html">cts:reference</a></td>
+	    <td><a href="item.html">item</a></td>
 	  </tr>
 </table></div></div></body>
 </html>

marklogic-client-api/src/main/java/com/marklogic/client/type/PlanColumnSeq.java

@@ -6,11 +6,14 @@
   </head>
   <body><div class="topNav"><ul class="navList" title="Navigation">
 	<li><a href="../../overview-summary.html">Overview</a></li>
+	<li><a href="../../com/marklogic/client/expression/package-summary.html">Package</a></li>
 	<li><a href="../../deprecated-list.html">Deprecated</a></li>
 	<li><a href="../../index-all.html">Index</a></li>
 	<li><a href="../../help-doc.html">Help</a></li>
-      </ul></div><div class="header"><h2>cts:element-attribute-reference Server Expression</h2></div><div class="contentContainer"><p>A server expression that returns a value of (or implicitly castable to) the cts:element-attribute-reference server type.</p><br/><div class="summary"><h3>Implicit Cast To</h3><table class="memberSummary" border="0" cellpadding="3" cellspacing="0"><tr class="altColor">
+      </ul></div><div class="header"><h2>cts:element-attribute-reference Server Expression</h2></div><div class="contentContainer"><p>A server expression that returns a value of (or implicitly castable to) the cts:element-attribute-reference server type.
+For all server types, see the <a href="ml-server-type-tree.html">Server Expression Type Hierarchy</a>.</p><br/><div class="summary"><h3>Supertypes</h3><table class="memberSummary" border="0" cellpadding="3" cellspacing="0"><tr class="altColor">
 	    <td><a href="cts_reference.html">cts:reference</a></td>
+	    <td><a href="item.html">item</a></td>
 	  </tr>
 </table></div></div></body>
 </html>

marklogic-client-api/src/main/java/com/marklogic/client/type/PlanParamExpr.java

@@ -6,11 +6,14 @@
   </head>
   <body><div class="topNav"><ul class="navList" title="Navigation">
 	<li><a href="../../overview-summary.html">Overview</a></li>
+	<li><a href="../../com/marklogic/client/expression/package-summary.html">Package</a></li>
 	<li><a href="../../deprecated-list.html">Deprecated</a></li>
 	<li><a href="../../index-all.html">Index</a></li>
 	<li><a href="../../help-doc.html">Help</a></li>
-      </ul></div><div class="header"><h2>cts:element-reference Server Expression</h2></div><div class="contentContainer"><p>A server expression that returns a value of (or implicitly castable to) the cts:element-reference server type.</p><br/><div class="summary"><h3>Implicit Cast To</h3><table class="memberSummary" border="0" cellpadding="3" cellspacing="0"><tr class="altColor">
+      </ul></div><div class="header"><h2>cts:element-reference Server Expression</h2></div><div class="contentContainer"><p>A server expression that returns a value of (or implicitly castable to) the cts:element-reference server type.
+For all server types, see the <a href="ml-server-type-tree.html">Server Expression Type Hierarchy</a>.</p><br/><div class="summary"><h3>Supertypes</h3><table class="memberSummary" border="0" cellpadding="3" cellspacing="0"><tr class="altColor">
 	    <td><a href="cts_reference.html">cts:reference</a></td>
+	    <td><a href="item.html">item</a></td>
 	  </tr>
 </table></div></div></body>
 </html>

marklogic-client-api/src/main/java/com/marklogic/client/type/PlanParamSeqExpr.java

@@ -6,11 +6,14 @@
   </head>
   <body><div class="topNav"><ul class="navList" title="Navigation">
 	<li><a href="../../overview-summary.html">Overview</a></li>
+	<li><a href="../../com/marklogic/client/expression/package-summary.html">Package</a></li>
 	<li><a href="../../deprecated-list.html">Deprecated</a></li>
 	<li><a href="../../index-all.html">Index</a></li>
 	<li><a href="../../help-doc.html">Help</a></li>
-      </ul></div><div class="header"><h2>cts:field-reference Server Expression</h2></div><div class="contentContainer"><p>A server expression that returns a value of (or implicitly castable to) the cts:field-reference server type.</p><br/><div class="summary"><h3>Implicit Cast To</h3><table class="memberSummary" border="0" cellpadding="3" cellspacing="0"><tr class="altColor">
+      </ul></div><div class="header"><h2>cts:field-reference Server Expression</h2></div><div class="contentContainer"><p>A server expression that returns a value of (or implicitly castable to) the cts:field-reference server type.
+For all server types, see the <a href="ml-server-type-tree.html">Server Expression Type Hierarchy</a>.</p><br/><div class="summary"><h3>Supertypes</h3><table class="memberSummary" border="0" cellpadding="3" cellspacing="0"><tr class="altColor">
 	    <td><a href="cts_reference.html">cts:reference</a></td>
+	    <td><a href="item.html">item</a></td>
 	  </tr>
 </table></div></div></body>
 </html>