#1317

Author: ehennum

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

@@ -379,7 +379,7 @@ public interface FnExpr {
   */
   public ServerExpression count(ServerExpression arg, ServerExpression maximum);
 /**
-  * Returns xs:date(fn:current-dateTime()). This is an xs:date (with timezone) that is current at some time during the evaluation of a query or transformation in which fn:current-date() is executed. This function is *stable*. The precise instant during the query or transformation represented by the value of fn:current-date() is *implementation dependent*.
+  * Returns xs:date(fn:current-dateTime()) . This is an xs:date (with timezone) that is current at some time during the evaluation of a query or transformation in which fn:current-date() is executed. This function is *stable*. The precise instant during the query or transformation represented by the value of fn:current-date() is *implementation dependent*.
   *
   * <a name="ml-server-type-current-date"></a>
   
@@ -399,7 +399,7 @@ public interface FnExpr {
   */
   public ServerExpression currentDateTime();
 /**
-  * Returns xs:time(fn:current-dateTime()). This is an xs:time (with timezone) that is current at some time during the evaluation of a query or transformation in which fn:current-time() is executed. This function is *stable*. The precise instant during the query or transformation represented by the value of fn:current-time() is *implementation dependent*.
+  * Returns xs:time(fn:current-dateTime()) . This is an xs:time (with timezone) that is current at some time during the evaluation of a query or transformation in which fn:current-time() is executed. This function is *stable*. The precise instant during the query or transformation represented by the value of fn:current-time() is *implementation dependent*.
   *
   * <a name="ml-server-type-current-time"></a>
   
@@ -1922,7 +1922,7 @@ public interface FnExpr {
   * <p>
   * Provides a client interface to the <a href="http://docs.marklogic.com/fn:sum" target="mlserverdoc">fn:sum</a> server function.
   * @param arg  The sequence of values to be summed.  (of <a href="{@docRoot}/doc-files/types/xs_anyAtomicType.html">xs:anyAtomicType</a>)
-  * @param zero  The value to return as zero if the input sequence is the empty sequence. This parameter is not available in the 0.9-ml XQuery dialect.  (of <a href="{@docRoot}/doc-files/types/xs_anyAtomicType.html">xs:anyAtomicType</a>)
+  * @param zero  The value to return as zero if the input sequence is the empty sequence.  (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_anyAtomicType.html">xs:anyAtomicType</a> server data type
   */
   public ServerExpression sum(ServerExpression arg, String zero);
@@ -1931,7 +1931,7 @@ public interface FnExpr {
   * <p>
   * Provides a client interface to the <a href="http://docs.marklogic.com/fn:sum" target="mlserverdoc">fn:sum</a> server function.
   * @param arg  The sequence of values to be summed.  (of <a href="{@docRoot}/doc-files/types/xs_anyAtomicType.html">xs:anyAtomicType</a>)
-  * @param zero  The value to return as zero if the input sequence is the empty sequence. This parameter is not available in the 0.9-ml XQuery dialect.  (of <a href="{@docRoot}/doc-files/types/xs_anyAtomicType.html">xs:anyAtomicType</a>)
+  * @param zero  The value to return as zero if the input sequence is the empty sequence.  (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_anyAtomicType.html">xs:anyAtomicType</a> server data type
   */
   public ServerExpression sum(ServerExpression arg, ServerExpression zero);

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

@@ -66,7 +66,7 @@ public interface MathExpr {
   */
   public ServerExpression atan(ServerExpression x);
 /**
-  * Returns the arc tangent of y/x, in radians, in the range from -pi/2 to +pi/2 (inclusive), using the signs of y and x to determine the appropriate quadrant.
+  * Returns the arc tangent of y/x, in radians, in the range from -pi/2 to +pi/2 (inclusive), using the signs of y and x to determine the apropriate quadrant.
   * <p>
   * Provides a client interface to the <a href="http://docs.marklogic.com/math:atan2" target="mlserverdoc">math:atan2</a> server function.
   * @param y  The floating point dividend.  (of <a href="{@docRoot}/doc-files/types/xs_double.html">xs:double</a>)
@@ -75,7 +75,7 @@ public interface MathExpr {
   */
   public ServerExpression atan2(ServerExpression y, double x);
 /**
-  * Returns the arc tangent of y/x, in radians, in the range from -pi/2 to +pi/2 (inclusive), using the signs of y and x to determine the appropriate quadrant.
+  * Returns the arc tangent of y/x, in radians, in the range from -pi/2 to +pi/2 (inclusive), using the signs of y and x to determine the apropriate quadrant.
   *
   * <a name="ml-server-type-atan2"></a>
   

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

@@ -1279,14 +1279,14 @@ public interface ExportablePlan extends Plan, PlanBuilderBase.ExportablePlanBase
   public interface ModifyPlan extends PreparePlan, PlanBuilderBase.ModifyPlanBase {
 public abstract ModifyPlan bind(PlanExprColSeq columns);
 /**
-  * This function adds a column based on an expression without altering the existing columns in the row set.
+  * This function is deprecated in favor of the bind() function and will not be supported in MarkLogic 11. This function adds a column based on an expression without altering the existing columns in the row set.
   * @param column  The name of the column to be defined.
   * @param expression  The expression that specifies the value the column in the row.  (of <a href="{@docRoot}/doc-files/types/item.html">item</a>)
   * @return  a ModifyPlan object
   */
   public abstract ModifyPlan bindAs(String column, ServerExpression expression);
 /**
-  * This function adds a column based on an expression without altering the existing columns in the row set.
+  * This function is deprecated in favor of the bind() function and will not be supported in MarkLogic 11. This function adds a column based on an expression without altering the existing columns in the row set.
   * @param column  The name of the column to be defined.
   * @param expression  The expression that specifies the value the column in the row.  (of <a href="{@docRoot}/doc-files/types/item.html">item</a>)
   * @return  a ModifyPlan object

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

@@ -15,6 +15,7 @@
  */
 package com.marklogic.client.expression;
 
+import com.marklogic.client.type.XsAnyAtomicTypeSeqVal;
 import com.marklogic.client.type.XsAnyAtomicTypeVal;
 import com.marklogic.client.type.XsBooleanVal;
 import com.marklogic.client.type.XsDecimalVal;
@@ -44,6 +45,47 @@ public interface SqlExpr {
   * @return  a server expression with the <a href="{@docRoot}/doc-files/types/xs_integer.html">xs:integer</a> server data type
   */
   public ServerExpression bitLength(ServerExpression str);
+/**
+  * Returns an integer specifying the index of the bucket the second parameter belongs to in buckets formed by the first parameter. Values that lie on the edge of a bucket fall to the lesser index.
+  * <p>
+  * Provides a client interface to the <a href="http://docs.marklogic.com/sql:bucket" target="mlserverdoc">sql:bucket</a> server function.
+  * @param bucketEdgesParam  A sequence of ordered values indicating the edges of a collection of buckets.  (of <a href="{@docRoot}/doc-files/types/xs_anyAtomicType.html">xs:anyAtomicType</a>)
+  * @param srchParam  A value to find an index for in the bucket edge list.  (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_unsignedLong.html">xs:unsignedLong</a> server data type
+  */
+  public ServerExpression bucket(ServerExpression bucketEdgesParam, String srchParam);
+/**
+  * Returns an integer specifying the index of the bucket the second parameter belongs to in buckets formed by the first parameter. Values that lie on the edge of a bucket fall to the lesser index.
+  *
+  * <a name="ml-server-type-bucket"></a>
+  
+  * <p>
+  * Provides a client interface to the <a href="http://docs.marklogic.com/sql:bucket" target="mlserverdoc">sql:bucket</a> server function.
+  * @param bucketEdgesParam  A sequence of ordered values indicating the edges of a collection of buckets.  (of <a href="{@docRoot}/doc-files/types/xs_anyAtomicType.html">xs:anyAtomicType</a>)
+  * @param srchParam  A value to find an index for in the bucket edge list.  (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_unsignedLong.html">xs:unsignedLong</a> server data type
+  */
+  public ServerExpression bucket(ServerExpression bucketEdgesParam, ServerExpression srchParam);
+/**
+  * Returns an integer specifying the index of the bucket the second parameter belongs to in buckets formed by the first parameter. Values that lie on the edge of a bucket fall to the lesser index.
+  * <p>
+  * Provides a client interface to the <a href="http://docs.marklogic.com/sql:bucket" target="mlserverdoc">sql:bucket</a> server function.
+  * @param bucketEdgesParam  A sequence of ordered values indicating the edges of a collection of buckets.  (of <a href="{@docRoot}/doc-files/types/xs_anyAtomicType.html">xs:anyAtomicType</a>)
+  * @param srchParam  A value to find an index for in the bucket edge list.  (of <a href="{@docRoot}/doc-files/types/xs_anyAtomicType.html">xs:anyAtomicType</a>)
+  * @param collationLiteral  A collation identifier.  (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_unsignedLong.html">xs:unsignedLong</a> server data type
+  */
+  public ServerExpression bucket(ServerExpression bucketEdgesParam, String srchParam, String collationLiteral);
+/**
+  * Returns an integer specifying the index of the bucket the second parameter belongs to in buckets formed by the first parameter. Values that lie on the edge of a bucket fall to the lesser index.
+  * <p>
+  * Provides a client interface to the <a href="http://docs.marklogic.com/sql:bucket" target="mlserverdoc">sql:bucket</a> server function.
+  * @param bucketEdgesParam  A sequence of ordered values indicating the edges of a collection of buckets.  (of <a href="{@docRoot}/doc-files/types/xs_anyAtomicType.html">xs:anyAtomicType</a>)
+  * @param srchParam  A value to find an index for in the bucket edge list.  (of <a href="{@docRoot}/doc-files/types/xs_anyAtomicType.html">xs:anyAtomicType</a>)
+  * @param collationLiteral  A collation identifier.  (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_unsignedLong.html">xs:unsignedLong</a> server data type
+  */
+  public ServerExpression bucket(ServerExpression bucketEdgesParam, ServerExpression srchParam, ServerExpression collationLiteral);
 /**
   * Returns an rdf:collatedString value with the given value and collation tag. The rdf:collatedString type extends xs:string , and represents a collation tagged string in RDF. 
   * <p>
@@ -229,7 +271,7 @@ public interface SqlExpr {
   * Returns a string that is the leftmost characters of the target string. The number of characters to return is specified by the second argument.
   * <p>
   * Provides a client interface to the <a href="http://docs.marklogic.com/sql:left" target="mlserverdoc">sql:left</a> server function.
-  * @param str  The base string. If the value is not a string, its string value will be used.  (of <a href="{@docRoot}/doc-files/types/item.html">item</a>)
+  * @param str  The base string. If the value is not a string, its string value will be used.  (of <a href="{@docRoot}/doc-files/types/xs_anyAtomicType.html">xs:anyAtomicType</a>)
   * @param n  The number of leftmost characters of the string to return.  (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/xs_string.html">xs:string</a> server data type
   */
@@ -241,7 +283,7 @@ public interface SqlExpr {
   
   * <p>
   * Provides a client interface to the <a href="http://docs.marklogic.com/sql:left" target="mlserverdoc">sql:left</a> server function.
-  * @param str  The base string. If the value is not a string, its string value will be used.  (of <a href="{@docRoot}/doc-files/types/item.html">item</a>)
+  * @param str  The base string. If the value is not a string, its string value will be used.  (of <a href="{@docRoot}/doc-files/types/xs_anyAtomicType.html">xs:anyAtomicType</a>)
   * @param n  The number of leftmost characters of the string to return.  (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/xs_string.html">xs:string</a> server data type
   */
@@ -401,7 +443,7 @@ public interface SqlExpr {
   * Returns a string that is the rightmost characters of the target string. The number of characters to return is specified by the second argument.
   * <p>
   * Provides a client interface to the <a href="http://docs.marklogic.com/sql:right" target="mlserverdoc">sql:right</a> server function.
-  * @param str  The base string. If the value is not a string, its string value will be used.  (of <a href="{@docRoot}/doc-files/types/item.html">item</a>)
+  * @param str  The base string. If the value is not a string, its string value will be used.  (of <a href="{@docRoot}/doc-files/types/xs_anyAtomicType.html">xs:anyAtomicType</a>)
   * @param n  The number of rightmost characters of the string to return.  (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/xs_string.html">xs:string</a> server data type
   */
@@ -413,7 +455,7 @@ public interface SqlExpr {
   
   * <p>
   * Provides a client interface to the <a href="http://docs.marklogic.com/sql:right" target="mlserverdoc">sql:right</a> server function.
-  * @param str  The base string. If the value is not a string, its string value will be used.  (of <a href="{@docRoot}/doc-files/types/item.html">item</a>)
+  * @param str  The base string. If the value is not a string, its string value will be used.  (of <a href="{@docRoot}/doc-files/types/xs_anyAtomicType.html">xs:anyAtomicType</a>)
   * @param n  The number of rightmost characters of the string to return.  (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/xs_string.html">xs:string</a> server data type
   */

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

@@ -249,6 +249,90 @@ public CtsReferenceExpr collectionReference(ServerExpression options) {
   }
 
 
+  @Override
+  public CtsQueryExpr columnRangeQuery(String schema, String view, String column, String value) {
+    return columnRangeQuery((schema == null) ? (XsStringVal) null : xs.string(schema), (view == null) ? (XsStringVal) null : xs.string(view), (column == null) ? (XsStringVal) null : xs.string(column), (value == null) ? (XsAnyAtomicTypeVal) null : xs.string(value));
+  }
+
+  
+  @Override
+  public CtsQueryExpr columnRangeQuery(ServerExpression schema, ServerExpression view, ServerExpression column, ServerExpression value) {
+    if (schema == null) {
+      throw new IllegalArgumentException("schema parameter for columnRangeQuery() cannot be null");
+    }
+    if (view == null) {
+      throw new IllegalArgumentException("view parameter for columnRangeQuery() cannot be null");
+    }
+    if (column == null) {
+      throw new IllegalArgumentException("column parameter for columnRangeQuery() cannot be null");
+    }
+    return new QueryCallImpl("cts", "column-range-query", new Object[]{ schema, view, column, value });
+  }
+
+  
+  @Override
+  public CtsQueryExpr columnRangeQuery(String schema, String view, String column, String value, String operator) {
+    return columnRangeQuery((schema == null) ? (XsStringVal) null : xs.string(schema), (view == null) ? (XsStringVal) null : xs.string(view), (column == null) ? (XsStringVal) null : xs.string(column), (value == null) ? (XsAnyAtomicTypeVal) null : xs.string(value), (operator == null) ? (XsStringVal) null : xs.string(operator));
+  }
+
+  
+  @Override
+  public CtsQueryExpr columnRangeQuery(ServerExpression schema, ServerExpression view, ServerExpression column, ServerExpression value, ServerExpression operator) {
+    if (schema == null) {
+      throw new IllegalArgumentException("schema parameter for columnRangeQuery() cannot be null");
+    }
+    if (view == null) {
+      throw new IllegalArgumentException("view parameter for columnRangeQuery() cannot be null");
+    }
+    if (column == null) {
+      throw new IllegalArgumentException("column parameter for columnRangeQuery() cannot be null");
+    }
+    return new QueryCallImpl("cts", "column-range-query", new Object[]{ schema, view, column, value, operator });
+  }
+
+  
+  @Override
+  public CtsQueryExpr columnRangeQuery(String schema, String view, String column, String value, String operator, String... options) {
+    return columnRangeQuery((schema == null) ? (XsStringVal) null : xs.string(schema), (view == null) ? (XsStringVal) null : xs.string(view), (column == null) ? (XsStringVal) null : xs.string(column), (value == null) ? (XsAnyAtomicTypeVal) null : xs.string(value), (operator == null) ? (XsStringVal) null : xs.string(operator), (options == null) ? (XsStringVal) null : xs.stringSeq(options));
+  }
+
+  
+  @Override
+  public CtsQueryExpr columnRangeQuery(ServerExpression schema, ServerExpression view, ServerExpression column, ServerExpression value, ServerExpression operator, ServerExpression options) {
+    if (schema == null) {
+      throw new IllegalArgumentException("schema parameter for columnRangeQuery() cannot be null");
+    }
+    if (view == null) {
+      throw new IllegalArgumentException("view parameter for columnRangeQuery() cannot be null");
+    }
+    if (column == null) {
+      throw new IllegalArgumentException("column parameter for columnRangeQuery() cannot be null");
+    }
+    return new QueryCallImpl("cts", "column-range-query", new Object[]{ schema, view, column, value, operator, options });
+  }
+
+  
+  @Override
+  public CtsQueryExpr columnRangeQuery(String schema, String view, String column, String value, String operator, String options, double weight) {
+    return columnRangeQuery((schema == null) ? (XsStringVal) null : xs.string(schema), (view == null) ? (XsStringVal) null : xs.string(view), (column == null) ? (XsStringVal) null : xs.string(column), (value == null) ? (XsAnyAtomicTypeVal) null : xs.string(value), (operator == null) ? (XsStringVal) null : xs.string(operator), (options == null) ? (XsStringVal) null : xs.string(options), xs.doubleVal(weight));
+  }
+
+  
+  @Override
+  public CtsQueryExpr columnRangeQuery(ServerExpression schema, ServerExpression view, ServerExpression column, ServerExpression value, ServerExpression operator, ServerExpression options, ServerExpression weight) {
+    if (schema == null) {
+      throw new IllegalArgumentException("schema parameter for columnRangeQuery() cannot be null");
+    }
+    if (view == null) {
+      throw new IllegalArgumentException("view parameter for columnRangeQuery() cannot be null");
+    }
+    if (column == null) {
+      throw new IllegalArgumentException("column parameter for columnRangeQuery() cannot be null");
+    }
+    return new QueryCallImpl("cts", "column-range-query", new Object[]{ schema, view, column, value, operator, options, weight });
+  }
+
+  
   @Override
   public CtsPolygonExpr complexPolygon(ServerExpression outer, ServerExpression inner) {
     if (outer == null) {
@@ -1781,7 +1865,7 @@ public ServerExpression pointLongitude(ServerExpression point) {
     return new XsExprImpl.NumericCallImpl("cts", "point-longitude", new Object[]{ point });
   }
 
-  
+
   @Override
   public CtsPolygonExpr polygon(ServerExpression vertices) {
     return new PolygonCallImpl("cts", "polygon", new Object[]{ vertices });