PlanBuilder
public interface PlanBuilderBase
Modifier and Type | Interface | Description |
---|---|---|
static interface |
PlanBuilderBase.AccessPlanBase |
Defines base methods for AccessPlan.
|
static interface |
PlanBuilderBase.ExportablePlanBase |
Defines base methods for ExportablePlan.
|
static interface |
PlanBuilderBase.ModifyPlanBase |
Defines base methods for ModifyPlan.
|
static interface |
PlanBuilderBase.PlanBase |
Defines base methods for Plan.
|
static interface |
PlanBuilderBase.PreparePlanBase |
Defines base methods for PreparePlan.
|
Modifier and Type | Method | Description |
---|---|---|
ServerExpression |
caseExpr(PlanCase... cases) |
This function returns the specified value
expression if the specified value expression is true.
|
PlanCase |
elseExpr(ServerExpression value) |
This function returns the specified value if
none of the preceeding when() conditions are true.
|
PlanBuilder.AccessPlan |
fromLiterals(java.util.Map<java.lang.String,java.lang.Object>... rows) |
Constructs a literal row set as in the SQL
VALUES or SPARQL VALUES statements.
|
PlanBuilder.AccessPlan |
fromLiterals(java.util.Map<java.lang.String,java.lang.Object>[] rows,
XsStringVal qualifierName) |
Constructs a literal row set as in the SQL
VALUES or SPARQL VALUES statements.
|
PlanBuilder.AccessPlan |
fromLiterals(java.util.Map<java.lang.String,java.lang.Object>[] rows,
java.lang.String qualifierName) |
Constructs a literal row set as in the SQL
VALUES or SPARQL VALUES statements.
|
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.
|
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.
|
PlanAggregateCol |
groupConcat(java.lang.String name,
java.lang.String column) |
This function concatenates the non-null values
of the column for the rows in the group or row set.
|
PlanAggregateCol |
groupConcat(java.lang.String name,
java.lang.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(java.lang.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(java.lang.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.
|
ServerExpression |
jsonArray(ServerExpression... property) |
This function constructs a JSON array during row
processing.
|
ServerExpression |
jsonObject(PlanJsonProperty... property) |
This function constructs a JSON object with the
specified properties.
|
PlanFunction |
resolveFunction(XsQNameVal functionName,
java.lang.String modulePath) |
Specifies a JavaScript or XQuery function
installed on the server for use in post-processing in a map() or
reduce() operation.
|
ServerExpression |
seq(ServerExpression... expression) |
Collects a sequence of server expressions as a
new server expression for evaluation on the server.
|
PlanBuilder.AccessPlan fromLiterals(java.util.Map<java.lang.String,java.lang.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.PlanBuilder.AccessPlan fromLiterals(java.util.Map<java.lang.String,java.lang.Object>[] rows, java.lang.String qualifierName)
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.PlanBuilder.AccessPlan fromLiterals(java.util.Map<java.lang.String,java.lang.Object>[] rows, XsStringVal qualifierName)
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.ServerExpression jsonObject(PlanJsonProperty... property)
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.ServerExpression jsonArray(ServerExpression... property)
Provides a client interface to a server function. See op:json-array
property
- The JSON nodes for the array.ServerExpression caseExpr(PlanCase... cases)
Provides a client interface to a server function. See op:case
cases
- One or more when or else expressions.PlanCase elseExpr(ServerExpression value)
value
- The value expression to returnPlanAggregateCol groupConcat(java.lang.String name, java.lang.String column)
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.PlanAggregateCol groupConcat(PlanColumn name, PlanExprCol column)
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.PlanAggregateCol groupConcat(java.lang.String name, java.lang.String column, PlanGroupConcatOptionSeq options)
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.PlanAggregateCol groupConcat(PlanColumn name, PlanExprCol column, PlanGroupConcatOptionSeq options)
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.PlanGroupConcatOptionSeq groupConcatOptions(java.lang.String separator)
separator
- a string for separating the
valuesPlanGroupConcatOptionSeq groupConcatOptions(PlanValueOption option)
option
- an option controlling whether to
concatenate all values including duplicates or concatenate distinct
valuesPlanGroupConcatOptionSeq groupConcatOptions(java.lang.String separator, PlanValueOption option)
separator
- a string for separating the
valuesoption
- an option controlling whether to
concatenate all values including duplicates or concatenate distinct
valuesPlanFunction resolveFunction(XsQNameVal functionName, java.lang.String modulePath)
functionName
- the name of the function installed
on the servermodulePath
- the path on the server for the
library module providing the functionServerExpression seq(ServerExpression... expression)
expression
- one or more server expressionsCopyright © 2013-2019 MarkLogic Corporation.