public abstract class PlanBuilder extends Object
Builds the plan for a row pipeline to execute on the server.
| Modifier and Type | Class and Description |
|---|---|
static interface |
PlanBuilder.AccessPlan
Provides functions and operations in the access phase of the plan for executing a row pipeline on the server.
|
static interface |
PlanBuilder.ExportablePlan
Provides functions and operations in the exportable phase of the plan for executing a row pipeline on the server.
|
static interface |
PlanBuilder.ModifyPlan
Provides functions and operations in the modify phase of the plan for executing a row pipeline on the server.
|
static interface |
PlanBuilder.Plan
Provides functions and operations in the final phase of the plan for executing a row pipeline on the server.
|
static interface |
PlanBuilder.PreparePlan
Provides functions and operations in the prepare phase of the plan for executing a row pipeline on the server.
|
static interface |
PlanBuilderBase.AccessPlanBase |
static interface |
PlanBuilderBase.ExportablePlanBase |
static interface |
PlanBuilderBase.ModifyPlanBase |
static interface |
PlanBuilderBase.PlanBase |
static interface |
PlanBuilderBase.PreparePlanBase |
| Modifier and Type | Field and Description |
|---|---|
CtsExpr |
cts
Builds expressions with cts server functions.
|
FnExpr |
fn
Builds expressions with fn server functions.
|
JsonExpr |
json
Builds expressions with json server functions.
|
MapExpr |
map
Builds expressions with map server functions.
|
MathExpr |
math
Builds expressions with math server functions.
|
RdfExpr |
rdf
Builds expressions with rdf server functions.
|
SemExpr |
sem
Builds expressions with sem server functions.
|
SpellExpr |
spell
Builds expressions with spell server functions.
|
SqlExpr |
sql
Builds expressions with sql server functions.
|
XdmpExpr |
xdmp
Builds expressions with xdmp server functions.
|
XsExpr |
xs
Builds expressions with xs server functions.
|
| Modifier and Type | Method and Description |
|---|---|
abstract XsNumericExpr |
add(XsNumericExpr... left)
This function returns the sum of the specified numeric expressions.
|
abstract PlanAggregateColSeq |
aggregateSeq(PlanAggregateCol... aggregate) |
abstract XsBooleanExpr |
and(XsAnyAtomicTypeExpr... left)
This function returns
true if the specified expressions all return true. |
abstract PlanAggregateCol |
arrayAggregate(PlanColumn name,
PlanExprCol column)
This function constructs an array whose items are the result of evaluating the column for each row in the group or row set.
|
abstract PlanAggregateCol |
arrayAggregate(PlanColumn name,
PlanExprCol column,
PlanValueOption option)
This function constructs an array whose items are the result of evaluating the column for each row in the group or row set.
|
abstract PlanAggregateCol |
arrayAggregate(String name,
String column)
This function constructs an array whose items are the result of evaluating the column for each row in the group or row set.
|
abstract PlanAggregateCol |
arrayAggregate(String name,
String column,
PlanValueOption option)
This function constructs an array whose items are the result of evaluating the column for each row in the group or row set.
|
abstract PlanExprCol |
as(PlanColumn column,
ItemSeqExpr expression)
This function defines a column by assigning the value of an expression over the rows in the row set.
|
abstract PlanExprCol |
as(String column,
ItemSeqExpr expression)
This function defines a column by assigning the value of an expression over the rows in the row set.
|
abstract PlanSortKey |
asc(PlanExprCol column)
This function sorts the specified
columndef in ascending order. |
abstract PlanSortKey |
asc(String column)
This function sorts the specified
columndef in ascending order. |
abstract PlanAggregateCol |
avg(PlanColumn name,
PlanExprCol column)
This function averages the non-null values of the column for the rows in the group or row set.
|
abstract PlanAggregateCol |
avg(PlanColumn name,
PlanExprCol column,
PlanValueOption option)
This function averages the non-null values of the column for the rows in the group or row set.
|
abstract PlanAggregateCol |
avg(String name,
String column)
This function averages the non-null values of the column for the rows in the group or row set.
|
abstract PlanAggregateCol |
avg(String name,
String column,
PlanValueOption option)
This function averages the non-null values of the column for the rows in the group or row set.
|
abstract ItemSeqExpr |
caseExpr(PlanCase... cases)
This function returns the specified
valueExpression if the specified valueExpression is true. |
abstract PlanColumn |
col(String column)
This method identifies a column, where the column name is unique.
|
abstract PlanColumn |
col(XsStringVal column)
This method identifies a column, where the column name is unique.
|
abstract PlanExprColSeq |
colSeq(PlanExprCol... col) |
abstract PlanExprColSeq |
colSeq(String... col) |
abstract PlanAggregateCol |
count(PlanColumn name)
This function counts the rows where the specified input column has a value.
|
abstract PlanAggregateCol |
count(PlanColumn name,
PlanExprCol column)
This function counts the rows where the specified input column has a value.
|
abstract PlanAggregateCol |
count(PlanColumn name,
PlanExprCol column,
PlanValueOption option)
This function counts the rows where the specified input column has a value.
|
abstract PlanAggregateCol |
count(String name)
This function counts the rows where the specified input column has a value.
|
abstract PlanAggregateCol |
count(String name,
String column)
This function counts the rows where the specified input column has a value.
|
abstract PlanAggregateCol |
count(String name,
String column,
PlanValueOption option)
This function counts the rows where the specified input column has a value.
|
abstract PlanSortKey |
desc(PlanExprCol column)
This function sorts the specified
columndef in descending order. |
abstract PlanSortKey |
desc(String column)
This function sorts the specified
columndef in descending order. |
abstract XsNumericExpr |
divide(XsNumericExpr left,
XsNumericExpr right)
This function divides the left
numericExpression by the right numericExpression and returns the value. |
abstract PlanCase |
elseExpr(ItemExpr value) |
abstract XsBooleanExpr |
eq(XsAnyAtomicTypeExpr left,
XsAnyAtomicTypeExpr right)
This function returns
true if the left and right expressions return the same value. |
abstract PlanSystemColumn |
fragmentIdCol(String column)
Specifies a name for adding a fragment id column to the row set identifying the source documents for the rows from a view, lexicons or triples.
|
abstract PlanSystemColumn |
fragmentIdCol(XsStringVal column)
Specifies a name for adding a fragment id column to the row set identifying the source documents for the rows from a view, lexicons or triples.
|
abstract PlanBuilder.AccessPlan |
fromLexicons(Map<String,CtsReferenceExpr> indexes)
This function dynamically constructs a view from range indexes or the uri or collection lexicons.
|
abstract PlanBuilder.AccessPlan |
fromLexicons(Map<String,CtsReferenceExpr> indexes,
String qualifierName)
This function dynamically constructs a view from range indexes or the uri or collection lexicons.
|
abstract PlanBuilder.AccessPlan |
fromLexicons(Map<String,CtsReferenceExpr> indexes,
String qualifierName,
PlanSystemColumn sysCols)
This function dynamically constructs a view from range indexes or the uri or collection lexicons.
|
abstract PlanBuilder.AccessPlan |
fromLexicons(Map<String,CtsReferenceExpr> indexes,
XsStringVal qualifierName)
This function dynamically constructs a view from range indexes or the uri or collection lexicons.
|
abstract PlanBuilder.AccessPlan |
fromLexicons(Map<String,CtsReferenceExpr> indexes,
XsStringVal qualifierName,
PlanSystemColumn sysCols)
This function dynamically constructs a view from range indexes or the uri or collection lexicons.
|
PlanBuilder.AccessPlan |
fromLiterals(Map<String,Object>... rows)
Constructs a literal row set as in the SQL VALUES or SPARQL VALUES statements.
|
abstract PlanBuilder.AccessPlan |
fromLiterals(Map<String,Object>[] rows,
String qualifierName)
Constructs a literal row set as in the SQL VALUES or SPARQL VALUES statements.
|
abstract PlanBuilder.AccessPlan |
fromLiterals(Map<String,Object>[] rows,
XsStringVal qualifierName)
Constructs a literal row set as in the SQL VALUES or SPARQL VALUES statements.
|
abstract PlanBuilder.AccessPlan |
fromTriples(PlanTriplePattern... patterns)
Reads rows by matching patterns in the triple index.
|
abstract PlanBuilder.AccessPlan |
fromTriples(PlanTriplePatternSeq patterns)
Reads rows by matching patterns in the triple index.
|
abstract PlanBuilder.AccessPlan |
fromTriples(PlanTriplePatternSeq patterns,
String qualifierName)
Reads rows by matching patterns in the triple index.
|
abstract PlanBuilder.AccessPlan |
fromTriples(PlanTriplePatternSeq patterns,
String qualifierName,
String graphIris)
Reads rows by matching patterns in the triple index.
|
abstract PlanBuilder.AccessPlan |
fromTriples(PlanTriplePatternSeq patterns,
String qualifierName,
String graphIris,
PlanTripleOption option)
Reads rows by matching patterns in the triple index.
|
abstract PlanBuilder.AccessPlan |
fromTriples(PlanTriplePatternSeq patterns,
XsStringVal qualifierName)
Reads rows by matching patterns in the triple index.
|
abstract PlanBuilder.AccessPlan |
fromTriples(PlanTriplePatternSeq patterns,
XsStringVal qualifierName,
XsStringSeqVal graphIris)
Reads rows by matching patterns in the triple index.
|
abstract PlanBuilder.AccessPlan |
fromTriples(PlanTriplePatternSeq patterns,
XsStringVal qualifierName,
XsStringSeqVal graphIris,
PlanTripleOption option)
Reads rows by matching patterns in the triple index.
|
abstract PlanBuilder.AccessPlan |
fromView(String schema,
String view)
This function reads a row set from a configured view over TDE-indexed rows or a predefined view over range indexes.
|
abstract PlanBuilder.AccessPlan |
fromView(String schema,
String view,
String qualifierName)
This function reads a row set from a configured view over TDE-indexed rows or a predefined view over range indexes.
|
abstract PlanBuilder.AccessPlan |
fromView(String schema,
String view,
String qualifierName,
PlanSystemColumn sysCols)
This function reads a row set from a configured view over TDE-indexed rows or a predefined view over range indexes.
|
abstract PlanBuilder.AccessPlan |
fromView(XsStringVal schema,
XsStringVal view)
This function reads a row set from a configured view over TDE-indexed rows or a predefined view over range indexes.
|
abstract PlanBuilder.AccessPlan |
fromView(XsStringVal schema,
XsStringVal view,
XsStringVal qualifierName)
This function reads a row set from a configured view over TDE-indexed rows or a predefined view over range indexes.
|
abstract PlanBuilder.AccessPlan |
fromView(XsStringVal schema,
XsStringVal view,
XsStringVal qualifierName,
PlanSystemColumn sysCols)
This function reads a row set from a configured view over TDE-indexed rows or a predefined view over range indexes.
|
abstract XsBooleanExpr |
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 PlanSystemColumn |
graphCol(String column)
Identifies the graph for a triple providing one or more columns for a row.
|
abstract PlanSystemColumn |
graphCol(XsStringVal column)
Identifies the graph for a triple providing one or more columns for a row.
|
abstract PlanAggregateCol |
groupConcat(PlanColumn name,
PlanExprCol column)
This function concatenates the non-null values of the column for the rows in the group or row set.
|
abstract PlanAggregateCol |
groupConcat(PlanColumn name,
PlanExprCol column,
PlanGroupConcatOptionSeq options)
This function concatenates the non-null values of the column for the rows in the group or row set.
|
abstract PlanAggregateCol |
groupConcat(String name,
String column)
This function concatenates the non-null values of the column for the rows in the group or row set.
|
abstract PlanAggregateCol |
groupConcat(String name,
String column,
PlanGroupConcatOptionSeq options)
This function concatenates the non-null values of the column for the rows in the group or row set.
|
PlanGroupConcatOptionSeq |
groupConcatOptions(PlanValueOption option)
Specifies options for aggregating the values of a column for the rows
belonging to each group by concatenating the values into a single string value.
|
PlanGroupConcatOptionSeq |
groupConcatOptions(String separator)
Specifies options for aggregating the values of a column for the rows
belonging to each group by concatenating the values into a single string value.
|
PlanGroupConcatOptionSeq |
groupConcatOptions(String separator,
PlanValueOption option)
Specifies options for aggregating the values of a column for the rows
belonging to each group by concatenating the values into a single string value.
|
abstract XsBooleanExpr |
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. |
abstract XsBooleanExpr |
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.
|
abstract PlanJoinKeySeq |
joinKeySeq(PlanJoinKey... key) |
abstract ArrayNodeExpr |
jsonArray(JsonContentNodeExpr... property)
This function constructs a JSON array during row processing.
|
abstract BooleanNodeExpr |
jsonBoolean(boolean value)
This function constructs a JSON boolean node with the specified value.
|
abstract BooleanNodeExpr |
jsonBoolean(XsBooleanExpr value)
This function constructs a JSON boolean node with the specified value.
|
abstract DocumentNodeExpr |
jsonDocument(JsonRootNodeExpr root)
This function constructs a JSON document with the root content, which must be exactly one JSON object or array node.
|
abstract NullNodeExpr |
jsonNull()
This function constructs a JSON null node.
|
abstract NumberNodeExpr |
jsonNumber(double value)
This function constructs a JSON number node with the specified value.
|
abstract NumberNodeExpr |
jsonNumber(XsNumericExpr value)
This function constructs a JSON number node with the specified value.
|
abstract ObjectNodeExpr |
jsonObject(PlanJsonProperty... property)
This function constructs a JSON object with the specified properties.
|
abstract TextNodeExpr |
jsonString(String value)
This function constructs a JSON text node with the specified value.
|
abstract TextNodeExpr |
jsonString(XsAnyAtomicTypeExpr value)
This function constructs a JSON text node with the specified value.
|
abstract XsBooleanExpr |
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 |
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. |
abstract PlanAggregateCol |
max(PlanColumn name,
PlanExprCol column)
This function gets the largest non-null value of the column for the rows in the group or row set.
|
abstract PlanAggregateCol |
max(PlanColumn name,
PlanExprCol column,
PlanValueOption option)
This function gets the largest non-null value of the column for the rows in the group or row set.
|
abstract PlanAggregateCol |
max(String name,
String column)
This function gets the largest non-null value of the column for the rows in the group or row set.
|
abstract PlanAggregateCol |
max(String name,
String column,
PlanValueOption option)
This function gets the largest non-null value of the column for the rows in the group or row set.
|
abstract PlanAggregateCol |
min(PlanColumn name,
PlanExprCol column)
This function gets the smallest non-null value of the column for the rows in the group or row set.
|
abstract PlanAggregateCol |
min(PlanColumn name,
PlanExprCol column,
PlanValueOption option)
This function gets the smallest non-null value of the column for the rows in the group or row set.
|
abstract PlanAggregateCol |
min(String name,
String column)
This function gets the smallest non-null value of the column for the rows in the group or row set.
|
abstract PlanAggregateCol |
min(String name,
String column,
PlanValueOption option)
This function gets the smallest non-null value of the column for the rows in the group or row set.
|
abstract XsNumericExpr |
modulo(double left,
double right)
This function returns the remainder afer the division of the dividend and divisor expressions.
|
abstract XsNumericExpr |
modulo(XsNumericExpr left,
XsNumericExpr right)
This function returns the remainder afer the division of the dividend and divisor expressions.
|
abstract XsNumericExpr |
multiply(XsNumericExpr... left)
This function multipies the left
numericExpression by the right numericExpression and returns the value. |
abstract XsBooleanExpr |
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. |
abstract XsBooleanExpr |
not(XsAnyAtomicTypeExpr operand)
This function returns
true if neither of the specified boolean expressions return true. |
abstract PlanTriplePositionSeq |
objectSeq(PlanTriplePosition... object) |
abstract PlanJoinKey |
on(PlanExprCol left,
PlanExprCol right)
Specifies an equijoin using one columndef each from the left and right rows.
|
abstract PlanJoinKey |
on(String left,
String right)
Specifies an equijoin using one columndef each from the left and right rows.
|
abstract XsBooleanExpr |
or(XsAnyAtomicTypeExpr... left)
This function returns
true if the specified expressions all return true. |
abstract PlanParamExpr |
param(String name)
This function creates a placeholder for a literal value in an expression or as the offset or max for a limit.
|
abstract PlanParamExpr |
param(XsStringVal name)
This function creates a placeholder for a literal value in an expression or as the offset or max for a limit.
|
abstract PlanTriplePattern |
pattern(PlanTriplePositionSeq subjects,
PlanTriplePositionSeq predicates,
PlanTriplePositionSeq objects)
This function builds the parameters for the op:from-triples function.
|
abstract PlanTriplePattern |
pattern(PlanTriplePositionSeq subjects,
PlanTriplePositionSeq predicates,
PlanTriplePositionSeq objects,
PlanSystemColumnSeq sysCols)
This function builds the parameters for the op:from-triples function.
|
abstract PlanTriplePatternSeq |
patternSeq(PlanTriplePattern... pattern) |
abstract PlanTriplePositionSeq |
predicateSeq(PlanTriplePosition... predicate) |
abstract PlanPrefixer |
prefixer(String base)
This function factory returns a new function that takes a name parameter and returns a sem:iri, prepending the specified base URI onto the name.
|
abstract PlanPrefixer |
prefixer(XsStringVal base)
This function factory returns a new function that takes a name parameter and returns a sem:iri, prepending the specified base URI onto the name.
|
abstract PlanJsonProperty |
prop(String key,
JsonContentNodeExpr value)
This function specifies the key expression and value content for a JSON property of a JSON object contructed by the op:json-object function.
|
abstract PlanJsonProperty |
prop(XsStringExpr key,
JsonContentNodeExpr value)
This function specifies the key expression and value content for a JSON property of a JSON object contructed by the op:json-object function.
|
abstract PlanFunction |
resolveFunction(String functionName,
String modulePath) |
PlanFunction |
resolveFunction(XsQNameVal functionName,
String modulePath)
Specifies a JavaScript or XQuery function installed on the server for use
in post-processing in a map() or reduce() operation.
|
abstract PlanFunction |
resolveFunction(XsQNameVal functionName,
XsStringVal modulePath) |
abstract PlanAggregateCol |
sample(PlanColumn name,
PlanExprCol column)
This function randomly selects one non-null value of the column from the rows in the group or row set.
|
abstract PlanAggregateCol |
sample(String name,
String column)
This function randomly selects one non-null value of the column from the rows in the group or row set.
|
abstract PlanColumn |
schemaCol(String schema,
String view,
String column)
Unambiguously identifies a column with the schema name, view name, and column name.
|
abstract PlanColumn |
schemaCol(XsStringVal schema,
XsStringVal view,
XsStringVal column)
Unambiguously identifies a column with the schema name, view name, and column name.
|
abstract PlanAggregateCol |
sequenceAggregate(PlanColumn name,
PlanExprCol column)
This call constructs a sequence whose items are the values of a column for each row in the group or row set.
|
abstract PlanAggregateCol |
sequenceAggregate(PlanColumn name,
PlanExprCol column,
PlanValueOption option)
This call constructs a sequence whose items are the values of a column for each row in the group or row set.
|
abstract PlanAggregateCol |
sequenceAggregate(String name,
String column)
This call constructs a sequence whose items are the values of a column for each row in the group or row set.
|
abstract PlanAggregateCol |
sequenceAggregate(String name,
String column,
PlanValueOption option)
This call constructs a sequence whose items are the values of a column for each row in the group or row set.
|
abstract PlanSortKeySeq |
sortKeySeq(PlanSortKey... key) |
abstract PlanTriplePositionSeq |
subjectSeq(PlanTriplePosition... subject) |
abstract XsNumericExpr |
subtract(XsNumericExpr left,
XsNumericExpr right)
This function subtracts the right
numericExpression from the left numericExpression and returns the value. |
abstract PlanAggregateCol |
sum(PlanColumn name,
PlanExprCol column)
This function adds the non-null values of the column for the rows in the group or row set.
|
abstract PlanAggregateCol |
sum(PlanColumn name,
PlanExprCol column,
PlanValueOption option)
This function adds the non-null values of the column for the rows in the group or row set.
|
abstract PlanAggregateCol |
sum(String name,
String column)
This function adds the non-null values of the column for the rows in the group or row set.
|
abstract PlanAggregateCol |
sum(String name,
String column,
PlanValueOption option)
This function adds the non-null values of the column for the rows in the group or row set.
|
abstract PlanAggregateCol |
uda(PlanColumn name,
PlanExprCol column,
XsStringVal module,
XsStringVal function)
This function processes the values of column for each row in the group or row set with the specified user-defined aggregate as implemented by an aggregate user-defined function (UDF) plugin.
|
abstract PlanAggregateCol |
uda(PlanColumn name,
PlanExprCol column,
XsStringVal module,
XsStringVal function,
XsAnyAtomicTypeVal arg)
This function processes the values of column for each row in the group or row set with the specified user-defined aggregate as implemented by an aggregate user-defined function (UDF) plugin.
|
abstract PlanAggregateCol |
uda(String name,
String column,
String module,
String function)
This function processes the values of column for each row in the group or row set with the specified user-defined aggregate as implemented by an aggregate user-defined function (UDF) plugin.
|
abstract PlanAggregateCol |
uda(String name,
String column,
String module,
String function,
String arg)
This function processes the values of column for each row in the group or row set with the specified user-defined aggregate as implemented by an aggregate user-defined function (UDF) plugin.
|
abstract PlanColumn |
viewCol(String view,
String column)
Identifies a column where the combination of view and column name is unique.
|
abstract PlanColumn |
viewCol(XsStringVal view,
XsStringVal column)
Identifies a column where the combination of view and column name is unique.
|
abstract PlanCase |
when(boolean condition,
ItemExpr... value)
This function executes the specified expression if the specified condition is
true for the row. |
abstract PlanCase |
when(XsBooleanExpr condition,
ItemExpr... value)
This function executes the specified expression if the specified condition is
true for the row. |
PlanCase |
when(XsBooleanExpr condition,
ItemSeqExpr value)
This function returns the specified
value if the specified condition is true. |
abstract AttributeNodeExpr |
xmlAttribute(String name,
String value)
This function constructs an XML attribute with the name (which can be a string or QName) and atomic value.
|
abstract AttributeNodeExpr |
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 AttributeNodeSeqExpr |
xmlAttributeSeq(AttributeNodeExpr... attribute) |
abstract CommentNodeExpr |
xmlComment(String content)
This function constructs an XML comment with the atomic value.
|
abstract CommentNodeExpr |
xmlComment(XsAnyAtomicTypeExpr content)
This function constructs an XML comment with the atomic value.
|
abstract DocumentNodeExpr |
xmlDocument(XmlRootNodeExpr root)
This function constructs an XML document with the root content, which must be exactly one node.
|
abstract ElementNodeExpr |
xmlElement(String name)
This function constructs an XML element with the name (which can be a string or QName), zero or more attributes, and child content.
|
abstract ElementNodeExpr |
xmlElement(String name,
AttributeNodeExpr... attributes)
This function constructs an XML element with the name (which can be a string or QName), zero or more attributes, and child content.
|
abstract ElementNodeExpr |
xmlElement(String name,
AttributeNodeSeqExpr attributes,
XmlContentNodeExpr... content)
This function constructs an XML element with the name (which can be a string or QName), zero or more attributes, and child content.
|
abstract ElementNodeExpr |
xmlElement(XsQNameExpr name)
This function constructs an XML element with the name (which can be a string or QName), zero or more attributes, and child content.
|
abstract ElementNodeExpr |
xmlElement(XsQNameExpr name,
AttributeNodeSeqExpr attributes)
This function constructs an XML element with the name (which can be a string or QName), zero or more attributes, and child content.
|
abstract ElementNodeExpr |
xmlElement(XsQNameExpr name,
AttributeNodeSeqExpr attributes,
XmlContentNodeExpr... content)
This function constructs an XML element with the name (which can be a string or QName), zero or more attributes, and child content.
|
ElementNodeExpr |
xmlElement(XsQNameExpr name,
AttributeNodeSeqExpr attributes,
XmlContentNodeSeqExpr content)
This function constructs an XML element with the name (which can be a string or QName), a sequence of zero or more attributes, and child content.
|
abstract ProcessingInstructionNodeExpr |
xmlPi(String name,
String value)
This function constructs an XML processing instruction with the atomic value.
|
abstract ProcessingInstructionNodeExpr |
xmlPi(XsStringExpr name,
XsAnyAtomicTypeExpr value)
This function constructs an XML processing instruction with the atomic value.
|
abstract TextNodeExpr |
xmlText(String value)
This function constructs an XML text node with the specified value.
|
abstract TextNodeExpr |
xmlText(XsAnyAtomicTypeExpr value)
This function constructs an XML text node with the specified value.
|
abstract NodeSeqExpr |
xpath(PlanColumn column,
XsStringExpr path)
This function extracts a sequence of child nodes from a column with node values – especially, the document nodes from a document join.
|
abstract NodeSeqExpr |
xpath(String column,
String path)
This function extracts a sequence of child nodes from a column with node values – especially, the document nodes from a document join.
|
public final CtsExpr cts
Builds expressions with cts server functions.
public final FnExpr fn
Builds expressions with fn server functions.
public final JsonExpr json
Builds expressions with json server functions.
public final MapExpr map
Builds expressions with map server functions.
public final MathExpr math
Builds expressions with math server functions.
public final RdfExpr rdf
Builds expressions with rdf server functions.
public final SemExpr sem
Builds expressions with sem server functions.
public final SpellExpr spell
Builds expressions with spell server functions.
public final SqlExpr sql
Builds expressions with sql server functions.
public final XdmpExpr xdmp
Builds expressions with xdmp server functions.
public final XsExpr xs
Builds expressions with xs server functions.
public abstract XsNumericExpr add(XsNumericExpr... left)
This function returns the sum of the specified numeric expressions. In expressions, the call should pass the result from an op:col function to identify a column.
The op:add function differs from the op:sum function in that it operates on operates on multiple column values in a row, rather than a group of rows.
As a convenience, you can pass a sequence of any number of expressions as the first argument: op:add((expr1, expr2, …, exprN))
Provides a client interface to a server function. See op:add
left - The left value expression.public abstract XsBooleanExpr and(XsAnyAtomicTypeExpr... left)
This function returns true if the specified expressions all return true. Otherwise, it returns false. You can either compair
As a convenience, you can pass a sequence of any number of expressions as the first argument: op:and((expr1, expr2, …, exprN))
Provides a client interface to a server function. See op:and
left - The left value expression.public abstract XsNumericExpr divide(XsNumericExpr left, XsNumericExpr right)
This function divides the left numericExpression by the right numericExpression and returns the value.
Provides a client interface to a server function. See op:divide
left - The left numeric expression.right - The right numeric expression.public abstract XsBooleanExpr eq(XsAnyAtomicTypeExpr left, XsAnyAtomicTypeExpr right)
This function returns true if the left and right expressions return the same value. Otherwise, it returns false. In expressions, the call should pass the result from an op:col function to identify a column.
Provides a client interface to a server function. See op:eq
left - The left value expression.right - The right value expression.public abstract XsBooleanExpr 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. Otherwise, it returns false.
Provides a client interface to a server function. See op:ge
left - The left value expression.right - The right value expression.public abstract XsBooleanExpr 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. Otherwise, it returns false.
Provides a client interface to a server function. See op:gt
left - The left value expression.right - The right value expression.public abstract XsBooleanExpr 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.
Provides a client interface to a server function. See op:is-defined
public abstract XsBooleanExpr 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. Otherwise, it returns false.
Provides a client interface to a server function. See op:le
left - The left value expression.right - The right value expression.public abstract XsBooleanExpr 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. Otherwise, it returns false.
Provides a client interface to a server function. See op:lt
left - The left value expression.right - The right value expression.public abstract XsNumericExpr multiply(XsNumericExpr... left)
This function multipies the left numericExpression by the right numericExpression and returns the value.
As a convenience, you can pass a sequence of any number of expressions as the first argument: op:multiply((expr1, expr2, …, exprN))
Provides a client interface to a server function. See op:multiply
left - The left numeric expression.public abstract XsBooleanExpr 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. Otherwise, it returns false.
Provides a client interface to a server function. See op:ne
left - The left value expression.right - The right value expression.public abstract XsBooleanExpr not(XsAnyAtomicTypeExpr operand)
This function returns true if neither of the specified boolean expressions return true. Otherwise, it returns false.
Provides a client interface to a server function. See op:not
operand - Exactly one boolean expression, such as op:and or op:or, or op:is-defined.public abstract XsBooleanExpr or(XsAnyAtomicTypeExpr... left)
This function returns true if the specified expressions all return true. Otherwise, it returns false.
As a convenience, you can pass a sequence of any number of expressions as the first argument: op:or((expr1, expr2, …, exprN))
Provides a client interface to a server function. See op:or
left - The left value expression.public abstract XsNumericExpr subtract(XsNumericExpr left, XsNumericExpr right)
This function subtracts the right numericExpression from the left numericExpression and returns the value.
Provides a client interface to a server function. See op:subtract
left - The left numeric expression.right - The right numeric expression.public abstract PlanParamExpr param(String name)
This function creates a placeholder for a literal value in an expression or as the offset or max for a limit. The op:result function throws in an error if the binding parameter does not specify a literal value for the parameter.
Provides a client interface to a server function. See op:param
name - The name of the parameter.public abstract PlanParamExpr param(XsStringVal name)
This function creates a placeholder for a literal value in an expression or as the offset or max for a limit. The op:result function throws in an error if the binding parameter does not specify a literal value for the parameter.
Provides a client interface to a server function. See op:param
name - The name of the parameter.public abstract PlanColumn col(String column)
This method identifies a column, where the column name is unique. A qualifier on the column name isn’t necessary (and might not exist). In positions where only a column name can appear, the unqualified column name can also be provided as a string. Qualified column names cannot be provided as a string.
column - The Optic AccessorPlan created by op:from-view, op:from-triples, or op:from-lexicons.public abstract PlanColumn col(XsStringVal column)
This method identifies a column, where the column name is unique. A qualifier on the column name isn’t necessary (and might not exist). In positions where only a column name can appear, the unqualified column name can also be provided as a string. Qualified column names cannot be provided as a string.
column - The Optic AccessorPlan created by op:from-view, op:from-triples, or op:from-lexicons.public abstract PlanColumn schemaCol(String schema, String view, String column)
Unambiguously identifies a column with the schema name, view name, and column name. Useful only for columns provided by a view.
schema - The name of the schema.view - The name of the view.column - The name of the column.public abstract PlanColumn schemaCol(XsStringVal schema, XsStringVal view, XsStringVal column)
Unambiguously identifies a column with the schema name, view name, and column name. Useful only for columns provided by a view.
schema - The name of the schema.view - The name of the view.column - The name of the column.public abstract PlanColumn viewCol(String view, String column)
Identifies a column where the combination of view and column name is unique. Identifying the schema isn’t necessary (and it might not exist).
If the combination of view and column name is not unique, an ambiguous column error is thrown.
view - The name of the view.column - The name of the column.public abstract PlanColumn viewCol(XsStringVal view, XsStringVal column)
Identifies a column where the combination of view and column name is unique. Identifying the schema isn’t necessary (and it might not exist).
If the combination of view and column name is not unique, an ambiguous column error is thrown.
view - The name of the view.column - The name of the column.public abstract PlanSystemColumn fragmentIdCol(String column)
Specifies a name for adding a fragment id column to the row set identifying the source documents for the rows from a view, lexicons or triples. The only use for the fragment id is joining other rows from the same document, the document uri, or the document content. The fragment id is only useful during execution of the query and not after.
public abstract PlanSystemColumn fragmentIdCol(XsStringVal column)
Specifies a name for adding a fragment id column to the row set identifying the source documents for the rows from a view, lexicons or triples. The only use for the fragment id is joining other rows from the same document, the document uri, or the document content. The fragment id is only useful during execution of the query and not after.
public abstract PlanSystemColumn graphCol(String column)
Identifies the graph for a triple providing one or more columns for a row. You pass the graph column as a system column parameter to the op:pattern function.
column - The name to use for the graph column.public abstract PlanSystemColumn graphCol(XsStringVal column)
Identifies the graph for a triple providing one or more columns for a row. You pass the graph column as a system column parameter to the op:pattern function.
column - The name to use for the graph column.public abstract PlanExprCol as(String column, ItemSeqExpr expression)
This function defines a column by assigning the value of an expression over the rows in the row set.
column - The name of the column to be defined. This can be either a string or the return value from op:col, op:view-col, or op:schema-col.expression - The expression used to define the value the column.public abstract PlanExprCol as(PlanColumn column, ItemSeqExpr expression)
This function defines a column by assigning the value of an expression over the rows in the row set.
column - The name of the column to be defined. This can be either a string or the return value from op:col, op:view-col, or op:schema-col.expression - The expression used to define the value the column.public abstract PlanExprColSeq colSeq(String... col)
public abstract PlanExprColSeq colSeq(PlanExprCol... col)
public abstract PlanBuilder.AccessPlan fromView(String schema, String view)
This function reads a row set from a configured view over TDE-indexed rows or a predefined view over range indexes.
This function creates a row set without a limit. Use op:limit or op:offset-limit to set a limit.
schema - The name identifying the schema containing the view. If the schema name is null, the engine searches for a view with the specified name.view - The name identifying a configured template or range view for rows projected from documents.public abstract PlanBuilder.AccessPlan fromView(XsStringVal schema, XsStringVal view)
This function reads a row set from a configured view over TDE-indexed rows or a predefined view over range indexes.
This function creates a row set without a limit. Use op:limit or op:offset-limit to set a limit.
schema - The name identifying the schema containing the view. If the schema name is null, the engine searches for a view with the specified name.view - The name identifying a configured template or range view for rows projected from documents.public abstract PlanBuilder.AccessPlan fromView(String schema, String view, String qualifierName)
This function reads a row set from a configured view over TDE-indexed rows or a predefined view over range indexes.
This function creates a row set without a limit. Use op:limit or op:offset-limit to set a limit.
schema - The name identifying the schema containing the view. If the schema name is null, the engine searches for a view with the specified name.view - The name identifying a configured template or range view for rows projected from documents.qualifierName - Specifies a name for qualifying the column names in place of the combination of the schema and view names. Use cases for the qualifier include self joins. Using an empty string removes all qualification from the column names.public abstract PlanBuilder.AccessPlan fromView(XsStringVal schema, XsStringVal view, XsStringVal qualifierName)
This function reads a row set from a configured view over TDE-indexed rows or a predefined view over range indexes.
This function creates a row set without a limit. Use op:limit or op:offset-limit to set a limit.
schema - The name identifying the schema containing the view. If the schema name is null, the engine searches for a view with the specified name.view - The name identifying a configured template or range view for rows projected from documents.qualifierName - Specifies a name for qualifying the column names in place of the combination of the schema and view names. Use cases for the qualifier include self joins. Using an empty string removes all qualification from the column names.public abstract PlanBuilder.AccessPlan fromView(String schema, String view, String qualifierName, PlanSystemColumn sysCols)
This function reads a row set from a configured view over TDE-indexed rows or a predefined view over range indexes.
This function creates a row set without a limit. Use op:limit or op:offset-limit to set a limit.
schema - The name identifying the schema containing the view. If the schema name is null, the engine searches for a view with the specified name.view - The name identifying a configured template or range view for rows projected from documents.qualifierName - Specifies a name for qualifying the column names in place of the combination of the schema and view names. Use cases for the qualifier include self joins. Using an empty string removes all qualification from the column names.sysCols - An optional named fragment id column returned by op:fragment-id-col. One use case for fragment ids is in joins with lexicons or document content.public abstract PlanBuilder.AccessPlan fromView(XsStringVal schema, XsStringVal view, XsStringVal qualifierName, PlanSystemColumn sysCols)
This function reads a row set from a configured view over TDE-indexed rows or a predefined view over range indexes.
This function creates a row set without a limit. Use op:limit or op:offset-limit to set a limit.
schema - The name identifying the schema containing the view. If the schema name is null, the engine searches for a view with the specified name.view - The name identifying a configured template or range view for rows projected from documents.qualifierName - Specifies a name for qualifying the column names in place of the combination of the schema and view names. Use cases for the qualifier include self joins. Using an empty string removes all qualification from the column names.sysCols - An optional named fragment id column returned by op:fragment-id-col. One use case for fragment ids is in joins with lexicons or document content.public abstract PlanPrefixer prefixer(String base)
This function factory returns a new function that takes a name parameter and returns a sem:iri, prepending the specified base URI onto the name.
base - The base URI to be prepended to the name.public abstract PlanPrefixer prefixer(XsStringVal base)
This function factory returns a new function that takes a name parameter and returns a sem:iri, prepending the specified base URI onto the name.
base - The base URI to be prepended to the name.public abstract PlanBuilder.AccessPlan fromTriples(PlanTriplePattern... patterns)
Reads rows by matching patterns in the triple index.
The rows have a column for each column name in the patterns. While each column will have a consistent datatype for all rows from a view, the columns of rows from a graph may have varying data types, which could affect joins.
This function creates a row set without a limit. Use op:limit or op:offset-limit to set a limit.
patterns - One or more pattern definitions returned by the op:pattern function.public abstract PlanBuilder.AccessPlan fromTriples(PlanTriplePatternSeq patterns)
Reads rows by matching patterns in the triple index.
The rows have a column for each column name in the patterns. While each column will have a consistent datatype for all rows from a view, the columns of rows from a graph may have varying data types, which could affect joins.
This function creates a row set without a limit. Use op:limit or op:offset-limit to set a limit.
patterns - One or more pattern definitions returned by the op:pattern function.public abstract PlanBuilder.AccessPlan fromTriples(PlanTriplePatternSeq patterns, String qualifierName)
Reads rows by matching patterns in the triple index.
The rows have a column for each column name in the patterns. While each column will have a consistent datatype for all rows from a view, the columns of rows from a graph may have varying data types, which could affect joins.
This function creates a row set without a limit. Use op:limit or op:offset-limit to set a limit.
patterns - One or more pattern definitions returned by the op:pattern function.qualifierName - Specifies a name for qualifying the column names. By default, triple rows have no qualification. Use cases for the qualifier include self joins. Using an empty string removes all qualification from the column names.public abstract PlanBuilder.AccessPlan fromTriples(PlanTriplePatternSeq patterns, XsStringVal qualifierName)
Reads rows by matching patterns in the triple index.
The rows have a column for each column name in the patterns. While each column will have a consistent datatype for all rows from a view, the columns of rows from a graph may have varying data types, which could affect joins.
This function creates a row set without a limit. Use op:limit or op:offset-limit to set a limit.
patterns - One or more pattern definitions returned by the op:pattern function.qualifierName - Specifies a name for qualifying the column names. By default, triple rows have no qualification. Use cases for the qualifier include self joins. Using an empty string removes all qualification from the column names.public abstract PlanBuilder.AccessPlan fromTriples(PlanTriplePatternSeq patterns, String qualifierName, String graphIris)
Reads rows by matching patterns in the triple index.
The rows have a column for each column name in the patterns. While each column will have a consistent datatype for all rows from a view, the columns of rows from a graph may have varying data types, which could affect joins.
This function creates a row set without a limit. Use op:limit or op:offset-limit to set a limit.
patterns - One or more pattern definitions returned by the op:pattern function.qualifierName - Specifies a name for qualifying the column names. By default, triple rows have no qualification. Use cases for the qualifier include self joins. Using an empty string removes all qualification from the column names.graphIris - A list of graph IRIs to restrict the results to triples in the specified graphs. The sem:default-graph-iri function returns the iri that identifies the default graph.public abstract PlanBuilder.AccessPlan fromTriples(PlanTriplePatternSeq patterns, XsStringVal qualifierName, XsStringSeqVal graphIris)
Reads rows by matching patterns in the triple index.
The rows have a column for each column name in the patterns. While each column will have a consistent datatype for all rows from a view, the columns of rows from a graph may have varying data types, which could affect joins.
This function creates a row set without a limit. Use op:limit or op:offset-limit to set a limit.
patterns - One or more pattern definitions returned by the op:pattern function.qualifierName - Specifies a name for qualifying the column names. By default, triple rows have no qualification. Use cases for the qualifier include self joins. Using an empty string removes all qualification from the column names.graphIris - A list of graph IRIs to restrict the results to triples in the specified graphs. The sem:default-graph-iri function returns the iri that identifies the default graph.public abstract PlanBuilder.AccessPlan fromTriples(PlanTriplePatternSeq patterns, String qualifierName, String graphIris, PlanTripleOption option)
Reads rows by matching patterns in the triple index.
The rows have a column for each column name in the patterns. While each column will have a consistent datatype for all rows from a view, the columns of rows from a graph may have varying data types, which could affect joins.
This function creates a row set without a limit. Use op:limit or op:offset-limit to set a limit.
patterns - One or more pattern definitions returned by the op:pattern function.qualifierName - Specifies a name for qualifying the column names. By default, triple rows have no qualification. Use cases for the qualifier include self joins. Using an empty string removes all qualification from the column names.graphIris - A list of graph IRIs to restrict the results to triples in the specified graphs. The sem:default-graph-iri function returns the iri that identifies the default graph.option - Options consisting of key-value pairs that set options. At present, the options consist of dedup which can take an on|off value to enable or disable deduplication. Deduplication is off by default.public abstract PlanBuilder.AccessPlan fromTriples(PlanTriplePatternSeq patterns, XsStringVal qualifierName, XsStringSeqVal graphIris, PlanTripleOption option)
Reads rows by matching patterns in the triple index.
The rows have a column for each column name in the patterns. While each column will have a consistent datatype for all rows from a view, the columns of rows from a graph may have varying data types, which could affect joins.
This function creates a row set without a limit. Use op:limit or op:offset-limit to set a limit.
patterns - One or more pattern definitions returned by the op:pattern function.qualifierName - Specifies a name for qualifying the column names. By default, triple rows have no qualification. Use cases for the qualifier include self joins. Using an empty string removes all qualification from the column names.graphIris - A list of graph IRIs to restrict the results to triples in the specified graphs. The sem:default-graph-iri function returns the iri that identifies the default graph.option - Options consisting of key-value pairs that set options. At present, the options consist of dedup which can take an on|off value to enable or disable deduplication. Deduplication is off by default.public abstract PlanTriplePattern pattern(PlanTriplePositionSeq subjects, PlanTriplePositionSeq predicates, PlanTriplePositionSeq objects)
This function builds the parameters for the op:from-triples function. The result is passed to op:from-triples to project rows from the graph of triples. The columns in a pattern become the columns of the row. The literals in a pattern are used to match triples. You should specify at least one literal in each pattern, usually the predicate. Where a column appears in more than one pattern, the matched triples are joined to form the row. You can specify optional triples with a op:join-left-outer with a separate op:from-triples.
subjects - One column or one or more literal values, such as the literal returned by a sem:iri call.predicates - One column or one or more literal values, such as the literal returned by a sem.iri call.objects - One column or one or more literal values, such as the literal returned by a sem:iri call.public abstract PlanTriplePattern pattern(PlanTriplePositionSeq subjects, PlanTriplePositionSeq predicates, PlanTriplePositionSeq objects, PlanSystemColumnSeq sysCols)
This function builds the parameters for the op:from-triples function. The result is passed to op:from-triples to project rows from the graph of triples. The columns in a pattern become the columns of the row. The literals in a pattern are used to match triples. You should specify at least one literal in each pattern, usually the predicate. Where a column appears in more than one pattern, the matched triples are joined to form the row. You can specify optional triples with a op:join-left-outer with a separate op:from-triples.
subjects - One column or one or more literal values, such as the literal returned by a sem:iri call.predicates - One column or one or more literal values, such as the literal returned by a sem.iri call.objects - One column or one or more literal values, such as the literal returned by a sem:iri call.sysCols - Specifies the result of an op:fragment-id-col or op:graph-col function to add columns for the fragment id or graph iri.public abstract PlanTriplePatternSeq patternSeq(PlanTriplePattern... pattern)
public abstract PlanTriplePositionSeq subjectSeq(PlanTriplePosition... subject)
public abstract PlanTriplePositionSeq predicateSeq(PlanTriplePosition... predicate)
public abstract PlanTriplePositionSeq objectSeq(PlanTriplePosition... object)
public abstract PlanBuilder.AccessPlan fromLexicons(Map<String,CtsReferenceExpr> indexes)
This function dynamically constructs a view from range indexes or the uri or collection lexicons. This function will only return rows for documents where the first column has a value. The keys in the map specify the names of the columns and the values in the map provide cts:reference objects to specify the lexicon providing the values of the columns. Optic emits rows based on co-occurrence of lexicon values within the same document similar to cts:value-tuples If the cts:reference sets the nullable option to true, the column is optional in the row.
This function creates a row set without a limit. Use op:limit or op:offset-limit to set a limit.
indexes - An object in which each key is a column name and each value specifies a cts:reference for a range index or other lexicon (especially the cts:uri-reference lexicon) with the column values.public abstract PlanBuilder.AccessPlan fromLexicons(Map<String,CtsReferenceExpr> indexes, String qualifierName)
This function dynamically constructs a view from range indexes or the uri or collection lexicons. This function will only return rows for documents where the first column has a value. The keys in the map specify the names of the columns and the values in the map provide cts:reference objects to specify the lexicon providing the values of the columns. Optic emits rows based on co-occurrence of lexicon values within the same document similar to cts:value-tuples If the cts:reference sets the nullable option to true, the column is optional in the row.
This function creates a row set without a limit. Use op:limit or op:offset-limit to set a limit.
indexes - An object in which each key is a column name and each value specifies a cts:reference for a range index or other lexicon (especially the cts:uri-reference lexicon) with the column values.qualifierName - Specifies a name for qualifying the column names. By default, lexicon rows have no qualification. Use cases for the qualifier include self joins. Using an empty string removes all qualification from the column names.public abstract PlanBuilder.AccessPlan fromLexicons(Map<String,CtsReferenceExpr> indexes, XsStringVal qualifierName)
This function dynamically constructs a view from range indexes or the uri or collection lexicons. This function will only return rows for documents where the first column has a value. The keys in the map specify the names of the columns and the values in the map provide cts:reference objects to specify the lexicon providing the values of the columns. Optic emits rows based on co-occurrence of lexicon values within the same document similar to cts:value-tuples If the cts:reference sets the nullable option to true, the column is optional in the row.
This function creates a row set without a limit. Use op:limit or op:offset-limit to set a limit.
indexes - An object in which each key is a column name and each value specifies a cts:reference for a range index or other lexicon (especially the cts:uri-reference lexicon) with the column values.qualifierName - Specifies a name for qualifying the column names. By default, lexicon rows have no qualification. Use cases for the qualifier include self joins. Using an empty string removes all qualification from the column names.public abstract PlanBuilder.AccessPlan fromLexicons(Map<String,CtsReferenceExpr> indexes, String qualifierName, PlanSystemColumn sysCols)
This function dynamically constructs a view from range indexes or the uri or collection lexicons. This function will only return rows for documents where the first column has a value. The keys in the map specify the names of the columns and the values in the map provide cts:reference objects to specify the lexicon providing the values of the columns. Optic emits rows based on co-occurrence of lexicon values within the same document similar to cts:value-tuples If the cts:reference sets the nullable option to true, the column is optional in the row.
This function creates a row set without a limit. Use op:limit or op:offset-limit to set a limit.
indexes - An object in which each key is a column name and each value specifies a cts:reference for a range index or other lexicon (especially the cts:uri-reference lexicon) with the column values.qualifierName - Specifies a name for qualifying the column names. By default, lexicon rows have no qualification. Use cases for the qualifier include self joins. Using an empty string removes all qualification from the column names.sysCols - An optional named fragment id column returned by the op:fragment-id-col function. The fragment id column can be used for joins.public abstract PlanBuilder.AccessPlan fromLexicons(Map<String,CtsReferenceExpr> indexes, XsStringVal qualifierName, PlanSystemColumn sysCols)
This function dynamically constructs a view from range indexes or the uri or collection lexicons. This function will only return rows for documents where the first column has a value. The keys in the map specify the names of the columns and the values in the map provide cts:reference objects to specify the lexicon providing the values of the columns. Optic emits rows based on co-occurrence of lexicon values within the same document similar to cts:value-tuples If the cts:reference sets the nullable option to true, the column is optional in the row.
This function creates a row set without a limit. Use op:limit or op:offset-limit to set a limit.
indexes - An object in which each key is a column name and each value specifies a cts:reference for a range index or other lexicon (especially the cts:uri-reference lexicon) with the column values.qualifierName - Specifies a name for qualifying the column names. By default, lexicon rows have no qualification. Use cases for the qualifier include self joins. Using an empty string removes all qualification from the column names.sysCols - An optional named fragment id column returned by the op:fragment-id-col function. The fragment id column can be used for joins.public abstract PlanBuilder.AccessPlan fromLiterals(Map<String,Object>[] rows, String qualifierName)
Constructs a literal row set as in the SQL VALUES or SPARQL VALUES statements. When specifying rows with arrays, values are mapped to column names by position.
rows - This parameter is either an array of object literals or sem:binding objects in which the key is a column name string identifying the column and the value is a literal with the value of the column, or this parameter is an object with a columnNames key having a value of an array of column names and a rowValues key having a value of an array of arrays with literal values.qualifierName - Specifies a name for qualifying the column names in place of the combination of the schema and view names. Use cases for the qualifier include self joins. Using an empty string removes all qualification from the column names.public abstract PlanBuilder.AccessPlan fromLiterals(Map<String,Object>[] rows, XsStringVal qualifierName)
Constructs a literal row set as in the SQL VALUES or SPARQL VALUES statements. When specifying rows with arrays, values are mapped to column names by position.
rows - This parameter is either an array of object literals or sem:binding objects in which the key is a column name string identifying the column and the value is a literal with the value of the column, or this parameter is an object with a columnNames key having a value of an array of column names and a rowValues key having a value of an array of arrays with literal values.qualifierName - Specifies a name for qualifying the column names in place of the combination of the schema and view names. Use cases for the qualifier include self joins. Using an empty string removes all qualification from the column names.public abstract PlanJoinKey on(String left, String right)
Specifies an equijoin using one columndef each from the left and right rows. The result is used by the op:join-inner and op:join-left-outer functions.
Use op:view-col or op:col if you need to identify columns in the two views that have the same column name.
left - The rows from the left view.right - The row set from the right view.public abstract PlanJoinKey on(PlanExprCol left, PlanExprCol right)
Specifies an equijoin using one columndef each from the left and right rows. The result is used by the op:join-inner and op:join-left-outer functions.
Use op:view-col or op:col if you need to identify columns in the two views that have the same column name.
left - The rows from the left view.right - The row set from the right view.public abstract PlanJoinKeySeq joinKeySeq(PlanJoinKey... key)
public abstract PlanAggregateCol avg(String name, String column)
This function averages the non-null values of the column for the rows in the group or row set. The result is used for building the parameters used by the op:group-by function.
name - The name to be used for the aggregated column.column - The column to be aggregated.public abstract PlanAggregateCol avg(PlanColumn name, PlanExprCol column)
This function averages the non-null values of the column for the rows in the group or row set. The result is used for building the parameters used by the op:group-by function.
name - The name to be used for the aggregated column.column - The column to be aggregated.public abstract PlanAggregateCol avg(String name, String column, PlanValueOption option)
This function averages the non-null values of the column for the rows in the group or row set. The result is used for building the parameters used by the op:group-by function.
name - The name to be used for the aggregated column.column - The column to be aggregated.option - The options can take a values key with a distinct value to average the distinct values of the column.public abstract PlanAggregateCol avg(PlanColumn name, PlanExprCol column, PlanValueOption option)
This function averages the non-null values of the column for the rows in the group or row set. The result is used for building the parameters used by the op:group-by function.
name - The name to be used for the aggregated column.column - The column to be aggregated.option - The options can take a values key with a distinct value to average the distinct values of the column.public abstract PlanAggregateCol arrayAggregate(String name, String column)
This function constructs an array whose items are the result of evaluating the column for each row in the group or row set. The result is used for building the parameters used by the op:group-by function.
name - The name to be used for the aggregated column.column - The columns to be aggregated.public abstract PlanAggregateCol arrayAggregate(PlanColumn name, PlanExprCol column)
This function constructs an array whose items are the result of evaluating the column for each row in the group or row set. The result is used for building the parameters used by the op:group-by function.
name - The name to be used for the aggregated column.column - The columns to be aggregated.public abstract PlanAggregateCol arrayAggregate(String name, String column, PlanValueOption option)
This function constructs an array whose items are the result of evaluating the column for each row in the group or row set. The result is used for building the parameters used by the op:group-by function.
name - The name to be used for the aggregated column.column - The columns to be aggregated.option - The options can take a values key with a distinct value to average the distinct values of the column.public abstract PlanAggregateCol arrayAggregate(PlanColumn name, PlanExprCol column, PlanValueOption option)
This function constructs an array whose items are the result of evaluating the column for each row in the group or row set. The result is used for building the parameters used by the op:group-by function.
name - The name to be used for the aggregated column.column - The columns to be aggregated.option - The options can take a values key with a distinct value to average the distinct values of the column.public abstract PlanAggregateCol count(String name)
This function counts the rows where the specified input column has a value. If the input column is omitted, all rows in the group or row set are counted. The result is used for building the parameters used by the op:group-by function.
name - The name to be used for the column values.public abstract PlanAggregateCol count(PlanColumn name)
This function counts the rows where the specified input column has a value. If the input column is omitted, all rows in the group or row set are counted. The result is used for building the parameters used by the op:group-by function.
name - The name to be used for the column values.public abstract PlanAggregateCol count(String name, String column)
This function counts the rows where the specified input column has a value. If the input column is omitted, all rows in the group or row set are counted. The result is used for building the parameters used by the op:group-by function.
name - The name to be used for the column values.column - The columns to be counted.public abstract PlanAggregateCol count(PlanColumn name, PlanExprCol column)
This function counts the rows where the specified input column has a value. If the input column is omitted, all rows in the group or row set are counted. The result is used for building the parameters used by the op:group-by function.
name - The name to be used for the column values.column - The columns to be counted.public abstract PlanAggregateCol count(String name, String column, PlanValueOption option)
This function counts the rows where the specified input column has a value. If the input column is omitted, all rows in the group or row set are counted. The result is used for building the parameters used by the op:group-by function.
name - The name to be used for the column values.column - The columns to be counted.option - The options can take a values key with a distinct value to average the distinct values of the column.public abstract PlanAggregateCol count(PlanColumn name, PlanExprCol column, PlanValueOption option)
This function counts the rows where the specified input column has a value. If the input column is omitted, all rows in the group or row set are counted. The result is used for building the parameters used by the op:group-by function.
name - The name to be used for the column values.column - The columns to be counted.option - The options can take a values key with a distinct value to average the distinct values of the column.public abstract PlanAggregateCol groupConcat(String name, String column)
This function concatenates the non-null values of the column for the rows in the group or row set. The result is used for building the parameters used by the op:group-by function.
name - The name to be used for column with the concatenated values.column - The name of the column with the values to be concatenated for the group.public abstract PlanAggregateCol groupConcat(PlanColumn name, PlanExprCol column)
This function concatenates the non-null values of the column for the rows in the group or row set. The result is used for building the parameters used by the op:group-by function.
name - The name to be used for column with the concatenated values.column - The name of the column with the values to be concatenated for the group.public abstract PlanAggregateCol groupConcat(String name, String column, PlanGroupConcatOptionSeq options)
This function concatenates the non-null values of the column for the rows in the group or row set. The result is used for building the parameters used by the op:group-by function.
name - The name to be used for column with the concatenated values.column - The name of the column with the values to be concatenated for the group.options - The options can take a values key with a distinct value to average the distinct values of the column. In addition to the values key, the options can take a separator key specifying a separator character. The value can be a string or placeholder parameter.public abstract PlanAggregateCol groupConcat(PlanColumn name, PlanExprCol column, PlanGroupConcatOptionSeq options)
This function concatenates the non-null values of the column for the rows in the group or row set. The result is used for building the parameters used by the op:group-by function.
name - The name to be used for column with the concatenated values.column - The name of the column with the values to be concatenated for the group.options - The options can take a values key with a distinct value to average the distinct values of the column. In addition to the values key, the options can take a separator key specifying a separator character. The value can be a string or placeholder parameter.public abstract PlanAggregateCol max(String name, String column)
This function gets the largest non-null value of the column for the rows in the group or row set. The result is used for building the parameters used by the op:group-by function.
name - The name to be used for the largest value.column - The group or row set.public abstract PlanAggregateCol max(PlanColumn name, PlanExprCol column)
This function gets the largest non-null value of the column for the rows in the group or row set. The result is used for building the parameters used by the op:group-by function.
name - The name to be used for the largest value.column - The group or row set.public abstract PlanAggregateCol max(String name, String column, PlanValueOption option)
This function gets the largest non-null value of the column for the rows in the group or row set. The result is used for building the parameters used by the op:group-by function.
name - The name to be used for the largest value.column - The group or row set.option - The options can take a values key with a distinct value to average the distinct values of the column.public abstract PlanAggregateCol max(PlanColumn name, PlanExprCol column, PlanValueOption option)
This function gets the largest non-null value of the column for the rows in the group or row set. The result is used for building the parameters used by the op:group-by function.
name - The name to be used for the largest value.column - The group or row set.option - The options can take a values key with a distinct value to average the distinct values of the column.public abstract PlanAggregateCol min(String name, String column)
This function gets the smallest non-null value of the column for the rows in the group or row set. The result is used for building the parameters used by the op:group-by function.
name - The name to be used for the smallest value.column - The group or row set.public abstract PlanAggregateCol min(PlanColumn name, PlanExprCol column)
This function gets the smallest non-null value of the column for the rows in the group or row set. The result is used for building the parameters used by the op:group-by function.
name - The name to be used for the smallest value.column - The group or row set.public abstract PlanAggregateCol min(String name, String column, PlanValueOption option)
This function gets the smallest non-null value of the column for the rows in the group or row set. The result is used for building the parameters used by the op:group-by function.
name - The name to be used for the smallest value.column - The group or row set.option - The options can take a values key with a distinct value to average the distinct values of the column.public abstract PlanAggregateCol min(PlanColumn name, PlanExprCol column, PlanValueOption option)
This function gets the smallest non-null value of the column for the rows in the group or row set. The result is used for building the parameters used by the op:group-by function.
name - The name to be used for the smallest value.column - The group or row set.option - The options can take a values key with a distinct value to average the distinct values of the column.public abstract PlanAggregateCol sample(String name, String column)
This function randomly selects one non-null value of the column from the rows in the group or row set. The result is used for building the parameters used by the op:group-by function.
name - The name to be used for the value.column - The group or row set.public abstract PlanAggregateCol sample(PlanColumn name, PlanExprCol column)
This function randomly selects one non-null value of the column from the rows in the group or row set. The result is used for building the parameters used by the op:group-by function.
name - The name to be used for the value.column - The group or row set.public abstract PlanAggregateCol sequenceAggregate(String name, String column)
This call constructs a sequence whose items are the values of a column for each row in the group or row set. The result is used for building the parameters used by the op:group-by function.
name - The name to be used for the aggregated column.column - The column with the values to aggregate.public abstract PlanAggregateCol sequenceAggregate(PlanColumn name, PlanExprCol column)
This call constructs a sequence whose items are the values of a column for each row in the group or row set. The result is used for building the parameters used by the op:group-by function.
name - The name to be used for the aggregated column.column - The column with the values to aggregate.public abstract PlanAggregateCol sequenceAggregate(String name, String column, PlanValueOption option)
This call constructs a sequence whose items are the values of a column for each row in the group or row set. The result is used for building the parameters used by the op:group-by function.
name - The name to be used for the aggregated column.column - The column with the values to aggregate.option - The options can take a values key with a distinct value to average the distinct values of the column.public abstract PlanAggregateCol sequenceAggregate(PlanColumn name, PlanExprCol column, PlanValueOption option)
This call constructs a sequence whose items are the values of a column for each row in the group or row set. The result is used for building the parameters used by the op:group-by function.
name - The name to be used for the aggregated column.column - The column with the values to aggregate.option - The options can take a values key with a distinct value to average the distinct values of the column.public abstract PlanAggregateCol sum(String name, String column)
This function adds the non-null values of the column for the rows in the group or row set. The result is used for building the parameters used by the op:group-by function.
The op:sum function differs from the op:add function in that it operates on operates on a group of rows, rather than multiple column values in a row.
name - The name to be used for the aggregated column.column - The column with the values to add.public abstract PlanAggregateCol sum(PlanColumn name, PlanExprCol column)
This function adds the non-null values of the column for the rows in the group or row set. The result is used for building the parameters used by the op:group-by function.
The op:sum function differs from the op:add function in that it operates on operates on a group of rows, rather than multiple column values in a row.
name - The name to be used for the aggregated column.column - The column with the values to add.public abstract PlanAggregateCol sum(String name, String column, PlanValueOption option)
This function adds the non-null values of the column for the rows in the group or row set. The result is used for building the parameters used by the op:group-by function.
The op:sum function differs from the op:add function in that it operates on operates on a group of rows, rather than multiple column values in a row.
name - The name to be used for the aggregated column.column - The column with the values to add.option - The options can take a values key with a distinct value to average the distinct values of the column.public abstract PlanAggregateCol sum(PlanColumn name, PlanExprCol column, PlanValueOption option)
This function adds the non-null values of the column for the rows in the group or row set. The result is used for building the parameters used by the op:group-by function.
The op:sum function differs from the op:add function in that it operates on operates on a group of rows, rather than multiple column values in a row.
name - The name to be used for the aggregated column.column - The column with the values to add.option - The options can take a values key with a distinct value to average the distinct values of the column.public abstract PlanAggregateCol uda(String name, String column, String module, String function)
This function processes the values of column for each row in the group or row set with the specified user-defined aggregate as implemented by an aggregate user-defined function (UDF) plugin. The UDF plugin must be installed on each host. The result is used for building the parameters used by the op:group-by function.
For more information on UDF functions, see Aggregate User-Defined Functions in the Application Developer’s Guide.
name - The name to be used for the aggregated column.column - The column with the values to aggregate.module - The path to the installed plugin module.function - The name of the UDF function.public abstract PlanAggregateCol uda(PlanColumn name, PlanExprCol column, XsStringVal module, XsStringVal function)
This function processes the values of column for each row in the group or row set with the specified user-defined aggregate as implemented by an aggregate user-defined function (UDF) plugin. The UDF plugin must be installed on each host. The result is used for building the parameters used by the op:group-by function.
For more information on UDF functions, see Aggregate User-Defined Functions in the Application Developer’s Guide.
name - The name to be used for the aggregated column.column - The column with the values to aggregate.module - The path to the installed plugin module.function - The name of the UDF function.public abstract PlanAggregateCol uda(String name, String column, String module, String function, String arg)
This function processes the values of column for each row in the group or row set with the specified user-defined aggregate as implemented by an aggregate user-defined function (UDF) plugin. The UDF plugin must be installed on each host. The result is used for building the parameters used by the op:group-by function.
For more information on UDF functions, see Aggregate User-Defined Functions in the Application Developer’s Guide.
name - The name to be used for the aggregated column.column - The column with the values to aggregate.module - The path to the installed plugin module.function - The name of the UDF function.arg - The options can take a values key with a distinct value to average the distinct values of the column and an arg key specifying an argument for the user-defined aggregate. The value can be a string or placeholder parameter.public abstract PlanAggregateCol uda(PlanColumn name, PlanExprCol column, XsStringVal module, XsStringVal function, XsAnyAtomicTypeVal arg)
This function processes the values of column for each row in the group or row set with the specified user-defined aggregate as implemented by an aggregate user-defined function (UDF) plugin. The UDF plugin must be installed on each host. The result is used for building the parameters used by the op:group-by function.
For more information on UDF functions, see Aggregate User-Defined Functions in the Application Developer’s Guide.
name - The name to be used for the aggregated column.column - The column with the values to aggregate.module - The path to the installed plugin module.function - The name of the UDF function.arg - The options can take a values key with a distinct value to average the distinct values of the column and an arg key specifying an argument for the user-defined aggregate. The value can be a string or placeholder parameter.public abstract PlanAggregateColSeq aggregateSeq(PlanAggregateCol... aggregate)
public abstract PlanSortKey asc(String column)
This function sorts the specified columndef in ascending order. The results are used by the op:order-by function.
column - The column by which order the output.public abstract PlanSortKey asc(PlanExprCol column)
This function sorts the specified columndef in ascending order. The results are used by the op:order-by function.
column - The column by which order the output.public abstract PlanSortKey desc(String column)
This function sorts the specified columndef in descending order. The results are used by the op:order-by function.
column - The column by which order the output.public abstract PlanSortKey desc(PlanExprCol column)
This function sorts the specified columndef in descending order. The results are used by the op:order-by function.
column - The column by which order the output.public abstract PlanSortKeySeq sortKeySeq(PlanSortKey... key)
public abstract XsNumericExpr modulo(double left, double right)
This function returns the remainder afer the division of the dividend and divisor expressions. For example, op:modulo(5, 2) returns 1.
Provides a client interface to a server function. See op:modulo
left - The dividend numeric expression.right - The divisor numeric expression.public abstract XsNumericExpr modulo(XsNumericExpr left, XsNumericExpr right)
This function returns the remainder afer the division of the dividend and divisor expressions. For example, op:modulo(5, 2) returns 1.
Provides a client interface to a server function. See op:modulo
left - The dividend numeric expression.right - The divisor numeric expression.public abstract ItemSeqExpr caseExpr(PlanCase... cases)
This function returns the specified valueExpression if the specified valueExpression is true. Otherwise, it returns null.
Provides a client interface to a server function. See op:case
cases - One or more op:when expressions.public abstract PlanCase when(boolean condition, ItemExpr... value)
This function executes the specified expression if the specified condition is true for the row. Otherwise, the expression is not executed and the next ‘when’ test is checked or, if there is no next ‘when’ text, the otherwise expression for the op:case expression is executed.
condition - A boolean expression.value - The value expression to return if the boolean expression is true.public abstract PlanCase when(XsBooleanExpr condition, ItemExpr... value)
This function executes the specified expression if the specified condition is true for the row. Otherwise, the expression is not executed and the next ‘when’ test is checked or, if there is no next ‘when’ text, the otherwise expression for the op:case expression is executed.
condition - A boolean expression.value - The value expression to return if the boolean expression is true.public abstract NodeSeqExpr xpath(String column, String path)
This function extracts a sequence of child nodes from a column with node values – especially, the document nodes from a document join. The path is an XPath (specified as a string) to apply to each node to generate a sequence of nodes as an expression value.
Provides a client interface to a server function. See op:xpath
column - The name of the column from which to extract the child nodes.path - An XPath (specified as a string) to apply to each node.public abstract NodeSeqExpr xpath(PlanColumn column, XsStringExpr path)
This function extracts a sequence of child nodes from a column with node values – especially, the document nodes from a document join. The path is an XPath (specified as a string) to apply to each node to generate a sequence of nodes as an expression value.
Provides a client interface to a server function. See op:xpath
column - The name of the column from which to extract the child nodes.path - An XPath (specified as a string) to apply to each node.public abstract DocumentNodeExpr jsonDocument(JsonRootNodeExpr root)
This function constructs a JSON document with the root content, which must be exactly one JSON object or array node.
Provides a client interface to a server function. See op:json-document
root - The JSON object or array node used to construct the JSON document.public abstract ObjectNodeExpr jsonObject(PlanJsonProperty... property)
This function constructs a JSON object with the specified properties. The object can be used as the value of a column in a row or passed to a builtin function.
Provides a client interface to a server function. See op:json-object
property - The properties to be used to contruct the object. This is constructed by the op:prop function.public abstract PlanJsonProperty prop(String key, JsonContentNodeExpr value)
This function specifies the key expression and value content for a JSON property of a JSON object contructed by the op:json-object function.
key - The key expression. This must evaluate to a string.value - The value content. This must be exactly one JSON node expression.public abstract PlanJsonProperty prop(XsStringExpr key, JsonContentNodeExpr value)
This function specifies the key expression and value content for a JSON property of a JSON object contructed by the op:json-object function.
key - The key expression. This must evaluate to a string.value - The value content. This must be exactly one JSON node expression.public abstract ArrayNodeExpr jsonArray(JsonContentNodeExpr... property)
This function constructs a JSON array during row processing. The array can be used as the value of a column in a row or passed to a builtin expression function. The node is constructed during processing of the plan, rather than when building the plan.
Provides a client interface to a server function. See op:json-array
property - The JSON nodes for the array.public abstract TextNodeExpr jsonString(String value)
This function constructs a JSON text node with the specified value.
Provides a client interface to a server function. See op:json-string
value - The value of the JSON text node.public abstract TextNodeExpr jsonString(XsAnyAtomicTypeExpr value)
This function constructs a JSON text node with the specified value.
Provides a client interface to a server function. See op:json-string
value - The value of the JSON text node.public abstract NumberNodeExpr jsonNumber(double value)
This function constructs a JSON number node with the specified value.
Provides a client interface to a server function. See op:json-number
value - The value of the JSON number node.public abstract NumberNodeExpr jsonNumber(XsNumericExpr value)
This function constructs a JSON number node with the specified value.
Provides a client interface to a server function. See op:json-number
value - The value of the JSON number node.public abstract BooleanNodeExpr jsonBoolean(boolean value)
This function constructs a JSON boolean node with the specified value.
Provides a client interface to a server function. See op:json-boolean
value - The value of the JSON boolean node.public abstract BooleanNodeExpr jsonBoolean(XsBooleanExpr value)
This function constructs a JSON boolean node with the specified value.
Provides a client interface to a server function. See op:json-boolean
value - The value of the JSON boolean node.public abstract NullNodeExpr jsonNull()
This function constructs a JSON null node.
Provides a client interface to a server function. See op:json-null
public abstract DocumentNodeExpr xmlDocument(XmlRootNodeExpr root)
This function constructs an XML document with the root content, which must be exactly one node.
Provides a client interface to a server function. See op:xml-document
root - The XML node used to construct the XML document.public abstract ElementNodeExpr xmlElement(String name)
This function constructs an XML element with the name (which can be a string or QName), zero or more attributes, and child content. The child content can include a sequence or array of atomic values or an element, comment, or processing instruction nodes. Atomic values are converted to text nodes.
Provides a client interface to a server function. See op:xml-element
name - The string or QName for the constructed element.public abstract ElementNodeExpr xmlElement(XsQNameExpr name)
This function constructs an XML element with the name (which can be a string or QName), zero or more attributes, and child content. The child content can include a sequence or array of atomic values or an element, comment, or processing instruction nodes. Atomic values are converted to text nodes.
Provides a client interface to a server function. See op:xml-element
name - The string or QName for the constructed element.public abstract ElementNodeExpr xmlElement(String name, AttributeNodeExpr... attributes)
This function constructs an XML element with the name (which can be a string or QName), zero or more attributes, and child content. The child content can include a sequence or array of atomic values or an element, comment, or processing instruction nodes. Atomic values are converted to text nodes.
Provides a client interface to a server function. See op:xml-element
name - The string or QName for the constructed element.attributes - Any element attributes returned from op:xml-attribute, or null if no attributes.public abstract ElementNodeExpr xmlElement(XsQNameExpr name, AttributeNodeSeqExpr attributes)
This function constructs an XML element with the name (which can be a string or QName), zero or more attributes, and child content. The child content can include a sequence or array of atomic values or an element, comment, or processing instruction nodes. Atomic values are converted to text nodes.
Provides a client interface to a server function. See op:xml-element
name - The string or QName for the constructed element.attributes - Any element attributes returned from op:xml-attribute, or null if no attributes.public abstract ElementNodeExpr xmlElement(String name, AttributeNodeSeqExpr attributes, XmlContentNodeExpr... content)
This function constructs an XML element with the name (which can be a string or QName), zero or more attributes, and child content. The child content can include a sequence or array of atomic values or an element, comment, or processing instruction nodes. Atomic values are converted to text nodes.
Provides a client interface to a server function. See op:xml-element
name - The string or QName for the constructed element.attributes - Any element attributes returned from op:xml-attribute, or null if no attributes.content - A sequence or array of atomic values or an element, a comment from op:xml-comment, or processing instruction nodes from op:xml-pi.public abstract ElementNodeExpr xmlElement(XsQNameExpr name, AttributeNodeSeqExpr attributes, XmlContentNodeExpr... content)
This function constructs an XML element with the name (which can be a string or QName), zero or more attributes, and child content. The child content can include a sequence or array of atomic values or an element, comment, or processing instruction nodes. Atomic values are converted to text nodes.
Provides a client interface to a server function. See op:xml-element
name - The string or QName for the constructed element.attributes - Any element attributes returned from op:xml-attribute, or null if no attributes.content - A sequence or array of atomic values or an element, a comment from op:xml-comment, or processing instruction nodes from op:xml-pi.public abstract AttributeNodeExpr xmlAttribute(String name, String value)
This function constructs an XML attribute with the name (which can be a string or QName) and atomic value.
Provides a client interface to a server function. See op:xml-attribute
name - The attribute name.value - The attribute value.public abstract AttributeNodeExpr xmlAttribute(XsQNameExpr name, XsAnyAtomicTypeExpr value)
This function constructs an XML attribute with the name (which can be a string or QName) and atomic value.
Provides a client interface to a server function. See op:xml-attribute
name - The attribute name.value - The attribute value.public abstract TextNodeExpr xmlText(String value)
This function constructs an XML text node with the specified value.
Provides a client interface to a server function. See op:xml-text
value - The value of the XML text node.public abstract TextNodeExpr xmlText(XsAnyAtomicTypeExpr value)
This function constructs an XML text node with the specified value.
Provides a client interface to a server function. See op:xml-text
value - The value of the XML text node.public abstract CommentNodeExpr xmlComment(String content)
This function constructs an XML comment with the atomic value.
Provides a client interface to a server function. See op:xml-comment
content - The comment text.public abstract CommentNodeExpr xmlComment(XsAnyAtomicTypeExpr content)
This function constructs an XML comment with the atomic value.
Provides a client interface to a server function. See op:xml-comment
content - The comment text.public abstract ProcessingInstructionNodeExpr xmlPi(String name, String value)
This function constructs an XML processing instruction with the atomic value.
Provides a client interface to a server function. See op:xml-pi
name - The name of the processing instruction.value - The value of the processing instruction.public abstract ProcessingInstructionNodeExpr xmlPi(XsStringExpr name, XsAnyAtomicTypeExpr value)
This function constructs an XML processing instruction with the atomic value.
Provides a client interface to a server function. See op:xml-pi
name - The name of the processing instruction.value - The value of the processing instruction.public abstract AttributeNodeSeqExpr xmlAttributeSeq(AttributeNodeExpr... attribute)
public abstract PlanFunction resolveFunction(String functionName, String modulePath)
public abstract PlanFunction resolveFunction(XsQNameVal functionName, XsStringVal modulePath)
public PlanBuilder.AccessPlan fromLiterals(Map<String,Object>... rows)
rows - This parameter provides any number of objects in which the key is a column name string identifying the column and the value is a literal with the value of the column.public ElementNodeExpr xmlElement(XsQNameExpr name, AttributeNodeSeqExpr attributes, XmlContentNodeSeqExpr content)
Provides a client interface to a server function. See op:xml-element
name - The string or QName for the constructed element.attributes - Any element attributes returned from op:xml-attribute, or null if no attributes.content - A sequence or array of atomic values or an element, a comment from op:xml-comment, or processing instruction nodes from op:xml-pi.public PlanCase when(XsBooleanExpr condition, ItemSeqExpr value)
value if the specified condition is true. Otherwise, it returns null.condition - A boolean expression.value - The value expression to return if the boolean expression is true.public PlanFunction resolveFunction(XsQNameVal functionName, String modulePath)
functionName - the name of the function installed on the servermodulePath - the path on the server for the library module providing the functionpublic PlanGroupConcatOptionSeq groupConcatOptions(String separator)
separator - a string for separating the valuespublic PlanGroupConcatOptionSeq groupConcatOptions(PlanValueOption option)
option - an option controlling whether to concatenate all values including duplicates or concatenate distinct valuespublic PlanGroupConcatOptionSeq groupConcatOptions(String separator, PlanValueOption option)
separator - a string for separating the valuesoption - an option controlling whether to concatenate all values including duplicates or concatenate distinct valuesCopyright © 2013-2017 MarkLogic Corporation.