| Package | Description |
|---|---|
| com.marklogic.client.expression |
The package provides classes for building Optic plan pipelines and expressions for execution on the REST server.
|
| com.marklogic.client.type |
The package provides interfaces specifying the type of an expression or value as passed to a
PlanBuilder method or returned from a RowRecord method. |
| Modifier and Type | Method and Description |
|---|---|
XsNumericExpr |
FnExpr.abs(XsNumericExpr arg)
Returns the absolute value of arg.
|
abstract XsNumericExpr |
PlanBuilder.add(XsNumericExpr... left)
This function returns the sum of the specified numeric expressions.
|
XsNumericExpr |
FnExpr.ceiling(XsNumericExpr arg)
Returns the smallest (closest to negative infinity) number with no fractional part that is not less than the value of arg.
|
abstract XsNumericExpr |
PlanBuilder.divide(XsNumericExpr left,
XsNumericExpr right)
This function divides the left
numericExpression by the right numericExpression and returns the value. |
XsNumericExpr |
FnExpr.floor(XsNumericExpr arg)
Returns the largest (closest to positive infinity) number with no fractional part that is not greater than the value of arg.
|
abstract XsNumericExpr |
PlanBuilder.modulo(double left,
double right)
This function returns the remainder afer the division of the dividend and divisor expressions.
|
abstract XsNumericExpr |
PlanBuilder.modulo(XsNumericExpr left,
XsNumericExpr right)
This function returns the remainder afer the division of the dividend and divisor expressions.
|
abstract XsNumericExpr |
PlanBuilder.multiply(XsNumericExpr... left)
This function multipies the left
numericExpression by the right numericExpression and returns the value. |
XsNumericExpr |
XsExpr.numeric(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:numeric server data type.
|
XsNumericExpr |
FnExpr.round(XsNumericExpr arg)
Returns the number with no fractional part that is closest to the argument.
|
XsNumericExpr |
FnExpr.roundHalfToEven(XsNumericExpr arg)
The value returned is the nearest (that is, numerically closest) numeric to arg that is a multiple of ten to the power of minus precision.
|
XsNumericExpr |
FnExpr.roundHalfToEven(XsNumericExpr arg,
long precision)
The value returned is the nearest (that is, numerically closest) numeric to arg that is a multiple of ten to the power of minus precision.
|
XsNumericExpr |
FnExpr.roundHalfToEven(XsNumericExpr arg,
XsIntegerExpr precision)
The value returned is the nearest (that is, numerically closest) numeric to arg that is a multiple of ten to the power of minus precision.
|
abstract XsNumericExpr |
PlanBuilder.subtract(XsNumericExpr left,
XsNumericExpr right)
This function subtracts the right
numericExpression from the left numericExpression and returns the value. |
XsNumericExpr |
MathExpr.trunc(XsNumericExpr arg)
Returns the number truncated to a certain number of decimal places.
|
XsNumericExpr |
MathExpr.trunc(XsNumericExpr arg,
long n)
Returns the number truncated to a certain number of decimal places.
|
XsNumericExpr |
MathExpr.trunc(XsNumericExpr arg,
XsIntegerExpr n)
Returns the number truncated to a certain number of decimal places.
|
| Modifier and Type | Method and Description |
|---|---|
XsNumericExpr |
FnExpr.abs(XsNumericExpr arg)
Returns the absolute value of arg.
|
abstract XsNumericExpr |
PlanBuilder.add(XsNumericExpr... left)
This function returns the sum of the specified numeric expressions.
|
XsNumericExpr |
FnExpr.ceiling(XsNumericExpr arg)
Returns the smallest (closest to negative infinity) number with no fractional part that is not less than the value of arg.
|
abstract XsNumericExpr |
PlanBuilder.divide(XsNumericExpr left,
XsNumericExpr right)
This function divides the left
numericExpression by the right numericExpression and returns the value. |
XsNumericExpr |
FnExpr.floor(XsNumericExpr arg)
Returns the largest (closest to positive infinity) number with no fractional part that is not greater than the value of arg.
|
XsStringExpr |
XdmpExpr.formatNumber(XsNumericExpr... value)
Returns a formatted number value based on the picture argument.
|
XsStringExpr |
SqlExpr.insert(XsStringExpr str,
XsNumericExpr start,
XsNumericExpr length,
XsStringExpr str2)
Returns a string that that is the first argument with length characters removed starting at start and the second string has been inserted beginning at start.
|
abstract NumberNodeExpr |
PlanBuilder.jsonNumber(XsNumericExpr value)
This function constructs a JSON number node with the specified value.
|
XsStringExpr |
SqlExpr.left(ItemSeqExpr str,
XsNumericExpr n)
Returns a string that is the leftmost characters of the target string.
|
abstract XsNumericExpr |
PlanBuilder.modulo(XsNumericExpr left,
XsNumericExpr right)
This function returns the remainder afer the division of the dividend and divisor expressions.
|
abstract XsNumericExpr |
PlanBuilder.multiply(XsNumericExpr... left)
This function multipies the left
numericExpression by the right numericExpression and returns the value. |
XsNumericSeqExpr |
XsExpr.numericSeq(XsNumericExpr... items)
Constructs a sequence of XsNumericExpr items.
|
XsStringExpr |
SqlExpr.repeat(ItemSeqExpr str,
XsNumericExpr n)
Returns a string that concatenates the first argument as many times as specified by the second argument.
|
XsStringExpr |
SqlExpr.right(ItemSeqExpr str,
XsNumericExpr n)
Returns a string that is the rightmost characters of the target string.
|
XsNumericExpr |
FnExpr.round(XsNumericExpr arg)
Returns the number with no fractional part that is closest to the argument.
|
XsNumericExpr |
FnExpr.roundHalfToEven(XsNumericExpr arg)
The value returned is the nearest (that is, numerically closest) numeric to arg that is a multiple of ten to the power of minus precision.
|
XsNumericExpr |
FnExpr.roundHalfToEven(XsNumericExpr arg,
long precision)
The value returned is the nearest (that is, numerically closest) numeric to arg that is a multiple of ten to the power of minus precision.
|
XsNumericExpr |
FnExpr.roundHalfToEven(XsNumericExpr arg,
XsIntegerExpr precision)
The value returned is the nearest (that is, numerically closest) numeric to arg that is a multiple of ten to the power of minus precision.
|
ItemSeqExpr |
SqlExpr.sign(XsNumericExpr x)
Returns the sign of number x.
|
XsStringExpr |
SqlExpr.space(XsNumericExpr n)
Returns a string that is the given number of spaces.
|
JsonArrayExpr |
JsonExpr.subarray(JsonArrayExpr array,
XsNumericExpr startingLoc)
Extract a subarray from an array, producing a new array.
|
JsonArrayExpr |
JsonExpr.subarray(JsonArrayExpr array,
XsNumericExpr startingLoc,
XsNumericExpr length)
Extract a subarray from an array, producing a new array.
|
ItemSeqExpr |
FnExpr.subsequence(ItemSeqExpr sourceSeq,
XsNumericExpr startingLoc)
Returns the contiguous sequence of items in the value of sourceSeq beginning at the position indicated by the value of startingLoc and continuing for the number of items indicated by the value of length.
|
ItemSeqExpr |
FnExpr.subsequence(ItemSeqExpr sourceSeq,
XsNumericExpr startingLoc,
XsNumericExpr length)
Returns the contiguous sequence of items in the value of sourceSeq beginning at the position indicated by the value of startingLoc and continuing for the number of items indicated by the value of length.
|
XsStringExpr |
FnExpr.substring(XsStringExpr sourceString,
XsNumericExpr startingLoc)
Returns a substring starting from the startingLoc and continuing for length characters.
|
XsStringExpr |
FnExpr.substring(XsStringExpr sourceString,
XsNumericExpr startingLoc,
XsNumericExpr length)
Returns a substring starting from the startingLoc and continuing for length characters.
|
abstract XsNumericExpr |
PlanBuilder.subtract(XsNumericExpr left,
XsNumericExpr right)
This function subtracts the right
numericExpression from the left numericExpression and returns the value. |
JsonArrayExpr |
JsonExpr.toArray(ItemSeqExpr items,
XsNumericExpr limit)
Constructs an array from a sequence of items.
|
JsonArrayExpr |
JsonExpr.toArray(ItemSeqExpr items,
XsNumericExpr limit,
ItemExpr zero)
Constructs an array from a sequence of items.
|
XsNumericExpr |
MathExpr.trunc(XsNumericExpr arg)
Returns the number truncated to a certain number of decimal places.
|
XsNumericExpr |
MathExpr.trunc(XsNumericExpr arg,
long n)
Returns the number truncated to a certain number of decimal places.
|
XsNumericExpr |
MathExpr.trunc(XsNumericExpr arg,
XsIntegerExpr n)
Returns the number truncated to a certain number of decimal places.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
PlanColumn
An instance of a column expression returned by a col() call in a row pipeline.
|
interface |
PlanParamExpr
An instance of a placeholder parameter returned by a call to the param() function that can represent a literal value in expressions and can be passed on a bind() call to be assigned a literal value when invoking a row pipeline.
|
interface |
PlanSystemColumn
An instance of a fragment id, graph id, or other system column for a row pipeline.
|
interface |
XsByteExpr
An instance of a server byte expression.
|
interface |
XsByteVal
An instance of a server byte value.
|
interface |
XsDecimalExpr
An instance of a server decimal expression.
|
interface |
XsDecimalVal
An instance of a server decimal value.
|
interface |
XsDoubleExpr
An instance of a server double expression.
|
interface |
XsDoubleVal
An instance of a server double value.
|
interface |
XsFloatExpr
An instance of a server float expression.
|
interface |
XsFloatVal
An instance of a server float value.
|
interface |
XsIntegerExpr
An instance of a server integer expression.
|
interface |
XsIntegerVal
An instance of a server integer value.
|
interface |
XsIntExpr
An instance of a server int expression.
|
interface |
XsIntVal
An instance of a server int value.
|
interface |
XsLongExpr
An instance of a server long expression.
|
interface |
XsLongVal
An instance of a server long value.
|
interface |
XsNegativeIntegerExpr
An instance of a server negative integer expression.
|
interface |
XsNonNegativeIntegerExpr
An instance of a server non-negative integer expression.
|
interface |
XsNonNegativeIntegerVal
An instance of a server non-negative integer value.
|
interface |
XsNonPositiveIntegerExpr
An instance of a server non-positive integer expression.
|
interface |
XsNumericVal
An instance of a server numeric value.
|
interface |
XsPositiveIntegerExpr
An instance of a server positive integer expression.
|
interface |
XsShortExpr
An instance of a server short expression.
|
interface |
XsShortVal
An instance of a server short value.
|
interface |
XsUnsignedByteExpr
An instance of a server unsigned byte expression.
|
interface |
XsUnsignedByteVal
An instance of a server unsigned byte value.
|
interface |
XsUnsignedIntExpr
An instance of a server unsigned int expression.
|
interface |
XsUnsignedIntVal
An instance of a server unsigned int value.
|
interface |
XsUnsignedLongExpr
An instance of a server unsigned long expression.
|
interface |
XsUnsignedLongVal
An instance of a server unsigned long value.
|
interface |
XsUnsignedShortExpr
An instance of a server unsigned short expression.
|
interface |
XsUnsignedShortVal
An instance of a server unsigned short value.
|
Copyright © 2013-2017 MarkLogic Corporation.