| 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 |
|---|---|
abstract XsBooleanExpr |
PlanBuilder.and(XsAnyAtomicTypeExpr... left)
This function returns
true if the specified expressions all return true. |
XsBooleanExpr |
FnExpr.booleanExpr(ItemSeqExpr arg)
Computes the effective boolean value of the sequence arg.
|
XsBooleanExpr |
XsExpr.booleanExpr(XsAnyAtomicTypeExpr arg1)
Constructs or casts an expression to the xs:boolean server data type.
|
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.
|
XsBooleanExpr |
FnExpr.codepointEqual(XsStringExpr comparand1,
String comparand2)
Returns
true if the specified parameters are the same Unicode code point, otherwise returns false. |
XsBooleanExpr |
FnExpr.codepointEqual(XsStringExpr comparand1,
XsStringExpr comparand2)
Returns
true if the specified parameters are the same Unicode code point, otherwise returns false. |
XsBooleanExpr |
MapExpr.contains(MapMapExpr map,
String key)
Returns true if the key exists in the map.
|
XsBooleanExpr |
MapExpr.contains(MapMapExpr map,
XsStringExpr key)
Returns true if the key exists in the map.
|
XsBooleanExpr |
FnExpr.contains(XsStringExpr parameter1,
String parameter2)
Returns
true if the first parameter contains the string from the second parameter, otherwise returns false. |
XsBooleanExpr |
FnExpr.contains(XsStringExpr parameter1,
String parameter2,
String collation)
Returns
true if the first parameter contains the string from the second parameter, otherwise returns false. |
XsBooleanExpr |
FnExpr.contains(XsStringExpr parameter1,
XsStringExpr parameter2)
Returns
true if the first parameter contains the string from the second parameter, otherwise returns false. |
XsBooleanExpr |
FnExpr.contains(XsStringExpr parameter1,
XsStringExpr parameter2,
XsStringExpr collation)
Returns
true if the first parameter contains the string from the second parameter, otherwise returns false. |
XsBooleanExpr |
FnExpr.deepEqual(ItemSeqExpr parameter1,
ItemSeqExpr parameter2)
This function assesses whether two sequences are deep-equal to each other.
|
XsBooleanExpr |
FnExpr.deepEqual(ItemSeqExpr parameter1,
ItemSeqExpr parameter2,
String collation)
This function assesses whether two sequences are deep-equal to each other.
|
XsBooleanExpr |
FnExpr.deepEqual(ItemSeqExpr parameter1,
ItemSeqExpr parameter2,
XsStringExpr collation)
This function assesses whether two sequences are deep-equal to each other.
|
XsBooleanExpr |
FnExpr.empty(ItemSeqExpr arg)
If the value of arg is the empty sequence, the function returns true; otherwise, the function returns false.
|
XsBooleanExpr |
FnExpr.endsWith(XsStringExpr parameter1,
String parameter2)
Returns
true if the first parameter ends with the string from the second parameter, otherwise returns false. |
XsBooleanExpr |
FnExpr.endsWith(XsStringExpr parameter1,
String parameter2,
String collation)
Returns
true if the first parameter ends with the string from the second parameter, otherwise returns false. |
XsBooleanExpr |
FnExpr.endsWith(XsStringExpr parameter1,
XsStringExpr parameter2)
Returns
true if the first parameter ends with the string from the second parameter, otherwise returns false. |
XsBooleanExpr |
FnExpr.endsWith(XsStringExpr parameter1,
XsStringExpr parameter2,
XsStringExpr collation)
Returns
true if the first parameter ends with the string from the second parameter, otherwise returns false. |
abstract XsBooleanExpr |
PlanBuilder.eq(XsAnyAtomicTypeExpr left,
XsAnyAtomicTypeExpr right)
This function returns
true if the left and right expressions return the same value. |
XsBooleanExpr |
FnExpr.exists(ItemSeqExpr arg)
If the value of arg is not the empty sequence, the function returns true; otherwise, the function returns false.
|
XsBooleanExpr |
FnExpr.falseExpr()
Returns the
xs:boolean value false. |
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. |
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. |
XsBooleanExpr |
SemExpr.isBlank(XsAnyAtomicTypeExpr value)
Returns true if the argument is an RDF blank node - that is, derived from type
sem:blank. |
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.
|
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.
|
XsBooleanExpr |
FnExpr.lang(XsStringExpr testlang,
NodeExpr node)
This function tests whether the language of node, or the context node if the second argument is omitted, as specified by xml:lang attributes is the same as, or is a sublanguage of, the language specified by testlang.
|
XsBooleanExpr |
SemExpr.langMatches(XsStringExpr langTag,
String langRange)
Returns true if
lang-tag matches lang-range according to the basic filtering scheme defined in RFC4647. |
XsBooleanExpr |
SemExpr.langMatches(XsStringExpr langTag,
XsStringExpr langRange)
Returns true if
lang-tag matches lang-range according to the basic filtering scheme defined in RFC4647. |
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. |
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. |
XsBooleanExpr |
FnExpr.matches(XsStringExpr input,
String pattern)
Returns
true if the specified input matches the specified pattern, otherwise returns false. |
XsBooleanExpr |
FnExpr.matches(XsStringExpr input,
String pattern,
String flags)
Returns
true if the specified input matches the specified pattern, otherwise returns false. |
XsBooleanExpr |
FnExpr.matches(XsStringExpr input,
XsStringExpr pattern)
Returns
true if the specified input matches the specified pattern, otherwise returns false. |
XsBooleanExpr |
FnExpr.matches(XsStringExpr input,
XsStringExpr pattern,
XsStringExpr flags)
Returns
true if the specified input matches the specified pattern, otherwise returns false. |
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. |
XsBooleanExpr |
FnExpr.nilled(NodeExpr arg)
Summary: Returns an xs:boolean indicating whether the argument node is “nilled”.
|
XsBooleanExpr |
FnExpr.not(ItemSeqExpr arg)
Returns
true if the effective boolean value is false, and false if the effective boolean value is true. |
abstract XsBooleanExpr |
PlanBuilder.not(XsAnyAtomicTypeExpr operand)
This function returns
true if neither of the specified boolean expressions return true. |
abstract XsBooleanExpr |
PlanBuilder.or(XsAnyAtomicTypeExpr... left)
This function returns
true if the specified expressions all return true. |
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.
|
XsBooleanExpr |
FnExpr.startsWith(XsStringExpr parameter1,
String parameter2)
Returns
true if the first parameter starts with the string from the second parameter, otherwise returns false. |
XsBooleanExpr |
FnExpr.startsWith(XsStringExpr parameter1,
String parameter2,
String collation)
Returns
true if the first parameter starts with the string from the second parameter, otherwise returns false. |
XsBooleanExpr |
FnExpr.startsWith(XsStringExpr parameter1,
XsStringExpr parameter2)
Returns
true if the first parameter starts with the string from the second parameter, otherwise returns false. |
XsBooleanExpr |
FnExpr.startsWith(XsStringExpr parameter1,
XsStringExpr parameter2,
XsStringExpr collation)
Returns
true if the first parameter starts with the string from the second parameter, otherwise returns false. |
XsBooleanExpr |
FnExpr.trueExpr()
Returns the
xs:boolean value true. |
| Modifier and Type | Method and Description |
|---|---|
ItemSeqExpr |
JsonExpr.arrayValues(JsonArrayExpr array,
XsBooleanExpr flatten)
Returns the array values as an XQuery sequence.
|
XsBooleanSeqExpr |
XsExpr.booleanExprSeq(XsBooleanExpr... items)
Constructs a sequence of XsBooleanExpr items.
|
ItemSeqExpr |
SemExpr.ifExpr(XsBooleanExpr condition,
ItemSeqExpr then,
ItemSeqExpr elseExpr)
The IF function form evaluates the first argument, interprets it as a effective boolean value, then returns the value of expression2 if the EBV is true, otherwise it returns the value of expression3.
|
PlanBuilder.ModifyPlan |
PlanBuilder.ModifyPlan.joinCrossProduct(PlanBuilder.ModifyPlan right,
XsBooleanExpr condition)
This method yields one output row set that concatenates every left row with every right row.
|
PlanBuilder.ModifyPlan |
PlanBuilder.ModifyPlan.joinInner(PlanBuilder.ModifyPlan right,
PlanJoinKeySeq keys,
XsBooleanExpr condition)
This method returns all rows from multiple tables where the join condition is met.
|
PlanBuilder.ModifyPlan |
PlanBuilder.ModifyPlan.joinLeftOuter(PlanBuilder.ModifyPlan right,
PlanJoinKeySeq keys,
XsBooleanExpr condition)
This method yields one output row set with the rows from an inner join as well as rows from the left row set.
|
abstract BooleanNodeExpr |
PlanBuilder.jsonBoolean(XsBooleanExpr value)
This function constructs a JSON boolean node with the specified value.
|
XsStringExpr |
XdmpExpr.path(NodeExpr node,
XsBooleanExpr includeDocument)
Returns a string whose value corresponds to the path of the node.
|
XsStringExpr |
XdmpExpr.urlEncode(XsStringExpr plaintext,
XsBooleanExpr noSpacePlus)
Converts plaintext into URL-encoded string.
|
abstract PlanCase |
PlanBuilder.when(XsBooleanExpr condition,
ItemExpr... value)
This function executes the specified expression if the specified condition is
true for the row. |
| 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 |
XsBooleanVal
An instance of a server boolean value.
|
Copyright © 2013-2017 MarkLogic Corporation.