| 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 |
|---|---|
XsAnyAtomicTypeExpr |
FnExpr.avg(XsAnyAtomicTypeSeqExpr arg)
Returns the average of the values in the input sequence arg, that is, the sum of the values divided by the number of values.
|
XsAnyAtomicTypeExpr |
FnExpr.max(XsAnyAtomicTypeSeqExpr arg)
Selects an item from the input sequence arg whose value is greater than or equal to the value of every other item in the input sequence.
|
XsAnyAtomicTypeExpr |
FnExpr.max(XsAnyAtomicTypeSeqExpr arg,
String collation)
Selects an item from the input sequence arg whose value is greater than or equal to the value of every other item in the input sequence.
|
XsAnyAtomicTypeExpr |
FnExpr.max(XsAnyAtomicTypeSeqExpr arg,
XsStringExpr collation)
Selects an item from the input sequence arg whose value is greater than or equal to the value of every other item in the input sequence.
|
XsAnyAtomicTypeExpr |
FnExpr.min(XsAnyAtomicTypeSeqExpr arg)
Selects an item from the input sequence arg whose value is less than or equal to the value of every other item in the input sequence.
|
XsAnyAtomicTypeExpr |
FnExpr.min(XsAnyAtomicTypeSeqExpr arg,
String collation)
Selects an item from the input sequence arg whose value is less than or equal to the value of every other item in the input sequence.
|
XsAnyAtomicTypeExpr |
FnExpr.min(XsAnyAtomicTypeSeqExpr arg,
XsStringExpr collation)
Selects an item from the input sequence arg whose value is less than or equal to the value of every other item in the input sequence.
|
XsAnyAtomicTypeExpr |
FnExpr.sum(XsAnyAtomicTypeSeqExpr arg)
Returns a value obtained by adding together the values in arg.
|
XsAnyAtomicTypeExpr |
FnExpr.sum(XsAnyAtomicTypeSeqExpr arg,
String zero)
Returns a value obtained by adding together the values in arg.
|
XsAnyAtomicTypeExpr |
FnExpr.sum(XsAnyAtomicTypeSeqExpr arg,
XsAnyAtomicTypeExpr zero)
Returns a value obtained by adding together the values in arg.
|
XsAnyAtomicTypeExpr |
SemExpr.typedLiteral(XsStringExpr value,
SemIriExpr datatype)
Returns a value to represent the RDF typed literal with lexical value
value and datatype IRI datatype. |
XsAnyAtomicTypeExpr |
SemExpr.typedLiteral(XsStringExpr value,
String datatype)
Returns a value to represent the RDF typed literal with lexical value
value and datatype IRI datatype. |
| Modifier and Type | Method and Description |
|---|---|
abstract XsBooleanExpr |
PlanBuilder.and(XsAnyAtomicTypeExpr... left)
This function returns
true if the specified expressions all return true. |
XsAnyAtomicTypeSeqExpr |
XsExpr.anyAtomicTypeSeq(XsAnyAtomicTypeExpr... items)
Constructs a sequence of XsAnyAtomicTypeExpr items.
|
XsAnyURIExpr |
XsExpr.anyURI(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:anyURI server data type.
|
XsBase64BinaryExpr |
XsExpr.base64Binary(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:base64Binary server data type.
|
SemBlankExpr |
SemExpr.bnode(XsAnyAtomicTypeExpr value)
This function returns an identifier for a blank node, allowing the construction of a triple that refers to a blank node.
|
XsBooleanExpr |
XsExpr.booleanExpr(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:boolean server data type.
|
XsByteExpr |
XsExpr.byteExpr(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:byte server data type.
|
XsStringExpr |
FnExpr.concat(XsAnyAtomicTypeExpr... parameter1)
Returns the
xs:string that is the concatenation of the values of the specified parameters. |
SemIriExpr |
SemExpr.datatype(XsAnyAtomicTypeExpr value)
Returns the name of the simple type of the atomic value argument as a SPARQL style IRI.
|
XsDateExpr |
XsExpr.date(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:date server data type.
|
XsDateTimeExpr |
XsExpr.dateTime(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:dateTime server data type.
|
XsDayTimeDurationExpr |
XsExpr.dayTimeDuration(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:dayTimeDuration server data type.
|
XsDecimalExpr |
XsExpr.decimal(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:decimal server data type.
|
XsDoubleExpr |
XsExpr.doubleExpr(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:double server data type.
|
abstract XsBooleanExpr |
PlanBuilder.eq(XsAnyAtomicTypeExpr left,
XsAnyAtomicTypeExpr right)
This function returns
true if the left and right expressions return the same value. |
XsFloatExpr |
XsExpr.floatExpr(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:float server data type.
|
XsGDayExpr |
XsExpr.gDay(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:gDay server data type.
|
abstract XsBooleanExpr |
PlanBuilder.ge(XsAnyAtomicTypeExpr left,
XsAnyAtomicTypeExpr right)
This function returns
true if the value of the left expression is greater than or equal to the value of the right expression. |
XsGMonthExpr |
XsExpr.gMonth(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:gMonth server data type.
|
XsGMonthDayExpr |
XsExpr.gMonthDay(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:gMonthDay server data type.
|
abstract XsBooleanExpr |
PlanBuilder.gt(XsAnyAtomicTypeExpr left,
XsAnyAtomicTypeExpr right)
This function returns
true if the value of the left expression is greater than the value of the right expression. |
XsGYearExpr |
XsExpr.gYear(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:gYear server data type.
|
XsGYearMonthExpr |
XsExpr.gYearMonth(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:gYearMonth server data type.
|
XsHexBinaryExpr |
XsExpr.hexBinary(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:hexBinary server data type.
|
XsIntegerSeqExpr |
FnExpr.indexOf(XsAnyAtomicTypeSeqExpr seqParam,
XsAnyAtomicTypeExpr srchParam)
Returns a sequence of positive integers giving the positions within the sequence seqParam of items that are equal to srchParam.
|
XsIntegerSeqExpr |
FnExpr.indexOf(XsAnyAtomicTypeSeqExpr seqParam,
XsAnyAtomicTypeExpr srchParam,
XsStringExpr collationLiteral)
Returns a sequence of positive integers giving the positions within the sequence seqParam of items that are equal to srchParam.
|
XsIntegerExpr |
XsExpr.integer(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:integer server data type.
|
XsIntExpr |
XsExpr.intExpr(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:int server data type.
|
SemIriExpr |
SemExpr.iri(XsAnyAtomicTypeExpr stringIri)
This is a constructor function that takes a string and constructs an item of type
sem:iri from it. |
XsBooleanExpr |
SemExpr.isBlank(XsAnyAtomicTypeExpr value)
Returns true if the argument is an RDF blank node - that is, derived from type
sem:blank. |
XsBooleanExpr |
SemExpr.isIRI(XsAnyAtomicTypeExpr value)
Returns true if the argument is an RDF IRI - that is, derived from type
sem:iri, but not derived from type sem:blank. |
XsBooleanExpr |
SemExpr.isLiteral(XsAnyAtomicTypeExpr value)
Returns true if the argument is an RDF literal - that is, derived from type
xs:anyAtomicType, but not derived from type sem:iri. |
XsBooleanExpr |
SemExpr.isNumeric(XsAnyAtomicTypeExpr value)
Returns true if the argument is a valid numeric RDF literal.
|
abstract TextNodeExpr |
PlanBuilder.jsonString(XsAnyAtomicTypeExpr value)
This function constructs a JSON text node with the specified value.
|
XsStringExpr |
SemExpr.lang(XsAnyAtomicTypeExpr value)
Returns the language of the value passed in, or the empty string if the value has no language.
|
XsLanguageExpr |
XsExpr.language(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:language server data type.
|
abstract XsBooleanExpr |
PlanBuilder.le(XsAnyAtomicTypeExpr left,
XsAnyAtomicTypeExpr right)
This function returns
true if the value of the left expression is less than or equal to the value of the right expression. |
XsLongExpr |
XsExpr.longExpr(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:long server data type.
|
abstract XsBooleanExpr |
PlanBuilder.lt(XsAnyAtomicTypeExpr left,
XsAnyAtomicTypeExpr right)
This function returns
true if the value of the left expression is less than the value of the right expression. |
XsNameExpr |
XsExpr.Name(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:Name server data type.
|
XsNCNameExpr |
XsExpr.NCName(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:NCName server data type.
|
abstract XsBooleanExpr |
PlanBuilder.ne(XsAnyAtomicTypeExpr left,
XsAnyAtomicTypeExpr right)
This function returns
true if the value of the left expression is not equal to the value of the right expression. |
XsNegativeIntegerExpr |
XsExpr.negativeInteger(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:negativeInteger server data type.
|
XsNMTOKENExpr |
XsExpr.NMTOKEN(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:NMTOKEN server data type.
|
XsNonNegativeIntegerExpr |
XsExpr.nonNegativeInteger(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:nonNegativeInteger server data type.
|
XsNonPositiveIntegerExpr |
XsExpr.nonPositiveInteger(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:nonPositiveInteger server data type.
|
XsNormalizedStringExpr |
XsExpr.normalizedString(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:normalizedString server data type.
|
abstract XsBooleanExpr |
PlanBuilder.not(XsAnyAtomicTypeExpr operand)
This function returns
true if neither of the specified boolean expressions return true. |
XsDoubleExpr |
FnExpr.number(XsAnyAtomicTypeExpr arg)
Returns the value indicated by arg or, if arg is not specified, the context item after atomization, converted to an xs:double.
|
XsNumericExpr |
XsExpr.numeric(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:numeric server data type.
|
abstract XsBooleanExpr |
PlanBuilder.or(XsAnyAtomicTypeExpr... left)
This function returns
true if the specified expressions all return true. |
XsDoubleExpr |
MathExpr.percentRank(XsAnyAtomicTypeSeqExpr arg,
XsAnyAtomicTypeExpr value)
Returns the rank of a value in a data set as a percentage of the data set.
|
XsDoubleExpr |
MathExpr.percentRank(XsAnyAtomicTypeSeqExpr arg,
XsAnyAtomicTypeExpr value,
XsStringSeqExpr options)
Returns the rank of a value in a data set as a percentage of the data set.
|
XsPositiveIntegerExpr |
XsExpr.positiveInteger(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:positiveInteger server data type.
|
XsQNameExpr |
XsExpr.QName(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:QName server data type.
|
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.
|
XsBooleanExpr |
SemExpr.sameTerm(XsAnyAtomicTypeExpr a,
String b)
Returns true if the arguments are the same RDF term as defined by the RDF concepts specification.
|
XsBooleanExpr |
SemExpr.sameTerm(XsAnyAtomicTypeExpr a,
XsAnyAtomicTypeExpr b)
Returns true if the arguments are the same RDF term as defined by the RDF concepts specification.
|
XsShortExpr |
XsExpr.shortExpr(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:short server data type.
|
XsStringExpr |
XsExpr.string(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:string server data type.
|
XsAnyAtomicTypeExpr |
FnExpr.sum(XsAnyAtomicTypeSeqExpr arg,
XsAnyAtomicTypeExpr zero)
Returns a value obtained by adding together the values in arg.
|
XsTimeExpr |
XsExpr.time(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:time server data type.
|
XsTokenExpr |
XsExpr.token(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:token server data type.
|
XsQNameExpr |
XdmpExpr.type(XsAnyAtomicTypeExpr value)
Returns the name of the simple type of the atomic value argument as an
xs:QName. |
XsUnsignedByteExpr |
XsExpr.unsignedByte(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:unsignedByte server data type.
|
XsUnsignedIntExpr |
XsExpr.unsignedInt(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:unsignedInt server data type.
|
XsUnsignedLongExpr |
XsExpr.unsignedLong(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:unsignedLong server data type.
|
XsUnsignedShortExpr |
XsExpr.unsignedShort(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:unsignedShort server data type.
|
XsUntypedAtomicExpr |
XsExpr.untypedAtomic(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:untypedAtomic server data type.
|
abstract AttributeNodeExpr |
PlanBuilder.xmlAttribute(XsQNameExpr name,
XsAnyAtomicTypeExpr value)
This function constructs an XML attribute with the name (which can be a string or QName) and atomic value.
|
abstract CommentNodeExpr |
PlanBuilder.xmlComment(XsAnyAtomicTypeExpr content)
This function constructs an XML comment with the atomic value.
|
abstract ProcessingInstructionNodeExpr |
PlanBuilder.xmlPi(XsStringExpr name,
XsAnyAtomicTypeExpr value)
This function constructs an XML processing instruction with the atomic value.
|
abstract TextNodeExpr |
PlanBuilder.xmlText(XsAnyAtomicTypeExpr value)
This function constructs an XML text node with the specified value.
|
XsYearMonthDurationExpr |
XsExpr.yearMonthDuration(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:yearMonthDuration server data type.
|
| 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 |
RdfLangStringExpr
An instance of an RDF language string expression.
|
interface |
RdfLangStringVal
A sequence of RDF language string values.
|
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 |
XsAnyAtomicTypeVal
An instance of a server atomic 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.