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(ServerExpression str)
Returns the length of the string "str" in bits.
|
XsIntegerExpr |
FnExpr.compare(ServerExpression comparand1,
ServerExpression 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(ServerExpression comparand1,
ServerExpression comparand2,
ServerExpression 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(ServerExpression comparand1,
java.lang.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(ServerExpression comparand1,
java.lang.String comparand2,
java.lang.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.count(ServerExpression arg)
Returns the number of items in the value of arg.
|
XsIntegerExpr |
FnExpr.count(ServerExpression arg,
double maximum)
Returns the number of items in the value of arg.
|
XsIntegerExpr |
FnExpr.count(ServerExpression arg,
ServerExpression maximum)
Returns the number of items in the value of arg.
|
XsIntegerExpr |
SqlExpr.datediff(ServerExpression datepart,
ServerExpression startdate,
ServerExpression enddate)
Returns the count (signed integer) of the specified datepart boundaries crossed between the specified startdate and enddate.
|
XsIntegerExpr |
SqlExpr.datepart(ServerExpression datepart,
ServerExpression date)
Returns an integer that represents the specified datepart of the specified date.
|
XsIntegerExpr |
SqlExpr.day(ServerExpression arg)
Returns an xs:integer between 1 and 31, both inclusive, representing the day component in the localized value of arg.
|
XsIntegerExpr |
FnExpr.dayFromDate(ServerExpression arg)
Returns an xs:integer between 1 and 31, both inclusive, representing the day component in the localized value of arg.
|
XsIntegerExpr |
FnExpr.dayFromDateTime(ServerExpression arg)
Returns an xs:integer between 1 and 31, both inclusive, representing the day component in the localized value of arg.
|
XsIntegerExpr |
FnExpr.daysFromDuration(ServerExpression arg)
Returns an xs:integer representing the days component in the canonical lexical representation of the value of arg.
|
XsIntegerExpr |
XdmpExpr.hexToInteger(ServerExpression hex)
Parses a hexadecimal string, returning an integer.
|
XsIntegerExpr |
SqlExpr.hours(ServerExpression 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(ServerExpression arg)
Returns an xs:integer between 0 and 23, both inclusive, representing the hours component in the localized value of arg.
|
XsIntegerExpr |
FnExpr.hoursFromDuration(ServerExpression arg)
Returns an xs:integer representing the hours component in the canonical lexical representation of the value of arg.
|
XsIntegerExpr |
FnExpr.hoursFromTime(ServerExpression 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(ServerExpression arg1)
Constructs or casts an expression to the xs:integer server data type.
|
XsIntegerExpr |
SpellExpr.levenshteinDistance(ServerExpression str1,
ServerExpression str2)
Given two strings, returns the Levenshtein distance between those strings.
|
XsIntegerExpr |
SpellExpr.levenshteinDistance(ServerExpression str1,
java.lang.String str2)
Given two strings, returns the Levenshtein distance between those strings.
|
XsIntegerExpr |
SqlExpr.minutes(ServerExpression 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(ServerExpression 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(ServerExpression arg)
Returns an xs:integer representing the minutes component in the canonical lexical representation of the value of arg.
|
XsIntegerExpr |
FnExpr.minutesFromTime(ServerExpression 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(ServerExpression arg)
Returns an xs:integer between 1 and 12, both inclusive, representing the month component in the localized value of arg.
|
XsIntegerExpr |
FnExpr.monthFromDate(ServerExpression arg)
Returns an xs:integer between 1 and 12, both inclusive, representing the month component in the localized value of arg.
|
XsIntegerExpr |
FnExpr.monthFromDateTime(ServerExpression arg)
Returns an xs:integer between 1 and 12, both inclusive, representing the month component in the localized value of arg.
|
XsIntegerExpr |
FnExpr.monthsFromDuration(ServerExpression arg)
Returns an xs:integer representing the months component in the canonical lexical representation of the value of arg.
|
XsIntegerExpr |
XdmpExpr.octalToInteger(ServerExpression octal)
Parses an octal string, returning an integer.
|
XsIntegerExpr |
SqlExpr.octetLength(ServerExpression x)
Returns the length of the string "str" in bits.
|
XsIntegerExpr |
XdmpExpr.position(ServerExpression test,
ServerExpression target)
Returns an integer value representing the starting position of a string within the search string.
|
XsIntegerExpr |
XdmpExpr.position(ServerExpression test,
ServerExpression target,
ServerExpression collation)
Returns an integer value representing the starting position of a string within the search string.
|
XsIntegerExpr |
XdmpExpr.position(ServerExpression test,
java.lang.String target)
Returns an integer value representing the starting position of a string within the search string.
|
XsIntegerExpr |
XdmpExpr.position(ServerExpression test,
java.lang.String target,
java.lang.String collation)
Returns an integer value representing the starting position of a string within the search string.
|
XsIntegerExpr |
SqlExpr.quarter(ServerExpression arg)
Returns an xs:integer between 1 and 4, both inclusive, calculating the quarter component in the localized value of arg.
|
XsIntegerExpr |
XdmpExpr.quarterFromDate(ServerExpression arg)
Returns an xs:integer between 1 and 4, both inclusive, calculating the quarter component in the localized value of arg.
|
XsIntegerExpr |
MathExpr.rank(ServerExpression arg1,
ServerExpression arg2)
Returns the rank of a value in a data set.
|
XsIntegerExpr |
MathExpr.rank(ServerExpression arg1,
ServerExpression arg2,
ServerExpression options)
Returns the rank of a value in a data set.
|
XsIntegerExpr |
MathExpr.rank(ServerExpression arg1,
java.lang.String arg2)
Returns the rank of a value in a data set.
|
XsIntegerExpr |
MathExpr.rank(ServerExpression arg1,
java.lang.String arg2,
java.lang.String options)
Returns the rank of a value in a data set.
|
XsIntegerExpr |
FnExpr.stringLength(ServerExpression sourceString)
Returns an integer representing the length of the specified string.
|
XsIntegerExpr |
SqlExpr.timestampdiff(ServerExpression dateTimeType,
ServerExpression timestamp1,
ServerExpression timestamp2)
Returns the difference in dateTimeType field of two given timestamps.
|
XsIntegerExpr |
SqlExpr.week(ServerExpression arg)
Returns an xs:integer between 1 and 53, both inclusive, representing the week value in the localized value of arg.
|
XsIntegerExpr |
SqlExpr.weekday(ServerExpression arg1) |
XsIntegerExpr |
XdmpExpr.weekdayFromDate(ServerExpression arg)
Returns an xs:integer in the range 1 to 7, inclusive, representing the weekday value in the localized value of arg.
|
XsIntegerExpr |
XdmpExpr.weekFromDate(ServerExpression arg)
Returns an xs:integer between 1 and 53, both inclusive, representing the week value in the localized value of arg.
|
XsIntegerExpr |
SqlExpr.year(ServerExpression arg)
Returns an xs:integer representing the year component in the localized value of arg.
|
XsIntegerExpr |
SqlExpr.yearday(ServerExpression arg)
Returns an xs:integer between 1 and 366, both inclusive, representing the yearday value in the localized value of arg.
|
XsIntegerExpr |
XdmpExpr.yeardayFromDate(ServerExpression arg)
Returns an xs:integer between 1 and 366, both inclusive, representing the yearday value in the localized value of arg.
|
XsIntegerExpr |
FnExpr.yearFromDate(ServerExpression arg)
Returns an xs:integer representing the year component in the localized value of arg.
|
XsIntegerExpr |
FnExpr.yearFromDateTime(ServerExpression arg)
Returns an xs:integer representing the year component in the localized value of arg.
|
XsIntegerExpr |
FnExpr.yearsFromDuration(ServerExpression 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 |
---|---|
XsIntegerSeqExpr |
XsExpr.integerSeq(XsIntegerExpr... items)
Deprecated.
(as of 4.2) construct a
ServerExpression sequence with PlanBuilder.seq() |
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
Deprecated.
(as of 4.2) Use
ServerExpression |
interface |
XsByteVal
An instance of a server byte value.
|
interface |
XsIntegerVal
An instance of a server integer value.
|
interface |
XsIntExpr
Deprecated.
(as of 4.2) Use
ServerExpression |
interface |
XsIntVal
An instance of a server int value.
|
interface |
XsLongExpr
Deprecated.
(as of 4.2) Use
ServerExpression |
interface |
XsLongVal
An instance of a server long value.
|
interface |
XsNegativeIntegerExpr
Deprecated.
(as of 4.2) Use
ServerExpression |
interface |
XsNonNegativeIntegerExpr
Deprecated.
(as of 4.2) Use
ServerExpression |
interface |
XsNonNegativeIntegerVal
An instance of a server non-negative integer value.
|
interface |
XsNonPositiveIntegerExpr
Deprecated.
(as of 4.2) Use
ServerExpression |
interface |
XsPositiveIntegerExpr
Deprecated.
(as of 4.2) Use
ServerExpression |
interface |
XsShortExpr
Deprecated.
(as of 4.2) Use
ServerExpression |
interface |
XsShortVal
An instance of a server short value.
|
interface |
XsUnsignedByteExpr
Deprecated.
(as of 4.2) Use
ServerExpression |
interface |
XsUnsignedByteVal
An instance of a server unsigned byte value.
|
interface |
XsUnsignedIntExpr
Deprecated.
(as of 4.2) Use
ServerExpression |
interface |
XsUnsignedIntVal
An instance of a server unsigned int value.
|
interface |
XsUnsignedLongExpr
Deprecated.
(as of 4.2) Use
ServerExpression |
interface |
XsUnsignedLongVal
An instance of a server unsigned long value.
|
interface |
XsUnsignedShortExpr
Deprecated.
(as of 4.2) Use
ServerExpression |
interface |
XsUnsignedShortVal
An instance of a server unsigned short value.
|
Copyright © 2013-2018 MarkLogic Corporation.