| 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 |
|---|---|
ItemExpr |
SqlExpr.dateadd(XsStringExpr datepart,
int number,
ItemExpr date)
Returns a specified date with the specified number interval (signed integer) added to a specified datepart of that date
|
ItemExpr |
SqlExpr.dateadd(XsStringExpr datepart,
XsIntExpr number,
ItemExpr date)
Returns a specified date with the specified number interval (signed integer) added to a specified datepart of that date
|
ItemExpr |
FnExpr.head(ItemSeqExpr seq)
Returns the first item in a sequence.
|
ItemExpr |
SqlExpr.timestampadd(XsStringExpr dateTimeType,
int value,
ItemExpr timestamp)
Returns a xs:string? timestamp created by adding a number to the given dateTimeType field of a given timestamp.
|
ItemExpr |
SqlExpr.timestampadd(XsStringExpr dateTimeType,
XsIntExpr value,
ItemExpr timestamp)
Returns a xs:string? timestamp created by adding a number to the given dateTimeType field of a given timestamp.
|
| Modifier and Type | Method and Description |
|---|---|
XsBooleanExpr |
XdmpExpr.castableAs(XsStringExpr namespaceUri,
String localName,
ItemExpr item)
Returns true if a value is castable.
|
XsBooleanExpr |
XdmpExpr.castableAs(XsStringExpr namespaceUri,
XsStringExpr localName,
ItemExpr item)
Returns true if a value is castable.
|
ItemSeqExpr |
SemExpr.coalesce(ItemExpr... parameter1)
Returns the value of the first argument that evaluates without error.
|
ItemExpr |
SqlExpr.dateadd(XsStringExpr datepart,
int number,
ItemExpr date)
Returns a specified date with the specified number interval (signed integer) added to a specified datepart of that date
|
ItemExpr |
SqlExpr.dateadd(XsStringExpr datepart,
XsIntExpr number,
ItemExpr date)
Returns a specified date with the specified number interval (signed integer) added to a specified datepart of that date
|
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.
|
XsStringExpr |
SqlExpr.dayname(ItemExpr arg)
Returns an xs:string representing the dayname value in the localized value of arg.
|
abstract PlanCase |
PlanBuilder.elseExpr(ItemExpr value) |
XsStringExpr |
XdmpExpr.hmacMd5(ItemExpr secretkey,
ItemExpr message)
Calculates the Hash-based Message Authentication Code (HMAC) using the md5 hash function of the given secret key and message arguments.
|
XsStringExpr |
XdmpExpr.hmacMd5(ItemExpr secretkey,
ItemExpr message,
String encoding)
Calculates the Hash-based Message Authentication Code (HMAC) using the md5 hash function of the given secret key and message arguments.
|
XsStringExpr |
XdmpExpr.hmacMd5(ItemExpr secretkey,
ItemExpr message,
XsStringExpr encoding)
Calculates the Hash-based Message Authentication Code (HMAC) using the md5 hash function of the given secret key and message arguments.
|
XsStringExpr |
XdmpExpr.hmacSha1(ItemExpr secretkey,
ItemExpr message)
Calculates the Hash-based Message Authentication Code (HMAC) using the SHA1 hash function of the given secret key and message arguments.
|
XsStringExpr |
XdmpExpr.hmacSha1(ItemExpr secretkey,
ItemExpr message,
String encoding)
Calculates the Hash-based Message Authentication Code (HMAC) using the SHA1 hash function of the given secret key and message arguments.
|
XsStringExpr |
XdmpExpr.hmacSha1(ItemExpr secretkey,
ItemExpr message,
XsStringExpr encoding)
Calculates the Hash-based Message Authentication Code (HMAC) using the SHA1 hash function of the given secret key and message arguments.
|
XsStringExpr |
XdmpExpr.hmacSha256(ItemExpr secretkey,
ItemExpr message)
Calculates the Hash-based Message Authentication Code (HMAC) using the SHA256 hash function of the given secret key and message arguments.
|
XsStringExpr |
XdmpExpr.hmacSha256(ItemExpr secretkey,
ItemExpr message,
String encoding)
Calculates the Hash-based Message Authentication Code (HMAC) using the SHA256 hash function of the given secret key and message arguments.
|
XsStringExpr |
XdmpExpr.hmacSha256(ItemExpr secretkey,
ItemExpr message,
XsStringExpr encoding)
Calculates the Hash-based Message Authentication Code (HMAC) using the SHA256 hash function of the given secret key and message arguments.
|
XsStringExpr |
XdmpExpr.hmacSha512(ItemExpr secretkey,
ItemExpr message)
Calculates the Hash-based Message Authentication Code (HMAC) using the SHA512 hash function of the given secret key and message arguments.
|
XsStringExpr |
XdmpExpr.hmacSha512(ItemExpr secretkey,
ItemExpr message,
String encoding)
Calculates the Hash-based Message Authentication Code (HMAC) using the SHA512 hash function of the given secret key and message arguments.
|
XsStringExpr |
XdmpExpr.hmacSha512(ItemExpr secretkey,
ItemExpr message,
XsStringExpr encoding)
Calculates the Hash-based Message Authentication Code (HMAC) using the SHA512 hash function of the given secret key and message arguments.
|
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.
|
abstract XsBooleanExpr |
PlanBuilder.isDefined(ItemExpr operand)
This function tests whether the value of an expression is null in the row where the expression might be as simple as a column identified by op:col.
|
XsStringExpr |
XdmpExpr.md5(ItemExpr data)
Calculates the md5 hash of the given argument.
|
XsStringExpr |
XdmpExpr.md5(ItemExpr data,
String encoding)
Calculates the md5 hash of the given argument.
|
XsStringExpr |
XdmpExpr.md5(ItemExpr data,
XsStringExpr encoding)
Calculates the md5 hash of the given argument.
|
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 |
SqlExpr.month(ItemExpr arg)
Returns an xs:integer between 1 and 12, both inclusive, representing the month component in the localized value of arg.
|
XsStringExpr |
SqlExpr.monthname(ItemExpr arg)
Returns month name, calculated from the localized value of arg.
|
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.
|
XsDecimalExpr |
SqlExpr.seconds(ItemExpr arg)
Returns an xs:decimal value between 0 and 60.999…, both inclusive, representing the seconds and fractional seconds in the localized value of arg.
|
XsStringExpr |
XdmpExpr.sha1(ItemExpr data)
Calculates the SHA1 hash of the given argument.
|
XsStringExpr |
XdmpExpr.sha1(ItemExpr data,
String encoding)
Calculates the SHA1 hash of the given argument.
|
XsStringExpr |
XdmpExpr.sha1(ItemExpr data,
XsStringExpr encoding)
Calculates the SHA1 hash of the given argument.
|
XsStringExpr |
XdmpExpr.sha256(ItemExpr data)
Calculates the SHA256 hash of the given argument.
|
XsStringExpr |
XdmpExpr.sha256(ItemExpr data,
String encoding)
Calculates the SHA256 hash of the given argument.
|
XsStringExpr |
XdmpExpr.sha256(ItemExpr data,
XsStringExpr encoding)
Calculates the SHA256 hash of the given argument.
|
XsStringExpr |
XdmpExpr.sha384(ItemExpr data)
Calculates the SHA384 hash of the given argument.
|
XsStringExpr |
XdmpExpr.sha384(ItemExpr data,
String encoding)
Calculates the SHA384 hash of the given argument.
|
XsStringExpr |
XdmpExpr.sha384(ItemExpr data,
XsStringExpr encoding)
Calculates the SHA384 hash of the given argument.
|
XsStringExpr |
XdmpExpr.sha512(ItemExpr data)
Calculates the SHA512 hash of the given argument.
|
XsStringExpr |
XdmpExpr.sha512(ItemExpr data,
String encoding)
Calculates the SHA512 hash of the given argument.
|
XsStringExpr |
XdmpExpr.sha512(ItemExpr data,
XsStringExpr encoding)
Calculates the SHA512 hash of the given argument.
|
XsStringExpr |
FnExpr.string(ItemExpr arg)
Returns the value of arg represented as an
xs:string. |
ItemExpr |
SqlExpr.timestampadd(XsStringExpr dateTimeType,
int value,
ItemExpr timestamp)
Returns a xs:string? timestamp created by adding a number to the given dateTimeType field of a given timestamp.
|
ItemExpr |
SqlExpr.timestampadd(XsStringExpr dateTimeType,
XsIntExpr value,
ItemExpr timestamp)
Returns a xs:string? timestamp created by adding a number to the given dateTimeType field of a given timestamp.
|
XsIntegerExpr |
SqlExpr.timestampdiff(XsStringExpr dateTimeType,
ItemExpr timestamp1,
ItemExpr timestamp2)
Returns the difference in dateTimeType field of two given timestamps.
|
JsonArrayExpr |
JsonExpr.toArray(ItemSeqExpr items,
double limit,
ItemExpr zero)
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.
|
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) |
abstract PlanCase |
PlanBuilder.when(boolean condition,
ItemExpr... value)
This function executes the specified expression if the specified condition is
true for the row. |
abstract PlanCase |
PlanBuilder.when(XsBooleanExpr condition,
ItemExpr... value)
This function executes the specified expression if the specified condition is
true for the row. |
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.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
ArrayNodeExpr
An instance of a JSON array node expression.
|
interface |
AttributeNodeExpr
An instance of an XML attribute node expression.
|
interface |
BooleanNodeExpr
An instance of a JSON boolean node expression.
|
interface |
CommentNodeExpr
An instance of an XML comment node expression.
|
interface |
CtsBoxExpr
An instance of a cts.box expression.
|
interface |
CtsCircleExpr
An instance of a cts.circle expression.
|
interface |
CtsPeriodExpr
An instance of a cts.period expression.
|
interface |
CtsPointExpr
An instance of a cts.point expression.
|
interface |
CtsPolygonExpr
An instance of a cts.polygon expression.
|
interface |
CtsQueryExpr
An instance of a cts.query expression.
|
interface |
CtsReferenceExpr
An instance of a cts.reference expression.
|
interface |
CtsRegionExpr
An instance of a cts.region expression.
|
interface |
DocumentNodeExpr
An instance of a JSON or XML document node expression.
|
interface |
ElementNodeExpr
An instance of an XML element node expression.
|
interface |
ItemVal
An instance of a server value.
|
interface |
JsonArrayExpr
An instance of a JSON array expression.
|
interface |
JsonContentNodeExpr
An instance of a JSON boolean, null, number, or text node expression.
|
interface |
JsonObjectExpr
An instance of a JSON object expression.
|
interface |
JsonRootNodeExpr
An instance of a JSON array or object node expression.
|
interface |
MapMapExpr
An instance of a map expression.
|
interface |
MathLinearModelExpr
An instance of a math.linearModel expression.
|
interface |
NodeExpr
An instance of a node expression.
|
interface |
NullNodeExpr
An instance of a JSON null node expression.
|
interface |
NumberNodeExpr
An instance of a JSON number node expression.
|
interface |
ObjectNodeExpr
An instance of a JSON object node expression.
|
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 |
ProcessingInstructionNodeExpr
An instance of an XML processing instruction node expression.
|
interface |
RdfLangStringExpr
An instance of an RDF language string expression.
|
interface |
RdfLangStringVal
A sequence of RDF language string values.
|
interface |
SemBlankExpr
An instance of a semantic bnode (blank node) expression.
|
interface |
SemInvalidExpr
An instance of an semantic invalid expression.
|
interface |
SemIriExpr
An instance of a semantic IRI expression.
|
interface |
SemIriVal
An instance of a semantic IRI value.
|
interface |
SemUnknownExpr
An instance of a semantic unknown expression.
|
interface |
TextNodeExpr
An instance of a JSON or XML text node expression.
|
interface |
XmlContentNodeExpr
An instance of an XML comment, element, processing-instruction, or text node expression.
|
interface |
XmlRootNodeExpr
An instance of an XML comment, element, or processing-instruction node expression.
|
interface |
XsAnyAtomicTypeExpr
An instance of a server atomic expression.
|
interface |
XsAnyAtomicTypeVal
An instance of a server atomic value.
|
interface |
XsAnySimpleTypeExpr
An instance of a server simple expression.
|
interface |
XsAnySimpleTypeVal
An instance of a server simple value.
|
interface |
XsAnyURIExpr
An instance of a server URI expression.
|
interface |
XsAnyURIVal
An instance of a server URI value.
|
interface |
XsBase64BinaryExpr
An instance of a server base 64 binary expression.
|
interface |
XsBase64BinaryVal
An instance of a server base 64 binary value.
|
interface |
XsBooleanExpr
An instance of a server boolean expression.
|
interface |
XsBooleanVal
An instance of a server boolean value.
|
interface |
XsByteExpr
An instance of a server byte expression.
|
interface |
XsByteVal
An instance of a server byte value.
|
interface |
XsDateExpr
An instance of a server date expression.
|
interface |
XsDateTimeExpr
An instance of a server datetime expression.
|
interface |
XsDateTimeVal
An instance of a server datetime value.
|
interface |
XsDateVal
An instance of a server date value.
|
interface |
XsDayTimeDurationExpr
An instance of a server day-time duration expression.
|
interface |
XsDayTimeDurationVal
An instance of a server day-time duration 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 |
XsDurationExpr
An instance of a server duration expression.
|
interface |
XsDurationVal
An instance of a server duration value.
|
interface |
XsFloatExpr
An instance of a server float expression.
|
interface |
XsFloatVal
An instance of a server float value.
|
interface |
XsGDayExpr
An instance of a server GDay expression.
|
interface |
XsGDayVal
An instance of a server GDay value.
|
interface |
XsGMonthDayExpr
An instance of a server GMonthDay expression.
|
interface |
XsGMonthDayVal
An instance of a server GMonthDay value.
|
interface |
XsGMonthExpr
An instance of a server GMonth expression.
|
interface |
XsGMonthVal
An instance of a server GMonth value.
|
interface |
XsGYearExpr
An instance of a server GYear expression.
|
interface |
XsGYearMonthExpr
An instance of a server GYearMonth expression.
|
interface |
XsGYearMonthVal
An instance of a server GYearMonth value.
|
interface |
XsGYearVal
An instance of a server GYear value.
|
interface |
XsHexBinaryExpr
An instance of a server hex binary expression.
|
interface |
XsHexBinaryVal
An instance of a server hex binary 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 |
XsLanguageExpr
An instance of a server language expression.
|
interface |
XsLongExpr
An instance of a server long expression.
|
interface |
XsLongVal
An instance of a server long value.
|
interface |
XsNameExpr
An instance of a server name expression.
|
interface |
XsNCNameExpr
An instance of a server NCName expression.
|
interface |
XsNegativeIntegerExpr
An instance of a server negative integer expression.
|
interface |
XsNMTOKENExpr
An instance of a server name token 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 |
XsNormalizedStringExpr
An instance of a server normalized string expression.
|
interface |
XsNumericExpr
An instance of a server numeric expression.
|
interface |
XsNumericVal
An instance of a server numeric value.
|
interface |
XsPositiveIntegerExpr
An instance of a server positive integer expression.
|
interface |
XsQNameExpr
An instance of a server qualified name expression.
|
interface |
XsQNameVal
An instance of a server qualified name value.
|
interface |
XsShortExpr
An instance of a server short expression.
|
interface |
XsShortVal
An instance of a server short value.
|
interface |
XsStringExpr
An instance of a server string expression.
|
interface |
XsStringVal
An instance of a server string value.
|
interface |
XsTimeExpr
An instance of a server time expression.
|
interface |
XsTimeVal
An instance of a server time value.
|
interface |
XsTokenExpr
An instance of a server token expression.
|
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.
|
interface |
XsUntypedAtomicExpr
An instance of a server untyped atomic expression.
|
interface |
XsUntypedAtomicVal
An instance of a server untyped atomic value.
|
interface |
XsYearMonthDurationExpr
An instance of a server year-month duration expression.
|
interface |
XsYearMonthDurationVal
An instance of a server year-month duration value.
|
Copyright © 2013-2017 MarkLogic Corporation.