| 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 |
|---|---|
XsIntegerExpr |
SqlExpr.bitLength(XsStringExpr str)
Returns the length of the string “str” in bits.
|
XsIntegerExpr |
FnExpr.compare(XsStringExpr comparand1,
String comparand2)
Returns -1, 0, or 1, depending on whether the value of the comparand1 is respectively less than, equal to, or greater than the value of comparand2, according to the rules of the collation that is used.
|
XsIntegerExpr |
FnExpr.compare(XsStringExpr comparand1,
String comparand2,
String collation)
Returns -1, 0, or 1, depending on whether the value of the comparand1 is respectively less than, equal to, or greater than the value of comparand2, according to the rules of the collation that is used.
|
XsIntegerExpr |
FnExpr.compare(XsStringExpr comparand1,
XsStringExpr comparand2)
Returns -1, 0, or 1, depending on whether the value of the comparand1 is respectively less than, equal to, or greater than the value of comparand2, according to the rules of the collation that is used.
|
XsIntegerExpr |
FnExpr.compare(XsStringExpr comparand1,
XsStringExpr comparand2,
XsStringExpr collation)
Returns -1, 0, or 1, depending on whether the value of the comparand1 is respectively less than, equal to, or greater than the value of comparand2, according to the rules of the collation that is used.
|
XsIntegerExpr |
FnExpr.count(ItemSeqExpr arg)
Returns the number of items in the value of arg.
|
XsIntegerExpr |
FnExpr.count(ItemSeqExpr arg,
double maximum)
Returns the number of items in the value of arg.
|
XsIntegerExpr |
FnExpr.count(ItemSeqExpr arg,
XsDoubleExpr maximum)
Returns the number of items in the value of arg.
|
XsIntegerExpr |
SqlExpr.datediff(XsStringExpr datepart,
ItemExpr startdate,
ItemExpr enddate)
Returns the count (signed integer) of the specified datepart boundaries crossed between the specified startdate and enddate.
|
XsIntegerExpr |
SqlExpr.datepart(XsStringExpr datepart,
ItemExpr date)
Returns an integer that represents the specified
datepart of the specified date. |
XsIntegerExpr |
SqlExpr.day(ItemExpr arg)
Returns an xs:integer between 1 and 31, both inclusive, representing the day component in the localized value of arg.
|
XsIntegerExpr |
FnExpr.dayFromDate(XsDateExpr arg)
Returns an xs:integer between 1 and 31, both inclusive, representing the day component in the localized value of arg.
|
XsIntegerExpr |
FnExpr.dayFromDateTime(XsDateTimeExpr arg)
Returns an xs:integer between 1 and 31, both inclusive, representing the day component in the localized value of arg.
|
XsIntegerExpr |
FnExpr.daysFromDuration(XsDurationExpr arg)
Returns an xs:integer representing the days component in the canonical lexical representation of the value of arg.
|
XsIntegerExpr |
XdmpExpr.hexToInteger(XsStringExpr hex)
Parses a hexadecimal string, returning an integer.
|
XsIntegerExpr |
SqlExpr.hours(ItemExpr arg)
Returns an xs:integer between 0 and 23, both inclusive, representing the value of the hours component in the localized value of arg.
|
XsIntegerExpr |
FnExpr.hoursFromDateTime(XsDateTimeExpr arg)
Returns an xs:integer between 0 and 23, both inclusive, representing the hours component in the localized value of arg.
|
XsIntegerExpr |
FnExpr.hoursFromDuration(XsDurationExpr arg)
Returns an xs:integer representing the hours component in the canonical lexical representation of the value of arg.
|
XsIntegerExpr |
FnExpr.hoursFromTime(XsTimeExpr arg)
Returns an xs:integer between 0 and 23, both inclusive, representing the value of the hours component in the localized value of arg.
|
XsIntegerExpr |
XsExpr.integer(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:integer server data type.
|
XsIntegerExpr |
SpellExpr.levenshteinDistance(XsStringExpr str1,
String str2)
Given two strings, returns the Levenshtein distance between those strings.
|
XsIntegerExpr |
SpellExpr.levenshteinDistance(XsStringExpr str1,
XsStringExpr str2)
Given two strings, returns the Levenshtein distance between those strings.
|
XsIntegerExpr |
SqlExpr.minutes(ItemExpr arg)
Returns an xs:integer value between 0 to 59, both inclusive, representing the value of the minutes component in the localized value of arg.
|
XsIntegerExpr |
FnExpr.minutesFromDateTime(XsDateTimeExpr arg)
Returns an xs:integer value between 0 and 59, both inclusive, representing the minute component in the localized value of arg.
|
XsIntegerExpr |
FnExpr.minutesFromDuration(XsDurationExpr arg)
Returns an xs:integer representing the minutes component in the canonical lexical representation of the value of arg.
|
XsIntegerExpr |
FnExpr.minutesFromTime(XsTimeExpr arg)
Returns an xs:integer value between 0 to 59, both inclusive, representing the value of the minutes component in the localized value of arg.
|
XsIntegerExpr |
SqlExpr.month(ItemExpr arg)
Returns an xs:integer between 1 and 12, both inclusive, representing the month component in the localized value of arg.
|
XsIntegerExpr |
FnExpr.monthFromDate(XsDateExpr arg)
Returns an xs:integer between 1 and 12, both inclusive, representing the month component in the localized value of arg.
|
XsIntegerExpr |
FnExpr.monthFromDateTime(XsDateTimeExpr arg)
Returns an xs:integer between 1 and 12, both inclusive, representing the month component in the localized value of arg.
|
XsIntegerExpr |
FnExpr.monthsFromDuration(XsDurationExpr arg)
Returns an xs:integer representing the months component in the canonical lexical representation of the value of arg.
|
XsIntegerExpr |
XdmpExpr.octalToInteger(XsStringExpr octal)
Parses an octal string, returning an integer.
|
XsIntegerExpr |
SqlExpr.octetLength(XsStringExpr x)
Returns the length of the string “str” in bits.
|
XsIntegerExpr |
XdmpExpr.position(XsStringExpr test,
String target)
Returns an integer value representing the starting position of a string within the search string.
|
XsIntegerExpr |
XdmpExpr.position(XsStringExpr test,
String target,
String collation)
Returns an integer value representing the starting position of a string within the search string.
|
XsIntegerExpr |
XdmpExpr.position(XsStringExpr test,
XsStringExpr target)
Returns an integer value representing the starting position of a string within the search string.
|
XsIntegerExpr |
XdmpExpr.position(XsStringExpr test,
XsStringExpr target,
XsStringExpr collation)
Returns an integer value representing the starting position of a string within the search string.
|
XsIntegerExpr |
SqlExpr.quarter(ItemExpr arg)
Returns an xs:integer between 1 and 4, both inclusive, calculating the quarter component in the localized value of arg.
|
XsIntegerExpr |
XdmpExpr.quarterFromDate(XsDateExpr arg)
Returns an xs:integer between 1 and 4, both inclusive, calculating the quarter component in the localized value of arg.
|
XsIntegerExpr |
MathExpr.rank(XsAnyAtomicTypeSeqExpr arg1,
String arg2)
Returns the rank of a value in a data set.
|
XsIntegerExpr |
MathExpr.rank(XsAnyAtomicTypeSeqExpr arg1,
String arg2,
String options)
Returns the rank of a value in a data set.
|
XsIntegerExpr |
MathExpr.rank(XsAnyAtomicTypeSeqExpr arg1,
XsAnyAtomicTypeExpr arg2)
Returns the rank of a value in a data set.
|
XsIntegerExpr |
MathExpr.rank(XsAnyAtomicTypeSeqExpr arg1,
XsAnyAtomicTypeExpr arg2,
XsStringSeqExpr options)
Returns the rank of a value in a data set.
|
XsIntegerExpr |
FnExpr.stringLength(XsStringExpr sourceString)
Returns an integer representing the length of the specified string.
|
XsIntegerExpr |
SqlExpr.timestampdiff(XsStringExpr dateTimeType,
ItemExpr timestamp1,
ItemExpr timestamp2)
Returns the difference in dateTimeType field of two given timestamps.
|
XsIntegerExpr |
SqlExpr.week(ItemExpr arg)
Returns an xs:integer between 1 and 53, both inclusive, representing the week value in the localized value of arg.
|
XsIntegerExpr |
SqlExpr.weekday(ItemExpr arg1) |
XsIntegerExpr |
XdmpExpr.weekdayFromDate(XsDateExpr arg)
Returns an xs:integer between 1 and 7, both inclusive, representing the weekday value in the localized value of arg.
|
XsIntegerExpr |
XdmpExpr.weekFromDate(XsDateExpr arg)
Returns an xs:integer between 1 and 53, both inclusive, representing the week value in the localized value of arg.
|
XsIntegerExpr |
SqlExpr.year(ItemExpr arg)
Returns an xs:integer representing the year component in the localized value of arg.
|
XsIntegerExpr |
SqlExpr.yearday(ItemExpr arg)
Returns an xs:integer between 1 and 366, both inclusive, representing the yearday value in the localized value of arg.
|
XsIntegerExpr |
XdmpExpr.yeardayFromDate(XsDateExpr arg)
Returns an xs:integer between 1 and 366, both inclusive, representing the yearday value in the localized value of arg.
|
XsIntegerExpr |
FnExpr.yearFromDate(XsDateExpr arg)
Returns an xs:integer representing the year component in the localized value of arg.
|
XsIntegerExpr |
FnExpr.yearFromDateTime(XsDateTimeExpr arg)
Returns an xs:integer representing the year component in the localized value of arg.
|
XsIntegerExpr |
FnExpr.yearsFromDuration(XsDurationExpr arg)
Returns an xs:integer representing the years component in the canonical lexical representation of the value of arg.
|
| Modifier and Type | Method and Description |
|---|---|
XsStringExpr |
XdmpExpr.formatNumber(XsNumericSeqExpr value,
XsStringExpr picture,
XsStringExpr language,
XsStringExpr letterValue,
XsStringExpr ordchar,
XsStringExpr zeroPadding,
XsStringExpr groupingSeparator,
XsIntegerExpr groupingSize)
Returns a formatted number value based on the picture argument.
|
ItemSeqExpr |
FnExpr.insertBefore(ItemSeqExpr target,
XsIntegerExpr position,
ItemSeqExpr inserts)
Returns a new sequence constructed from the value of target with the value of inserts inserted at the position specified by the value of position.
|
XsIntegerSeqExpr |
XsExpr.integerSeq(XsIntegerExpr... items)
Constructs a sequence of XsIntegerExpr items.
|
XsStringExpr |
XdmpExpr.integerToHex(XsIntegerExpr val)
Returns a hexadecimal representation of an integer.
|
XsStringExpr |
XdmpExpr.integerToOctal(XsIntegerExpr val)
Returns an octal representation of an integer.
|
XsDoubleExpr |
MathExpr.ldexp(XsDoubleExpr y,
XsIntegerExpr i)
Returns x*2^i.
|
ItemSeqExpr |
FnExpr.remove(ItemSeqExpr target,
XsIntegerExpr position)
Returns a new sequence constructed from the value of target with the item at the position specified by the value of position removed.
|
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.
|
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 |
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 |
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.