public abstract class PlanBuilder extends java.lang.Object implements PlanBuilderBase
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.
|
PlanBuilderBase.AccessPlanBase, PlanBuilderBase.ExportablePlanBase, PlanBuilderBase.ModifyPlanBase, PlanBuilderBase.PlanBase, PlanBuilderBase.PreparePlanBase
Modifier and Type | Field and Description |
---|---|
CtsExpr |
cts
Builds expressions with cts server functions.
|
FnExpr |
fn
Builds expressions with fn server functions.
|
GeoExpr |
geo
Builds expressions with geo 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 | Constructor and Description |
---|---|
protected |
PlanBuilder(CtsExpr cts,
FnExpr fn,
GeoExpr geo,
JsonExpr json,
MapExpr map,
MathExpr math,
RdfExpr rdf,
SemExpr sem,
SpellExpr spell,
SqlExpr sql,
XdmpExpr xdmp,
XsExpr xs) |
Modifier and Type | Method and Description |
---|---|
abstract ServerExpression |
add(ServerExpression... left)
This function returns the sum of the specified numeric expressions.
|
abstract PlanAggregateColSeq |
aggregateSeq(PlanAggregateCol... aggregate) |
abstract ServerExpression |
and(ServerExpression... 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(java.lang.String name,
java.lang.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(java.lang.String name,
java.lang.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,
ServerExpression expression)
This function defines a column by assigning the value of an expression over the rows in the row set.
|
abstract PlanExprCol |
as(java.lang.String column,
ServerExpression 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(java.lang.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(java.lang.String name,
java.lang.String column)
This function averages the non-null values of the column for the rows in the group or row set.
|
abstract PlanAggregateCol |
avg(java.lang.String name,
java.lang.String column,
PlanValueOption option)
This function averages the non-null values of the column for the rows in the group or row set.
|
abstract PlanColumn |
col(java.lang.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(java.lang.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(java.lang.String name)
This function counts the rows where the specified input column has a value.
|
abstract PlanAggregateCol |
count(java.lang.String name,
java.lang.String column)
This function counts the rows where the specified input column has a value.
|
abstract PlanAggregateCol |
count(java.lang.String name,
java.lang.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(java.lang.String column)
This function sorts the specified columndef in descending order.
|
abstract ServerExpression |
divide(ServerExpression left,
ServerExpression right)
This function divides the left numericExpression by the right numericExpression and returns the value.
|
abstract ServerExpression |
eq(ServerExpression... left)
This function returns true if the left and right expressions return the same value.
|
abstract PlanSystemColumn |
fragmentIdCol(java.lang.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(java.util.Map<java.lang.String,CtsReferenceExpr> indexes)
This function dynamically constructs a view from range indexes or the uri or collection lexicons.
|
abstract PlanBuilder.AccessPlan |
fromLexicons(java.util.Map<java.lang.String,CtsReferenceExpr> indexes,
java.lang.String qualifierName)
This function dynamically constructs a view from range indexes or the uri or collection lexicons.
|
abstract PlanBuilder.AccessPlan |
fromLexicons(java.util.Map<java.lang.String,CtsReferenceExpr> indexes,
java.lang.String qualifierName,
PlanSystemColumn sysCols)
This function dynamically constructs a view from range indexes or the uri or collection lexicons.
|
abstract PlanBuilder.AccessPlan |
fromLexicons(java.util.Map<java.lang.String,CtsReferenceExpr> indexes,
XsStringVal qualifierName)
This function dynamically constructs a view from range indexes or the uri or collection lexicons.
|
abstract PlanBuilder.AccessPlan |
fromLexicons(java.util.Map<java.lang.String,CtsReferenceExpr> indexes,
XsStringVal qualifierName,
PlanSystemColumn sysCols)
This function dynamically constructs a view from range indexes or the uri or collection lexicons.
|
abstract PlanBuilder.ModifyPlan |
fromSparql(java.lang.String select)
This function dynamically constructs a row set based on a SPARQL SELECT query from triples.
|
abstract PlanBuilder.ModifyPlan |
fromSparql(java.lang.String select,
java.lang.String qualifierName)
This function dynamically constructs a row set based on a SPARQL SELECT query from triples.
|
abstract PlanBuilder.ModifyPlan |
fromSparql(XsStringVal select)
This function dynamically constructs a row set based on a SPARQL SELECT query from triples.
|
abstract PlanBuilder.ModifyPlan |
fromSparql(XsStringVal select,
XsStringVal qualifierName)
This function dynamically constructs a row set based on a SPARQL SELECT query from triples.
|
abstract PlanBuilder.ModifyPlan |
fromSql(java.lang.String select)
This function dynamically constructs a row set based on a SQL SELECT query from views.
|
abstract PlanBuilder.ModifyPlan |
fromSql(java.lang.String select,
java.lang.String qualifierName)
This function dynamically constructs a row set based on a SQL SELECT query from views.
|
abstract PlanBuilder.ModifyPlan |
fromSql(XsStringVal select)
This function dynamically constructs a row set based on a SQL SELECT query from views.
|
abstract PlanBuilder.ModifyPlan |
fromSql(XsStringVal select,
XsStringVal qualifierName)
This function dynamically constructs a row set based on a SQL SELECT query from views.
|
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,
java.lang.String qualifierName)
Reads rows by matching patterns in the triple index.
|
abstract PlanBuilder.AccessPlan |
fromTriples(PlanTriplePatternSeq patterns,
java.lang.String qualifierName,
java.lang.String graphIris)
Reads rows by matching patterns in the triple index.
|
abstract PlanBuilder.AccessPlan |
fromTriples(PlanTriplePatternSeq patterns,
java.lang.String qualifierName,
java.lang.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(java.lang.String schema,
java.lang.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(java.lang.String schema,
java.lang.String view,
java.lang.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(java.lang.String schema,
java.lang.String view,
java.lang.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 ServerExpression |
ge(ServerExpression left,
ServerExpression 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(java.lang.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 ServerExpression |
gt(ServerExpression left,
ServerExpression right)
This function returns true if the value of the left expression is greater than the value of the right expression.
|
abstract ServerExpression |
isDefined(ServerExpression 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 ServerExpression |
jsonBoolean(boolean value)
This function constructs a JSON boolean node with the specified value.
|
abstract ServerExpression |
jsonBoolean(ServerExpression value)
This function constructs a JSON boolean node with the specified value.
|
abstract ServerExpression |
jsonDocument(ServerExpression root)
This function constructs a JSON document with the root content, which must be exactly one JSON object or array node.
|
abstract ServerExpression |
jsonNull()
This function constructs a JSON null node.
|
abstract ServerExpression |
jsonNumber(double value)
This function constructs a JSON number node with the specified value.
|
abstract ServerExpression |
jsonNumber(ServerExpression value)
This function constructs a JSON number node with the specified value.
|
abstract ServerExpression |
jsonString(ServerExpression value)
This function constructs a JSON text node with the specified value.
|
abstract ServerExpression |
jsonString(java.lang.String value)
This function constructs a JSON text node with the specified value.
|
abstract ServerExpression |
le(ServerExpression left,
ServerExpression 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 ServerExpression |
lt(ServerExpression left,
ServerExpression 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(java.lang.String name,
java.lang.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(java.lang.String name,
java.lang.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(java.lang.String name,
java.lang.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(java.lang.String name,
java.lang.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 ServerExpression |
modulo(double left,
double right)
This function returns the remainder afer the division of the dividend and divisor expressions.
|
abstract ServerExpression |
modulo(ServerExpression left,
ServerExpression right)
This function returns the remainder afer the division of the dividend and divisor expressions.
|
abstract ServerExpression |
multiply(ServerExpression... left)
This function multiplies the left numericExpression by the right numericExpression and returns the value.
|
abstract ServerExpression |
ne(ServerExpression left,
ServerExpression right)
This function returns true if the value of the left expression is not equal to the value of the right expression.
|
abstract ServerExpression |
not(ServerExpression 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(java.lang.String left,
java.lang.String right)
Specifies an equijoin using one columndef each from the left and right rows.
|
abstract ServerExpression |
or(ServerExpression... left)
This function returns true if the specified expressions all return true.
|
abstract PlanParamExpr |
param(java.lang.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(java.lang.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(ServerExpression key,
ServerExpression 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(java.lang.String key,
ServerExpression 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(java.lang.String functionName,
java.lang.String modulePath) |
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(java.lang.String name,
java.lang.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(java.lang.String schema,
java.lang.String view,
java.lang.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(java.lang.String name,
java.lang.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(java.lang.String name,
java.lang.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 PlanCondition |
sqlCondition(java.lang.String expression)
This function returns a filter definition as input for a WHERE operation.
|
abstract PlanCondition |
sqlCondition(XsStringVal expression)
This function returns a filter definition as input for a WHERE operation.
|
abstract PlanTriplePositionSeq |
subjectSeq(PlanTriplePosition... subject) |
abstract ServerExpression |
subtract(ServerExpression left,
ServerExpression 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(java.lang.String name,
java.lang.String column)
This function adds the non-null values of the column for the rows in the group or row set.
|
abstract PlanAggregateCol |
sum(java.lang.String name,
java.lang.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(java.lang.String name,
java.lang.String column,
java.lang.String module,
java.lang.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(java.lang.String name,
java.lang.String column,
java.lang.String module,
java.lang.String function,
java.lang.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(java.lang.String view,
java.lang.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,
ServerExpression... value)
This function executes the specified expression if the specified condition is true for the row.
|
abstract PlanCase |
when(ServerExpression condition,
ServerExpression... value)
This function executes the specified expression if the specified condition is true for the row.
|
abstract ServerExpression |
xmlAttribute(ServerExpression name,
ServerExpression value)
This function constructs an XML attribute with the name (which can be a string or QName) and atomic value.
|
abstract ServerExpression |
xmlAttribute(java.lang.String name,
java.lang.String value)
This function constructs an XML attribute with the name (which can be a string or QName) and atomic value.
|
abstract ServerExpression |
xmlAttributeSeq(ServerExpression... attribute) |
abstract ServerExpression |
xmlComment(ServerExpression content)
This function constructs an XML comment with the atomic value.
|
abstract ServerExpression |
xmlComment(java.lang.String content)
This function constructs an XML comment with the atomic value.
|
abstract ServerExpression |
xmlDocument(ServerExpression root)
This function constructs an XML document with the root content, which must be exactly one node.
|
abstract ServerExpression |
xmlElement(ServerExpression 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 ServerExpression |
xmlElement(ServerExpression name,
ServerExpression 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 ServerExpression |
xmlElement(ServerExpression name,
ServerExpression attributes,
ServerExpression... 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 ServerExpression |
xmlElement(java.lang.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 ServerExpression |
xmlElement(java.lang.String name,
ServerExpression 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 ServerExpression |
xmlElement(java.lang.String name,
ServerExpression attributes,
ServerExpression... 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 ServerExpression |
xmlPi(ServerExpression name,
ServerExpression value)
This function constructs an XML processing instruction with the atomic value.
|
abstract ServerExpression |
xmlPi(java.lang.String name,
java.lang.String value)
This function constructs an XML processing instruction with the atomic value.
|
abstract ServerExpression |
xmlText(ServerExpression value)
This function constructs an XML text node with the specified value.
|
abstract ServerExpression |
xmlText(java.lang.String value)
This function constructs an XML text node with the specified value.
|
abstract ServerExpression |
xpath(PlanColumn column,
ServerExpression path)
This function extracts a sequence of child nodes from a column with node values -- especially, the document nodes from a document join.
|
abstract ServerExpression |
xpath(java.lang.String column,
java.lang.String path)
This function extracts a sequence of child nodes from a column with node values -- especially, the document nodes from a document join.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
caseExpr, elseExpr, fromLiterals, fromLiterals, fromLiterals, groupConcat, groupConcat, groupConcat, groupConcat, groupConcatOptions, groupConcatOptions, groupConcatOptions, jsonArray, jsonObject, resolveFunction, seq
public final CtsExpr cts
public final FnExpr fn
public final GeoExpr geo
public final JsonExpr json
public final MapExpr map
public final MathExpr math
public final RdfExpr rdf
public final SemExpr sem
public final SpellExpr spell
public final SqlExpr sql
public final XdmpExpr xdmp
public final XsExpr xs
public abstract ServerExpression add(ServerExpression... left)
Provides a client interface to the op:add server function.
left
- The left value expression. (of xs:anyAtomicType)public abstract ServerExpression and(ServerExpression... left)
Provides a client interface to the op:and server function.
left
- The left value expression. (of xs:anyAtomicType)public abstract ServerExpression divide(ServerExpression left, ServerExpression right)
Provides a client interface to the op:divide server function.
left
- The left numeric expression. (of xs:anyAtomicType)right
- The right numeric expression. (of xs:anyAtomicType)public abstract ServerExpression eq(ServerExpression... left)
Provides a client interface to the op:eq server function.
left
- The left value expression. (of xs:anyAtomicType)public abstract ServerExpression ge(ServerExpression left, ServerExpression right)
Provides a client interface to the op:ge server function.
left
- The left value expression. (of xs:anyAtomicType)right
- The right value expression. (of xs:anyAtomicType)public abstract ServerExpression gt(ServerExpression left, ServerExpression right)
Provides a client interface to the op:gt server function.
left
- The left value expression. (of xs:anyAtomicType)right
- The right value expression. (of xs:anyAtomicType)public abstract ServerExpression isDefined(ServerExpression operand)
Provides a client interface to the op:is-defined server function.
operand
- A boolean expression, such as op:eq or op:not, that might be null. (of item)public abstract ServerExpression le(ServerExpression left, ServerExpression right)
Provides a client interface to the op:le server function.
left
- The left value expression. (of xs:anyAtomicType)right
- The right value expression. (of xs:anyAtomicType)public abstract ServerExpression lt(ServerExpression left, ServerExpression right)
Provides a client interface to the op:lt server function.
left
- The left value expression. (of xs:anyAtomicType)right
- The right value expression. (of xs:anyAtomicType)public abstract ServerExpression multiply(ServerExpression... left)
Provides a client interface to the op:multiply server function.
left
- The left numeric expression. (of xs:anyAtomicType)public abstract ServerExpression ne(ServerExpression left, ServerExpression right)
Provides a client interface to the op:ne server function.
left
- The left value expression. (of xs:anyAtomicType)right
- The right value expression. (of xs:anyAtomicType)public abstract ServerExpression not(ServerExpression operand)
Provides a client interface to the op:not server function.
operand
- Exactly one boolean expression, such as op:and or op:or, or op:is-defined. (of xs:anyAtomicType)public abstract ServerExpression or(ServerExpression... left)
Provides a client interface to the op:or server function.
left
- The left value expression. (of xs:anyAtomicType)public abstract ServerExpression subtract(ServerExpression left, ServerExpression right)
Provides a client interface to the op:subtract server function.
left
- The left numeric expression. (of xs:anyAtomicType)right
- The right numeric expression. (of xs:anyAtomicType)public abstract PlanParamExpr param(java.lang.String name)
Provides a client interface to the op:param server function.
name
- The name of the parameter.public abstract PlanParamExpr param(XsStringVal name)
Provides a client interface to the op:param server function.
name
- The name of the parameter.public abstract PlanColumn col(java.lang.String column)
column
- The Optic AccessorPlan created by op:from-view, op:from-triples, or op:from-lexicons.public abstract PlanColumn col(XsStringVal column)
column
- The Optic AccessorPlan created by op:from-view, op:from-triples, or op:from-lexicons.public abstract PlanColumn schemaCol(java.lang.String schema, java.lang.String view, java.lang.String column)
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)
schema
- The name of the schema.view
- The name of the view.column
- The name of the column.public abstract PlanColumn viewCol(java.lang.String view, java.lang.String column)
view
- The name of the view.column
- The name of the column.public abstract PlanColumn viewCol(XsStringVal view, XsStringVal column)
view
- The name of the view.column
- The name of the column.public abstract PlanSystemColumn fragmentIdCol(java.lang.String column)
column
- the column value.public abstract PlanSystemColumn fragmentIdCol(XsStringVal column)
column
- the column value.public abstract PlanSystemColumn graphCol(java.lang.String column)
column
- The name to use for the graph column.public abstract PlanSystemColumn graphCol(XsStringVal column)
column
- The name to use for the graph column.public abstract PlanExprCol as(java.lang.String column, ServerExpression expression)
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. (of item)public abstract PlanExprCol as(PlanColumn column, ServerExpression expression)
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. (of item)public abstract PlanExprColSeq colSeq(java.lang.String... col)
public abstract PlanExprColSeq colSeq(PlanExprCol... col)
public abstract PlanBuilder.AccessPlan fromView(java.lang.String schema, java.lang.String view)
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)
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(java.lang.String schema, java.lang.String view, java.lang.String qualifierName)
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)
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(java.lang.String schema, java.lang.String view, java.lang.String qualifierName, PlanSystemColumn sysCols)
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)
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(java.lang.String base)
base
- The base URI to be prepended to the name.public abstract PlanPrefixer prefixer(XsStringVal base)
base
- The base URI to be prepended to the name.public abstract PlanBuilder.AccessPlan fromTriples(PlanTriplePattern... patterns)
patterns
- One or more pattern definitions returned by the op:pattern function.public abstract PlanBuilder.AccessPlan fromTriples(PlanTriplePatternSeq patterns)
patterns
- One or more pattern definitions returned by the op:pattern function.public abstract PlanBuilder.AccessPlan fromTriples(PlanTriplePatternSeq patterns, java.lang.String qualifierName)
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)
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, java.lang.String qualifierName, java.lang.String graphIris)
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)
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, java.lang.String qualifierName, java.lang.String graphIris, PlanTripleOption option)
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)
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)
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)
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(java.util.Map<java.lang.String,CtsReferenceExpr> indexes)
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(java.util.Map<java.lang.String,CtsReferenceExpr> indexes, java.lang.String qualifierName)
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(java.util.Map<java.lang.String,CtsReferenceExpr> indexes, XsStringVal qualifierName)
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(java.util.Map<java.lang.String,CtsReferenceExpr> indexes, java.lang.String qualifierName, PlanSystemColumn sysCols)
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(java.util.Map<java.lang.String,CtsReferenceExpr> indexes, XsStringVal qualifierName, PlanSystemColumn sysCols)
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.ModifyPlan fromSparql(java.lang.String select)
select
- A SPARQL SELECT query expressed as a string.public abstract PlanBuilder.ModifyPlan fromSparql(XsStringVal select)
select
- A SPARQL SELECT query expressed as a string.public abstract PlanBuilder.ModifyPlan fromSparql(java.lang.String select, java.lang.String qualifierName)
select
- A SPARQL SELECT query expressed as a string.qualifierName
- Specifies a name for qualifying the column names. An "@" in front of the name specifies a parameter placeholder. A parameter placeholder in the SPARQL string must be bound to a parameter value in the result() call.public abstract PlanBuilder.ModifyPlan fromSparql(XsStringVal select, XsStringVal qualifierName)
select
- A SPARQL SELECT query expressed as a string.qualifierName
- Specifies a name for qualifying the column names. An "@" in front of the name specifies a parameter placeholder. A parameter placeholder in the SPARQL string must be bound to a parameter value in the result() call.public abstract PlanBuilder.ModifyPlan fromSql(java.lang.String select)
select
- A SQL SELECT query expressed as a string.public abstract PlanBuilder.ModifyPlan fromSql(XsStringVal select)
select
- A SQL SELECT query expressed as a string.public abstract PlanBuilder.ModifyPlan fromSql(java.lang.String select, java.lang.String qualifierName)
select
- A SQL SELECT query expressed as a string.qualifierName
- Specifies a name for qualifying the column names. Placeholder parameters in the SQL string may be bound in the result() callpublic abstract PlanBuilder.ModifyPlan fromSql(XsStringVal select, XsStringVal qualifierName)
select
- A SQL SELECT query expressed as a string.qualifierName
- Specifies a name for qualifying the column names. Placeholder parameters in the SQL string may be bound in the result() callpublic abstract PlanCondition sqlCondition(java.lang.String expression)
expression
- A boolean expression, such as op:eq or op:not, that might be null.public abstract PlanCondition sqlCondition(XsStringVal expression)
expression
- A boolean expression, such as op:eq or op:not, that might be null.public abstract PlanJoinKey on(java.lang.String left, java.lang.String right)
left
- The rows from the left view.right
- The row set from the right view.public abstract PlanJoinKey on(PlanExprCol left, PlanExprCol right)
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(java.lang.String name, java.lang.String column)
name
- The name to be used for the aggregated column.column
- The column to be aggregated.public abstract PlanAggregateCol avg(PlanColumn name, PlanExprCol column)
name
- The name to be used for the aggregated column.column
- The column to be aggregated.public abstract PlanAggregateCol avg(java.lang.String name, java.lang.String column, PlanValueOption option)
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)
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(java.lang.String name, java.lang.String column)
name
- The name to be used for the aggregated column.column
- The columns to be aggregated.public abstract PlanAggregateCol arrayAggregate(PlanColumn name, PlanExprCol column)
name
- The name to be used for the aggregated column.column
- The columns to be aggregated.public abstract PlanAggregateCol arrayAggregate(java.lang.String name, java.lang.String column, PlanValueOption option)
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)
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(java.lang.String name)
name
- The name to be used for the column values.public abstract PlanAggregateCol count(PlanColumn name)
name
- The name to be used for the column values.public abstract PlanAggregateCol count(java.lang.String name, java.lang.String column)
name
- The name to be used for the column values.column
- The columns to be counted.public abstract PlanAggregateCol count(PlanColumn name, PlanExprCol column)
name
- The name to be used for the column values.column
- The columns to be counted.public abstract PlanAggregateCol count(java.lang.String name, java.lang.String column, PlanValueOption option)
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)
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 max(java.lang.String name, java.lang.String column)
name
- The name to be used for the largest value.column
- The group or row set.public abstract PlanAggregateCol max(PlanColumn name, PlanExprCol column)
name
- The name to be used for the largest value.column
- The group or row set.public abstract PlanAggregateCol max(java.lang.String name, java.lang.String column, PlanValueOption option)
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)
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(java.lang.String name, java.lang.String column)
name
- The name to be used for the smallest value.column
- The group or row set.public abstract PlanAggregateCol min(PlanColumn name, PlanExprCol column)
name
- The name to be used for the smallest value.column
- The group or row set.public abstract PlanAggregateCol min(java.lang.String name, java.lang.String column, PlanValueOption option)
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)
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(java.lang.String name, java.lang.String column)
name
- The name to be used for the value.column
- The group or row set.public abstract PlanAggregateCol sample(PlanColumn name, PlanExprCol column)
name
- The name to be used for the value.column
- The group or row set.public abstract PlanAggregateCol sequenceAggregate(java.lang.String name, java.lang.String column)
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)
name
- The name to be used for the aggregated column.column
- The column with the values to aggregate.public abstract PlanAggregateCol sequenceAggregate(java.lang.String name, java.lang.String column, PlanValueOption option)
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)
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(java.lang.String name, java.lang.String column)
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)
name
- The name to be used for the aggregated column.column
- The column with the values to add.public abstract PlanAggregateCol sum(java.lang.String name, java.lang.String column, PlanValueOption option)
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)
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(java.lang.String name, java.lang.String column, java.lang.String module, java.lang.String function)
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)
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(java.lang.String name, java.lang.String column, java.lang.String module, java.lang.String function, java.lang.String arg)
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)
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(java.lang.String column)
column
- The column by which order the output.public abstract PlanSortKey asc(PlanExprCol column)
column
- The column by which order the output.public abstract PlanSortKey desc(java.lang.String column)
column
- The column by which order the output.public abstract PlanSortKey desc(PlanExprCol column)
column
- The column by which order the output.public abstract PlanSortKeySeq sortKeySeq(PlanSortKey... key)
public abstract ServerExpression modulo(double left, double right)
Provides a client interface to the op:modulo server function.
left
- The dividend numeric expression. (of xs:numeric)right
- The divisor numeric expression. (of xs:numeric)public abstract ServerExpression modulo(ServerExpression left, ServerExpression right)
Provides a client interface to the op:modulo server function.
left
- The dividend numeric expression. (of xs:numeric)right
- The divisor numeric expression. (of xs:numeric)public abstract PlanCase when(boolean condition, ServerExpression... value)
condition
- A boolean expression. (of xs:boolean)value
- The value expression to return if the boolean expression is true. (of item)public abstract PlanCase when(ServerExpression condition, ServerExpression... value)
condition
- A boolean expression. (of xs:boolean)value
- The value expression to return if the boolean expression is true. (of item)public abstract ServerExpression xpath(java.lang.String column, java.lang.String path)
Provides a client interface to the op:xpath server function.
public abstract ServerExpression xpath(PlanColumn column, ServerExpression path)
Provides a client interface to the op:xpath server function.
public abstract ServerExpression jsonDocument(ServerExpression root)
Provides a client interface to the op:json-document server function.
root
- The JSON object or array node used to construct the JSON document. (of json-root-node)public abstract PlanJsonProperty prop(java.lang.String key, ServerExpression value)
key
- The key expression. This must evaluate to a string. (of xs:string)value
- The value content. This must be exactly one JSON node expression. (of json-content-node)public abstract PlanJsonProperty prop(ServerExpression key, ServerExpression value)
key
- The key expression. This must evaluate to a string. (of xs:string)value
- The value content. This must be exactly one JSON node expression. (of json-content-node)public abstract ServerExpression jsonString(java.lang.String value)
Provides a client interface to the op:json-string server function.
value
- The value of the JSON text node. (of xs:anyAtomicType)public abstract ServerExpression jsonString(ServerExpression value)
Provides a client interface to the op:json-string server function.
value
- The value of the JSON text node. (of xs:anyAtomicType)public abstract ServerExpression jsonNumber(double value)
Provides a client interface to the op:json-number server function.
value
- The value of the JSON number node. (of xs:numeric)public abstract ServerExpression jsonNumber(ServerExpression value)
Provides a client interface to the op:json-number server function.
value
- The value of the JSON number node. (of xs:numeric)public abstract ServerExpression jsonBoolean(boolean value)
Provides a client interface to the op:json-boolean server function.
value
- The value of the JSON boolean node. (of xs:boolean)public abstract ServerExpression jsonBoolean(ServerExpression value)
Provides a client interface to the op:json-boolean server function.
value
- The value of the JSON boolean node. (of xs:boolean)public abstract ServerExpression jsonNull()
Provides a client interface to the op:json-null server function.
public abstract ServerExpression xmlDocument(ServerExpression root)
Provides a client interface to the op:xml-document server function.
root
- The XML node used to construct the XML document. (of xml-root-node)public abstract ServerExpression xmlElement(java.lang.String name)
Provides a client interface to the op:xml-element server function.
name
- The string or QName for the constructed element. (of xs:QName)public abstract ServerExpression xmlElement(ServerExpression name)
Provides a client interface to the op:xml-element server function.
name
- The string or QName for the constructed element. (of xs:QName)public abstract ServerExpression xmlElement(java.lang.String name, ServerExpression attributes)
Provides a client interface to the op:xml-element server function.
name
- The string or QName for the constructed element. (of xs:QName)attributes
- Any element attributes returned from op:xml-attribute, or null if no attributes. (of attribute-node)public abstract ServerExpression xmlElement(ServerExpression name, ServerExpression attributes)
Provides a client interface to the op:xml-element server function.
name
- The string or QName for the constructed element. (of xs:QName)attributes
- Any element attributes returned from op:xml-attribute, or null if no attributes. (of attribute-node)public abstract ServerExpression xmlElement(java.lang.String name, ServerExpression attributes, ServerExpression... content)
Provides a client interface to the op:xml-element server function.
name
- The string or QName for the constructed element. (of xs:QName)attributes
- Any element attributes returned from op:xml-attribute, or null if no attributes. (of attribute-node)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. (of xml-content-node)public abstract ServerExpression xmlElement(ServerExpression name, ServerExpression attributes, ServerExpression... content)
Provides a client interface to the op:xml-element server function.
name
- The string or QName for the constructed element. (of xs:QName)attributes
- Any element attributes returned from op:xml-attribute, or null if no attributes. (of attribute-node)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. (of xml-content-node)public abstract ServerExpression xmlAttribute(java.lang.String name, java.lang.String value)
Provides a client interface to the op:xml-attribute server function.
name
- The attribute name. (of xs:QName)value
- The attribute value. (of xs:anyAtomicType)public abstract ServerExpression xmlAttribute(ServerExpression name, ServerExpression value)
Provides a client interface to the op:xml-attribute server function.
name
- The attribute name. (of xs:QName)value
- The attribute value. (of xs:anyAtomicType)public abstract ServerExpression xmlText(java.lang.String value)
Provides a client interface to the op:xml-text server function.
value
- The value of the XML text node. (of xs:anyAtomicType)public abstract ServerExpression xmlText(ServerExpression value)
Provides a client interface to the op:xml-text server function.
value
- The value of the XML text node. (of xs:anyAtomicType)public abstract ServerExpression xmlComment(java.lang.String content)
Provides a client interface to the op:xml-comment server function.
content
- The comment text. (of xs:anyAtomicType)public abstract ServerExpression xmlComment(ServerExpression content)
Provides a client interface to the op:xml-comment server function.
content
- The comment text. (of xs:anyAtomicType)public abstract ServerExpression xmlPi(java.lang.String name, java.lang.String value)
Provides a client interface to the op:xml-pi server function.
name
- The name of the processing instruction. (of xs:string)value
- The value of the processing instruction. (of xs:anyAtomicType)public abstract ServerExpression xmlPi(ServerExpression name, ServerExpression value)
Provides a client interface to the op:xml-pi server function.
name
- The name of the processing instruction. (of xs:string)value
- The value of the processing instruction. (of xs:anyAtomicType)public abstract ServerExpression xmlAttributeSeq(ServerExpression... attribute)
public abstract PlanFunction resolveFunction(java.lang.String functionName, java.lang.String modulePath)
public abstract PlanFunction resolveFunction(XsQNameVal functionName, XsStringVal modulePath)
Copyright © 2013-2020 MarkLogic Corporation.