PlanBuilder (MarkLogic Java Client API 6.6.1)

java.lang.Object
- com.marklogic.client.expression.PlanBuilder

All Implemented Interfaces:

PlanBuilderBase
```
public abstract class PlanBuilder
extends java.lang.Object
implements PlanBuilderBase
```
Builds the plan for a row pipeline to execute on the server.

Nested Class Summary

Nested Classes
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.

Nested classes/interfaces inherited from interface com.marklogic.client.expression.PlanBuilderBase
PlanBuilderBase.AccessPlanBase, PlanBuilderBase.ExportablePlanBase, PlanBuilderBase.ModifyPlanBase, PlanBuilderBase.PlanBase, PlanBuilderBase.PreparePlanBase

Field Summary

Fields
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.
`RdtExpr`	`rdt` Builds expressions with ordt 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.
`VecExpr`	`vec` Builds expressions with vec server functions.
`XdmpExpr`	`xdmp` Builds expressions with xdmp server functions.
`XsExpr`	`xs` Builds expressions with xs server functions.

Constructor Summary

Constructors
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, VecExpr vec, XdmpExpr xdmp, XsExpr xs, RdtExpr rdt)`

Method Summary

All Methods Instance Methods Abstract Methods
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)` Constructs a sequence from multiple aggregate values to pass as a parameter to an operation.
`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 rows by the values of the specified column in ascending order.
`abstract PlanSortKey`	`asc(java.lang.String column)` This function sorts the rows by the values of the specified column 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 PlanNamedGroup`	`bucketGroup(java.lang.String name, java.lang.String key, java.lang.String boundaries)` This function can be used as a named group in functions op:group-to-arrays or op:facet-by.
`abstract PlanNamedGroup`	`bucketGroup(java.lang.String name, java.lang.String key, java.lang.String boundaries, java.lang.String collation)` This function can be used as a named group in functions op:group-to-arrays or op:facet-by.
`abstract PlanNamedGroup`	`bucketGroup(XsStringVal name, PlanExprCol key, XsAnyAtomicTypeSeqVal boundaries)` This function can be used as a named group in functions op:group-to-arrays or op:facet-by.
`abstract PlanNamedGroup`	`bucketGroup(XsStringVal name, PlanExprCol key, XsAnyAtomicTypeSeqVal boundaries, XsStringVal collation)` This function can be used as a named group in functions op:group-to-arrays or op:facet-by.
`abstract PlanColumn`	`col(java.lang.String column)` Identifies a column where the column name is unique and a qualifier on the column name isn't necessary (and might not exist).
`abstract PlanColumn`	`col(XsStringVal column)` Identifies a column where the column name is unique and a qualifier on the column name isn't necessary (and might not exist).
`abstract PlanExprColSeq`	`colSeq(PlanExprCol... col)` Constructs a sequence from multiple col values to pass as a parameter to an operation.
`abstract PlanExprColSeq`	`colSeq(java.lang.String... col)` Constructs a sequence from multiple col values to pass as a parameter to an operation.
`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 PlanGroupSeq`	`cube(PlanExprColSeq keys)` This function specifies a list of grouping keys for a group and returns that group and every possible larger group (including all rows) formed from any subset of keys.
`abstract PlanSortKey`	`desc(PlanExprCol column)` This function sorts the rows by the values of the specified column in descending order.
`abstract PlanSortKey`	`desc(java.lang.String column)` This function sorts the rows by the values of the specified column 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 PlanDocColsIdentifier`	`docCols()` Constructs a document column identifier object for columns of uri, doc, collections, metadata, permissions, quality and temporalCollection.
`abstract PlanDocColsIdentifier`	`docCols(java.lang.String qualifier)` Constructs a document column identifier object for columns of uri, doc, collections, metadata, permissions, quality and temporalCollection.
`abstract PlanDocColsIdentifier`	`docCols(java.lang.String qualifier, java.lang.String names)` Constructs a document column identifier object for columns of uri, doc, collections, metadata, permissions, quality and temporalCollection.
`abstract PlanDocColsIdentifier`	`docCols(XsStringVal qualifier)` Constructs a document column identifier object for columns of uri, doc, collections, metadata, permissions, quality and temporalCollection.
`abstract PlanDocColsIdentifier`	`docCols(XsStringVal qualifier, XsStringSeqVal names)` Constructs a document column identifier object for columns of uri, doc, collections, metadata, permissions, quality and temporalCollection.
`abstract PlanRowColTypesSeq`	`docColTypes()` Provides the 3rd parameter for op:from-param for row column types.
`abstract ServerExpression`	`eq(ServerExpression... operand)` This function takes two or more expressions and returns true if all of the 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`	`fromDocDescriptors(PlanDocDescriptor... docDescriptor)` This function constructs document rows from the docsDescriptors.
`abstract PlanBuilder.AccessPlan`	`fromDocDescriptors(PlanDocDescriptorSeq docDescriptor)` This function constructs document rows from the docsDescriptors.
`abstract PlanBuilder.AccessPlan`	`fromDocDescriptors(PlanDocDescriptorSeq docDescriptor, java.lang.String qualifier)` This function constructs document rows from the docsDescriptors.
`abstract PlanBuilder.AccessPlan`	`fromDocDescriptors(PlanDocDescriptorSeq docDescriptor, XsStringVal qualifier)` This function constructs document rows from the docsDescriptors.
`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.AccessPlan`	`fromParam(java.lang.String paramName, java.lang.String qualifier, PlanRowColTypesSeq rowColTypes)` This function constructs document rows with rows provided by a parameter.
`abstract PlanBuilder.AccessPlan`	`fromParam(XsStringVal paramName, XsStringVal qualifier, PlanRowColTypesSeq rowColTypes)` This function constructs document rows with rows provided by a parameter.
`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(java.lang.String select, java.lang.String qualifierName, PlanSparqlOptions option)` 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`	`fromSparql(XsStringVal select, XsStringVal qualifierName, PlanSparqlOptions option)` 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 PlanGroup`	`group(PlanExprColSeq keys)` This function specifies the grouping keys for a group as a list of zero or more columns.
`abstract PlanAggregateCol`	`groupKey(PlanColumn name, PlanExprCol column)`
`abstract PlanAggregateCol`	`groupKey(java.lang.String name, java.lang.String column)`
`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 PlanAggregateCol`	`hasGroupKey(PlanColumn name, PlanExprCol column)` This aggregate function adds a flag to a grouped row specifying whether a column acted as a grouping key for the row.
`abstract PlanAggregateCol`	`hasGroupKey(java.lang.String name, java.lang.String column)` This aggregate function adds a flag to a grouped row specifying whether a column acted as a grouping key for the row.
`abstract ServerExpression`	`in(ServerExpression value, ServerExpression anyOf)` This function returns true if a test expression evaluates to the same value as any of a list of candidate expressions.
`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)` Constructs a sequence from multiple key values to pass as a parameter to an operation.
`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 PlanNamedGroup`	`namedGroup(java.lang.String name)` This function specifies the grouping keys for a group as a named list of zero or more columns.
`abstract PlanNamedGroup`	`namedGroup(java.lang.String name, java.lang.String keys)` This function specifies the grouping keys for a group as a named list of zero or more columns.
`abstract PlanNamedGroup`	`namedGroup(XsStringVal name)` This function specifies the grouping keys for a group as a named list of zero or more columns.
`abstract PlanNamedGroup`	`namedGroup(XsStringVal name, PlanExprColSeq keys)` This function specifies the grouping keys for a group as a named list of zero or more columns.
`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)` Constructs a sequence from multiple object values to pass as a parameter to an operation.
`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 PatchBuilder`	`patchBuilder(java.lang.String contextPath)` Create a patch builder which can be used to chain patch operations.
`abstract PatchBuilder`	`patchBuilder(java.lang.String contextPath, java.util.Map<java.lang.String,java.lang.String> namespaces)` Create a patch builder which can be used to chain patch operations.
`abstract PatchBuilder`	`patchBuilder(XsStringVal contextPath)` Create a patch builder which can be used to chain patch operations.
`abstract PatchBuilder`	`patchBuilder(XsStringVal contextPath, java.util.Map<java.lang.String,java.lang.String> namespaces)` Create a patch builder which can be used to chain patch operations.
`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)` Constructs a sequence from multiple pattern values to pass as a parameter to an operation.
`abstract PlanTriplePositionSeq`	`predicateSeq(PlanTriplePosition... predicate)` Constructs a sequence from multiple predicate values to pass as a parameter to an operation.
`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 constructed 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 constructed by the op:json-object function.
`abstract PlanFunction`	`resolveFunction(java.lang.String 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.
`abstract PlanFunction`	`resolveFunction(XsQNameVal functionName, XsStringVal modulePath)` Specifies a JavaScript or XQuery function installed on the server for use in post-processing in a map() or reduce() operation.
`abstract PlanGroupSeq`	`rollup(PlanExprColSeq keys)` This function specifies a list of grouping keys for a group and returns that group and larger groups (including all rows) formed by dropping columns from right to left.
`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)` Constructs a sequence from multiple key values to pass as a parameter to an operation.
`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)` Constructs a sequence from multiple subject values to pass as a parameter to an operation.
`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)` Constructs a sequence from multiple attribute values to pass as a parameter to an operation.
`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(PlanColumn column, ServerExpression path, PlanNamespaceBindingsSeq namespaceBindings)` 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.
`abstract ServerExpression`	`xpath(java.lang.String column, java.lang.String path, PlanNamespaceBindingsSeq namespaceBindings)` This function extracts a sequence of child nodes from a column with node values -- especially, the document nodes from a document join.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.marklogic.client.expression.PlanBuilderBase
caseExpr, colType, colType, colType, colTypes, cube, docCols, docDescriptor, docDescriptors, elseExpr, fromDocUris, fromDocUris, fromDocUris, fromLiterals, fromLiterals, fromLiterals, fromSearch, fromSearch, fromSearch, fromSearch, fromSearchDocs, fromSearchDocs, fromSearchDocs, group, groupConcat, groupConcat, groupConcat, groupConcat, groupConcatOptions, groupConcatOptions, groupConcatOptions, groupSeq, jsonArray, jsonObject, namedGroup, namedGroupSeq, permission, resolveFunction, rollup, sampleByOptions, schemaDefinition, searchOptions, seq, sparqlOptions, transformDef

- Field Detail
  - cts
```
public final CtsExpr cts
```
    Builds expressions with cts server functions.
  - fn
```
public final FnExpr fn
```
    Builds expressions with fn server functions.
  - geo
```
public final GeoExpr geo
```
    Builds expressions with geo server functions.
  - json
```
public final JsonExpr json
```
    Builds expressions with json server functions.
  - map
```
public final MapExpr map
```
    Builds expressions with map server functions.
  - math
```
public final MathExpr math
```
    Builds expressions with math server functions.
  - rdf
```
public final RdfExpr rdf
```
    Builds expressions with rdf server functions.
  - sem
```
public final SemExpr sem
```
    Builds expressions with sem server functions.
  - spell
```
public final SpellExpr spell
```
    Builds expressions with spell server functions.
  - sql
```
public final SqlExpr sql
```
    Builds expressions with sql server functions.
  - vec
```
public final VecExpr vec
```
    Builds expressions with vec server functions.
    
    Since:
    
    7.0.0; requires MarkLogic 12 or higher.
  - xdmp
```
public final XdmpExpr xdmp
```
    Builds expressions with xdmp server functions.
  - xs
```
public final XsExpr xs
```
    Builds expressions with xs server functions.
  - rdt
```
public final RdtExpr rdt
```
    Builds expressions with ordt server functions.
- Constructor Detail
  - PlanBuilder
```
protected PlanBuilder(CtsExpr cts,
                      FnExpr fn,
                      GeoExpr geo,
                      JsonExpr json,
                      MapExpr map,
                      MathExpr math,
                      RdfExpr rdf,
                      SemExpr sem,
                      SpellExpr spell,
                      SqlExpr sql,
                      VecExpr vec,
                      XdmpExpr xdmp,
                      XsExpr xs,
                      RdtExpr rdt)
```
- Method Detail
  - add
```
public abstract ServerExpression add(ServerExpression... 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.
    Provides a client interface to the op:add server function.
    
    Parameters:
    
    left - The left value expression. (of xs:anyAtomicType)
    
    Returns:
    
    a server expression with the xs:numeric server data type
  - and
```
public abstract ServerExpression and(ServerExpression... left)
```
    This function returns true if the specified expressions all return true. Otherwise, it returns false.
    Provides a client interface to the op:and server function.
    
    Parameters:
    
    left - The left value expression. (of xs:anyAtomicType)
    
    Returns:
    
    a server expression with the xs:boolean server data type
  - divide
```
public abstract ServerExpression divide(ServerExpression left,
                                        ServerExpression right)
```
    This function divides the left numericExpression by the right numericExpression and returns the value.
    Provides a client interface to the op:divide server function.
    
    Parameters:
    
    left - The left numeric expression. (of xs:anyAtomicType)
    
    right - The right numeric expression. (of xs:anyAtomicType)
    
    Returns:
    
    a server expression with the xs:numeric server data type
  - eq
```
public abstract ServerExpression eq(ServerExpression... operand)
```
    This function takes two or more expressions and returns true if all of the expressions return the same value. Otherwise, it returns false. The expressions can include calls to the op:col function to get the value of a column.
    Provides a client interface to the op:eq server function.
    
    Parameters:
    
    operand - Two or more expressions. (of xs:anyAtomicType)
    
    Returns:
    
    a server expression with the xs:boolean server data type
  - ge
```
public 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. Otherwise, it returns false.
    Provides a client interface to the op:ge server function.
    
    Parameters:
    
    left - The left value expression. (of xs:anyAtomicType)
    
    right - The right value expression. (of xs:anyAtomicType)
    
    Returns:
    
    a server expression with the xs:boolean server data type
  - gt
```
public 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. Otherwise, it returns false.
    Provides a client interface to the op:gt server function.
    
    Parameters:
    
    left - The left value expression. (of xs:anyAtomicType)
    
    right - The right value expression. (of xs:anyAtomicType)
    
    Returns:
    
    a server expression with the xs:boolean server data type
  - in
```
public abstract ServerExpression in(ServerExpression value,
                                    ServerExpression anyOf)
```
    This function returns true if a test expression evaluates to the same value as any of a list of candidate expressions. Otherwise, it returns false. The expressions can include calls to the op:col function to get the value of a column.
    Provides a client interface to the op:in server function.
    
    Parameters:
    
    value - The expression providing the value to test. (of xs:anyAtomicType)
    
    anyOf - One or more expressions providing the candidate values. (of xs:anyAtomicType)
    
    Returns:
    
    a server expression with the xs:boolean server data type
  - isDefined
```
public 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.
    Provides a client interface to the op:is-defined server function.
    
    Parameters:
    
    operand - A boolean expression, such as op:eq or op:not, that might be null. (of item)
    
    Returns:
    
    a server expression with the xs:boolean server data type
  - le
```
public 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. Otherwise, it returns false.
    Provides a client interface to the op:le server function.
    
    Parameters:
    
    left - The left value expression. (of xs:anyAtomicType)
    
    right - The right value expression. (of xs:anyAtomicType)
    
    Returns:
    
    a server expression with the xs:boolean server data type
  - lt
```
public 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. Otherwise, it returns false.
    Provides a client interface to the op:lt server function.
    
    Parameters:
    
    left - The left value expression. (of xs:anyAtomicType)
    
    right - The right value expression. (of xs:anyAtomicType)
    
    Returns:
    
    a server expression with the xs:boolean server data type
  - multiply
```
public abstract ServerExpression multiply(ServerExpression... left)
```
    This function multiplies the left numericExpression by the right numericExpression and returns the value.
    Provides a client interface to the op:multiply server function.
    
    Parameters:
    
    left - The left numeric expression. (of xs:anyAtomicType)
    
    Returns:
    
    a server expression with the xs:numeric server data type
  - ne
```
public 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. Otherwise, it returns false.
    Provides a client interface to the op:ne server function.
    
    Parameters:
    
    left - The left value expression. (of xs:anyAtomicType)
    
    right - The right value expression. (of xs:anyAtomicType)
    
    Returns:
    
    a server expression with the xs:boolean server data type
  - not
```
public abstract ServerExpression not(ServerExpression operand)
```
    This function returns true if neither of the specified boolean expressions return true. Otherwise, it returns false.
    Provides a client interface to the op:not server function.
    
    Parameters:
    
    operand - Exactly one boolean expression, such as op:and or op:or, or op:is-defined. (of xs:anyAtomicType)
    
    Returns:
    
    a server expression with the xs:boolean server data type
  - or
```
public abstract ServerExpression or(ServerExpression... left)
```
    This function returns true if the specified expressions all return true. Otherwise, it returns false.
    Provides a client interface to the op:or server function.
    
    Parameters:
    
    left - The left value expression. (of xs:anyAtomicType)
    
    Returns:
    
    a server expression with the xs:boolean server data type
  - subtract
```
public abstract ServerExpression subtract(ServerExpression left,
                                          ServerExpression right)
```
    This function subtracts the right numericExpression from the left numericExpression and returns the value.
    Provides a client interface to the op:subtract server function.
    
    Parameters:
    
    left - The left numeric expression. (of xs:anyAtomicType)
    
    right - The right numeric expression. (of xs:anyAtomicType)
    
    Returns:
    
    a server expression with the xs:numeric server data type
  - patchBuilder
```
public abstract PatchBuilder patchBuilder(java.lang.String contextPath)
```
    Create a patch builder which can be used to chain patch operations.
    
    Parameters:
    
    contextPath - The context path to patch.
    
    Returns:
    
    a PatchBuilder object
  - patchBuilder
```
public abstract PatchBuilder patchBuilder(XsStringVal contextPath)
```
    Create a patch builder which can be used to chain patch operations.
    
    Parameters:
    
    contextPath - The context path to patch.
    
    Returns:
    
    a PatchBuilder object
  - patchBuilder
```
public abstract PatchBuilder patchBuilder(java.lang.String contextPath,
                                          java.util.Map<java.lang.String,java.lang.String> namespaces)
```
    Create a patch builder which can be used to chain patch operations.
    
    Parameters:
    
    contextPath - The context path to patch.
    
    namespaces - Namespaces prefix (key) and uri (value).
    
    Returns:
    
    a PatchBuilder object
  - patchBuilder
```
public abstract PatchBuilder patchBuilder(XsStringVal contextPath,
                                          java.util.Map<java.lang.String,java.lang.String> namespaces)
```
    Create a patch builder which can be used to chain patch operations.
    
    Parameters:
    
    contextPath - The context path to patch.
    
    namespaces - Namespaces prefix (key) and uri (value).
    
    Returns:
    
    a PatchBuilder object
  - param
```
public 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. 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 the op:param server function.
    
    Parameters:
    
    name - The name of the parameter.
    
    Returns:
    
    a op:param() server expression
  - param
```
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 the op:param server function.
    
    Parameters:
    
    name - The name of the parameter.
    
    Returns:
    
    a op:param() server expression
  - col
```
public abstract PlanColumn col(java.lang.String column)
```
    Identifies a column where the column name is unique and a qualifier on the column name isn't necessary (and might not exist).
    
    Parameters:
    
    column - the column value.
    
    Returns:
    
    a PlanColumn object
  - col
```
public abstract PlanColumn col(XsStringVal column)
```
    Identifies a column where the column name is unique and a qualifier on the column name isn't necessary (and might not exist).
    
    Parameters:
    
    column - the column value.
    
    Returns:
    
    a PlanColumn object
  - schemaCol
```
public 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. Useful only for columns provided by a view.
    
    Parameters:
    
    schema - The name of the schema.
    
    view - The name of the view.
    
    column - The name of the column.
    
    Returns:
    
    a PlanColumn object
  - schemaCol
```
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.
    
    Parameters:
    
    schema - The name of the schema.
    
    view - The name of the view.
    
    column - The name of the column.
    
    Returns:
    
    a PlanColumn object
  - viewCol
```
public abstract PlanColumn viewCol(java.lang.String view,
                                   java.lang.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).
    
    Parameters:
    
    view - The name of the view.
    
    column - The name of the column.
    
    Returns:
    
    a PlanColumn object
  - viewCol
```
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).
    
    Parameters:
    
    view - The name of the view.
    
    column - The name of the column.
    
    Returns:
    
    a PlanColumn object
  - fragmentIdCol
```
public 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. 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.
    
    Parameters:
    
    column - The name of the fragment ID column.
    
    Returns:
    
    a PlanSystemColumn object
  - fragmentIdCol
```
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.
    
    Parameters:
    
    column - The name of the fragment ID column.
    
    Returns:
    
    a PlanSystemColumn object
  - graphCol
```
public abstract PlanSystemColumn graphCol(java.lang.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.
    
    Parameters:
    
    column - The name to use for the graph column.
    
    Returns:
    
    a PlanSystemColumn object
  - graphCol
```
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.
    
    Parameters:
    
    column - The name to use for the graph column.
    
    Returns:
    
    a PlanSystemColumn object
  - as
```
public 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.
    
    Parameters:
    
    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. See col(XsStringVal)
    
    expression - The expression used to define the value the column. (of item)
    
    Returns:
    
    a PlanExprCol object
  - as
```
public 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.
    
    Parameters:
    
    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. See col(XsStringVal)
    
    expression - The expression used to define the value the column. (of item)
    
    Returns:
    
    a PlanExprCol object
  - colSeq
```
public abstract PlanExprColSeq colSeq(java.lang.String... col)
```
    Constructs a sequence from multiple col values to pass as a parameter to an operation.
    
    Parameters:
    
    col - the col values for the sequence See col(XsStringVal)
    
    Returns:
    
    a PlanExprColSeq object sequence
  - colSeq
```
public abstract PlanExprColSeq colSeq(PlanExprCol... col)
```
    Constructs a sequence from multiple col values to pass as a parameter to an operation.
    
    Parameters:
    
    col - the col values for the sequence See col(XsStringVal)
    
    Returns:
    
    a PlanExprColSeq object sequence
  - fromView
```
public 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    a AccessPlan object
  - fromView
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    a AccessPlan object
  - fromView
```
public 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    a AccessPlan object
  - fromView
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    a AccessPlan object
  - fromView
```
public 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    a AccessPlan object
  - fromView
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    a AccessPlan object
  - prefixer
```
public 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.
    
    Parameters:
    
    base - The base URI to be prepended to the name.
    
    Returns:
    
    a PlanPrefixer object
  - prefixer
```
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.
    
    Parameters:
    
    base - The base URI to be prepended to the name.
    
    Returns:
    
    a PlanPrefixer object
  - fromTriples
```
public abstract PlanBuilder.AccessPlan fromTriples(PlanTriplePattern... patterns)
```
    Reads rows by matching patterns in the triple index.
    
    Parameters:
    
    patterns - One or more pattern definitions returned by the op:pattern function. See patternSeq(PlanTriplePattern...)
    
    Returns:
    
    a AccessPlan object
  - fromTriples
```
public abstract PlanBuilder.AccessPlan fromTriples(PlanTriplePatternSeq patterns)
```
    Reads rows by matching patterns in the triple index.
    
    Parameters:
    
    patterns - One or more pattern definitions returned by the op:pattern function. See patternSeq(PlanTriplePattern...)
    
    Returns:
    
    a AccessPlan object
  - fromTriples
```
public abstract PlanBuilder.AccessPlan fromTriples(PlanTriplePatternSeq patterns,
                                                   java.lang.String qualifierName)
```
    Reads rows by matching patterns in the triple index.
    
    Parameters:
    
    patterns - One or more pattern definitions returned by the op:pattern function. See patternSeq(PlanTriplePattern...)
    
    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.
    
    Returns:
    
    a AccessPlan object
  - fromTriples
```
public abstract PlanBuilder.AccessPlan fromTriples(PlanTriplePatternSeq patterns,
                                                   XsStringVal qualifierName)
```
    Reads rows by matching patterns in the triple index.
    
    Parameters:
    
    patterns - One or more pattern definitions returned by the op:pattern function. See patternSeq(PlanTriplePattern...)
    
    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.
    
    Returns:
    
    a AccessPlan object
  - fromTriples
```
public abstract PlanBuilder.AccessPlan fromTriples(PlanTriplePatternSeq patterns,
                                                   java.lang.String qualifierName,
                                                   java.lang.String graphIris)
```
    Reads rows by matching patterns in the triple index.
    
    Parameters:
    
    patterns - One or more pattern definitions returned by the op:pattern function. See patternSeq(PlanTriplePattern...)
    
    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.
    
    Returns:
    
    a AccessPlan object
  - fromTriples
```
public abstract PlanBuilder.AccessPlan fromTriples(PlanTriplePatternSeq patterns,
                                                   XsStringVal qualifierName,
                                                   XsStringSeqVal graphIris)
```
    Reads rows by matching patterns in the triple index.
    
    Parameters:
    
    patterns - One or more pattern definitions returned by the op:pattern function. See patternSeq(PlanTriplePattern...)
    
    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.
    
    Returns:
    
    a AccessPlan object
  - fromTriples
```
public 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.
    
    Parameters:
    
    patterns - One or more pattern definitions returned by the op:pattern function. See patternSeq(PlanTriplePattern...)
    
    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.
    
    Returns:
    
    a AccessPlan object
  - fromTriples
```
public abstract PlanBuilder.AccessPlan fromTriples(PlanTriplePatternSeq patterns,
                                                   XsStringVal qualifierName,
                                                   XsStringSeqVal graphIris,
                                                   PlanTripleOption option)
```
    Reads rows by matching patterns in the triple index.
    
    Parameters:
    
    patterns - One or more pattern definitions returned by the op:pattern function. See patternSeq(PlanTriplePattern...)
    
    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.
    
    Returns:
    
    a AccessPlan object
  - pattern
```
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.
    
    Parameters:
    
    subjects - One column or one or more literal values, such as the literal returned by a sem:iri call. See subjectSeq(PlanTriplePosition...)
    
    predicates - One column or one or more literal values, such as the literal returned by a sem.iri call. See predicateSeq(PlanTriplePosition...)
    
    objects - One column or one or more literal values, such as the literal returned by a sem:iri call. See objectSeq(PlanTriplePosition...)
    
    Returns:
    
    a PlanTriplePattern object
  - pattern
```
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.
    
    Parameters:
    
    subjects - One column or one or more literal values, such as the literal returned by a sem:iri call. See subjectSeq(PlanTriplePosition...)
    
    predicates - One column or one or more literal values, such as the literal returned by a sem.iri call. See predicateSeq(PlanTriplePosition...)
    
    objects - One column or one or more literal values, such as the literal returned by a sem:iri call. See objectSeq(PlanTriplePosition...)
    
    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.
    
    Returns:
    
    a PlanTriplePattern object
  - patternSeq
```
public abstract PlanTriplePatternSeq patternSeq(PlanTriplePattern... pattern)
```
    Constructs a sequence from multiple pattern values to pass as a parameter to an operation.
    
    Parameters:
    
    pattern - the pattern values for the sequence See pattern(PlanTriplePositionSeq, PlanTriplePositionSeq, PlanTriplePositionSeq, PlanSystemColumnSeq)
    
    Returns:
    
    a PlanTriplePatternSeq object sequence
  - subjectSeq
```
public abstract PlanTriplePositionSeq subjectSeq(PlanTriplePosition... subject)
```
    Constructs a sequence from multiple subject values to pass as a parameter to an operation.
    
    Parameters:
    
    subject - the subject values for the sequence
    
    Returns:
    
    a PlanTriplePositionSeq object sequence
  - predicateSeq
```
public abstract PlanTriplePositionSeq predicateSeq(PlanTriplePosition... predicate)
```
    Constructs a sequence from multiple predicate values to pass as a parameter to an operation.
    
    Parameters:
    
    predicate - the predicate values for the sequence
    
    Returns:
    
    a PlanTriplePositionSeq object sequence
  - objectSeq
```
public abstract PlanTriplePositionSeq objectSeq(PlanTriplePosition... object)
```
    Constructs a sequence from multiple object values to pass as a parameter to an operation.
    
    Parameters:
    
    object - the object values for the sequence
    
    Returns:
    
    a PlanTriplePositionSeq object sequence
  - fromLexicons
```
public 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. 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    a AccessPlan object
  - fromLexicons
```
public 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. 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    a AccessPlan object
  - fromLexicons
```
public 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. 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    a AccessPlan object
  - fromLexicons
```
public 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. 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    a AccessPlan object
  - fromLexicons
```
public 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. 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    a AccessPlan object
  - fromSparql
```
public abstract PlanBuilder.ModifyPlan fromSparql(java.lang.String select)
```
    This function dynamically constructs a row set based on a SPARQL SELECT query from triples.
    
    Parameters:
    
    select - A SPARQL SELECT query expressed as a string.
    
    Returns:
    
    a ModifyPlan object
  - fromSparql
```
public abstract PlanBuilder.ModifyPlan fromSparql(XsStringVal select)
```
    This function dynamically constructs a row set based on a SPARQL SELECT query from triples.
    
    Parameters:
    
    select - A SPARQL SELECT query expressed as a string.
    
    Returns:
    
    a ModifyPlan object
  - fromSparql
```
public 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    a ModifyPlan object
  - fromSparql
```
public abstract PlanBuilder.ModifyPlan fromSparql(XsStringVal select,
                                                  XsStringVal qualifierName)
```
    This function dynamically constructs a row set based on a SPARQL SELECT query from triples.
    
    Parameters:
    
    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.
    
    Returns:
    
    a ModifyPlan object
  - fromSparql
```
public abstract PlanBuilder.ModifyPlan fromSparql(java.lang.String select,
                                                  java.lang.String qualifierName,
                                                  PlanSparqlOptions option)
```
    This function dynamically constructs a row set based on a SPARQL SELECT query from triples.
    
    Parameters:
    
    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.
    
    option - Options consisting of key-value pairs that set options. At present, the options consist of dedup and base. Option dedup can take an on|off value to enable or disable deduplication. Deduplication is off by default. Option base takes a string as the initial base IRI for the query.
    
    Returns:
    
    a ModifyPlan object
  - fromSparql
```
public abstract PlanBuilder.ModifyPlan fromSparql(XsStringVal select,
                                                  XsStringVal qualifierName,
                                                  PlanSparqlOptions option)
```
    This function dynamically constructs a row set based on a SPARQL SELECT query from triples.
    
    Parameters:
    
    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.
    
    option - Options consisting of key-value pairs that set options. At present, the options consist of dedup and base. Option dedup can take an on|off value to enable or disable deduplication. Deduplication is off by default. Option base takes a string as the initial base IRI for the query.
    
    Returns:
    
    a ModifyPlan object
  - fromSql
```
public abstract PlanBuilder.ModifyPlan fromSql(java.lang.String select)
```
    This function dynamically constructs a row set based on a SQL SELECT query from views.
    
    Parameters:
    
    select - A SQL SELECT query expressed as a string.
    
    Returns:
    
    a ModifyPlan object
  - fromSql
```
public abstract PlanBuilder.ModifyPlan fromSql(XsStringVal select)
```
    This function dynamically constructs a row set based on a SQL SELECT query from views.
    
    Parameters:
    
    select - A SQL SELECT query expressed as a string.
    
    Returns:
    
    a ModifyPlan object
  - fromSql
```
public 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.
    
    Parameters:
    
    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() call
    
    Returns:
    
    a ModifyPlan object
  - fromSql
```
public abstract PlanBuilder.ModifyPlan fromSql(XsStringVal select,
                                               XsStringVal qualifierName)
```
    This function dynamically constructs a row set based on a SQL SELECT query from views.
    
    Parameters:
    
    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() call
    
    Returns:
    
    a ModifyPlan object
  - fromParam
```
public abstract PlanBuilder.AccessPlan fromParam(java.lang.String paramName,
                                                 java.lang.String qualifier,
                                                 PlanRowColTypesSeq rowColTypes)
```
    This function constructs document rows with rows provided by a parameter.
    
    Parameters:
    
    paramName - The paramName parameter specifies the placeholder parameter supplying the rows.
    
    qualifier - Specifies a name for qualifying the column names.
    
    rowColTypes - Describes the columns with a sequence of maps. It's a combinations of column, type and nullable. The 'column' is the column name, which is required. The 'type' is the optional type of the column, which can be an atomic type or the default of none. The 'nullable' is an optional boolean defaulting to false. If your rows contains only uri, doc, collections, metadata, permissions, quality and temporalCollection columns, you could simply use op:doc-col-types instead.
    
    Returns:
    
    a AccessPlan object
  - fromParam
```
public abstract PlanBuilder.AccessPlan fromParam(XsStringVal paramName,
                                                 XsStringVal qualifier,
                                                 PlanRowColTypesSeq rowColTypes)
```
    This function constructs document rows with rows provided by a parameter.
    
    Parameters:
    
    paramName - The paramName parameter specifies the placeholder parameter supplying the rows.
    
    qualifier - Specifies a name for qualifying the column names.
    
    rowColTypes - Describes the columns with a sequence of maps. It's a combinations of column, type and nullable. The 'column' is the column name, which is required. The 'type' is the optional type of the column, which can be an atomic type or the default of none. The 'nullable' is an optional boolean defaulting to false. If your rows contains only uri, doc, collections, metadata, permissions, quality and temporalCollection columns, you could simply use op:doc-col-types instead.
    
    Returns:
    
    a AccessPlan object
  - fromDocDescriptors
```
public abstract PlanBuilder.AccessPlan fromDocDescriptors(PlanDocDescriptor... docDescriptor)
```
    This function constructs document rows from the docsDescriptors.
    
    Parameters:
    
    docDescriptor - A map of document descriptors. Each document descriptor describes a document. A document descriptor contains a combination of uri, doc, collections, metadata, permissions, quality and temporalCollection. This is a simpler form of op:from-param.
    
    Returns:
    
    a AccessPlan object
  - fromDocDescriptors
```
public abstract PlanBuilder.AccessPlan fromDocDescriptors(PlanDocDescriptorSeq docDescriptor)
```
    This function constructs document rows from the docsDescriptors.
    
    Parameters:
    
    docDescriptor - A map of document descriptors. Each document descriptor describes a document. A document descriptor contains a combination of uri, doc, collections, metadata, permissions, quality and temporalCollection. This is a simpler form of op:from-param.
    
    Returns:
    
    a AccessPlan object
  - fromDocDescriptors
```
public abstract PlanBuilder.AccessPlan fromDocDescriptors(PlanDocDescriptorSeq docDescriptor,
                                                          java.lang.String qualifier)
```
    This function constructs document rows from the docsDescriptors.
    
    Parameters:
    
    docDescriptor - A map of document descriptors. Each document descriptor describes a document. A document descriptor contains a combination of uri, doc, collections, metadata, permissions, quality and temporalCollection. This is a simpler form of op:from-param.
    
    qualifier - Specifies a name for qualifying the column names.
    
    Returns:
    
    a AccessPlan object
  - fromDocDescriptors
```
public abstract PlanBuilder.AccessPlan fromDocDescriptors(PlanDocDescriptorSeq docDescriptor,
                                                          XsStringVal qualifier)
```
    This function constructs document rows from the docsDescriptors.
    
    Parameters:
    
    docDescriptor - A map of document descriptors. Each document descriptor describes a document. A document descriptor contains a combination of uri, doc, collections, metadata, permissions, quality and temporalCollection. This is a simpler form of op:from-param.
    
    qualifier - Specifies a name for qualifying the column names.
    
    Returns:
    
    a AccessPlan object
  - sqlCondition
```
public abstract PlanCondition sqlCondition(java.lang.String expression)
```
    This function returns a filter definition as input for a WHERE operation. As with a cts:query or sem:store, the filter definition cannot be used in an Optic Boolean expression but, instead, must be the only argument to the WHERE call. Add a separate WHERE call to filter based on an Optic Boolean expression. The condition must be a valid simple SQL Boolean expression expressed as a string.
    
    Parameters:
    
    expression - A boolean expression, such as op:eq or op:not, that might be null.
    
    Returns:
    
    a PlanCondition object
  - sqlCondition
```
public abstract PlanCondition sqlCondition(XsStringVal expression)
```
    This function returns a filter definition as input for a WHERE operation. As with a cts:query or sem:store, the filter definition cannot be used in an Optic Boolean expression but, instead, must be the only argument to the WHERE call. Add a separate WHERE call to filter based on an Optic Boolean expression. The condition must be a valid simple SQL Boolean expression expressed as a string.
    
    Parameters:
    
    expression - A boolean expression, such as op:eq or op:not, that might be null.
    
    Returns:
    
    a PlanCondition object
  - on
```
public abstract PlanJoinKey on(java.lang.String left,
                               java.lang.String right)
```
    Specifies an equijoin using one columndef each from the left and right rows. The result is used by the op:join-inner, op:join-left-outer, and op:join-full-outer, and functions.
    
    Parameters:
    
    left - The rows from the left view. See col(XsStringVal)
    
    right - The row set from the right view. See col(XsStringVal)
    
    Returns:
    
    a PlanJoinKey object
  - on
```
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, op:join-left-outer, and op:join-full-outer, and functions.
    
    Parameters:
    
    left - The rows from the left view. See col(XsStringVal)
    
    right - The row set from the right view. See col(XsStringVal)
    
    Returns:
    
    a PlanJoinKey object
  - joinKeySeq
```
public abstract PlanJoinKeySeq joinKeySeq(PlanJoinKey... key)
```
    Constructs a sequence from multiple key values to pass as a parameter to an operation.
    
    Parameters:
    
    key - the key values for the sequence See on(PlanExprCol, PlanExprCol)
    
    Returns:
    
    a PlanJoinKeySeq object sequence
  - group
```
public abstract PlanGroup group(PlanExprColSeq keys)
```
    This function specifies the grouping keys for a group as a list of zero or more columns. The result is used for building the first parameter for the op:group-by-union function.
    
    Parameters:
    
    keys - The columns (if any) to use as grouping keys. The columns can be named with a string or a column parameter function such as op:col or constructed from an expression with op:as. See colSeq(PlanExprCol...)
    
    Returns:
    
    a PlanGroup object
  - rollup
```
public abstract PlanGroupSeq rollup(PlanExprColSeq keys)
```
    This function specifies a list of grouping keys for a group and returns that group and larger groups (including all rows) formed by dropping columns from right to left. The result is used for building the first parameter for the op:group-by-union or op:group-to-arrays functions.
    
    Parameters:
    
    keys - The columns to use as grouping keys. The columns can be named with a string or a column parameter function such as op:col or constructed from an expression with op:as. See colSeq(PlanExprCol...)
    
    Returns:
    
    a PlanGroupSeq object sequence
  - cube
```
public abstract PlanGroupSeq cube(PlanExprColSeq keys)
```
    This function specifies a list of grouping keys for a group and returns that group and every possible larger group (including all rows) formed from any subset of keys. The result is used for building the first parameter for the op:group-by-union or op:group-to-arrays functions.
    
    Parameters:
    
    keys - The columns to use as grouping keys. The columns can be named with a string or a column parameter function such as op:col or constructed from an expression with op:as. See colSeq(PlanExprCol...)
    
    Returns:
    
    a PlanGroupSeq object sequence
  - namedGroup
```
public abstract PlanNamedGroup namedGroup(java.lang.String name)
```
    This function specifies the grouping keys for a group as a named list of zero or more columns. The result is used for building the first parameter for the op:group-to-arrays function.
    
    Specified by:
    
    namedGroup in interface PlanBuilderBase
    
    Parameters:
    
    name - The name for the list of grouping keys.
    
    Returns:
    
    a PlanNamedGroup object
  - namedGroup
```
public abstract PlanNamedGroup namedGroup(XsStringVal name)
```
    This function specifies the grouping keys for a group as a named list of zero or more columns. The result is used for building the first parameter for the op:group-to-arrays function.
    
    Parameters:
    
    name - The name for the list of grouping keys.
    
    Returns:
    
    a PlanNamedGroup object
  - namedGroup
```
public abstract PlanNamedGroup namedGroup(java.lang.String name,
                                          java.lang.String keys)
```
    This function specifies the grouping keys for a group as a named list of zero or more columns. The result is used for building the first parameter for the op:group-to-arrays function.
    
    Parameters:
    
    name - The name for the list of grouping keys.
    
    keys - The columns (if any) to use as grouping keys. The columns can be named with a string or a column parameter function such as op:col or constructed from an expression with op:as. See colSeq(PlanExprCol...)
    
    Returns:
    
    a PlanNamedGroup object
  - namedGroup
```
public abstract PlanNamedGroup namedGroup(XsStringVal name,
                                          PlanExprColSeq keys)
```
    This function specifies the grouping keys for a group as a named list of zero or more columns. The result is used for building the first parameter for the op:group-to-arrays function.
    
    Parameters:
    
    name - The name for the list of grouping keys.
    
    keys - The columns (if any) to use as grouping keys. The columns can be named with a string or a column parameter function such as op:col or constructed from an expression with op:as. See colSeq(PlanExprCol...)
    
    Returns:
    
    a PlanNamedGroup object
  - bucketGroup
```
public abstract PlanNamedGroup bucketGroup(java.lang.String name,
                                           java.lang.String key,
                                           java.lang.String boundaries)
```
    This function can be used as a named group in functions op:group-to-arrays or op:facet-by. After grouping, the plan can also join a literal table with descriptive metadata based for each bucket number. Developers can handle special cases by taking the same approach as the convenience function and binding a new column on the return value of an sql:bucket expression on a numeric or datetime column to use as a grouping key.
    
    Parameters:
    
    name - The name of both the group and the new grouping key column with numbered buckets.
    
    key - The identifier for the existing column with the values (typically numeric or datetime) to put into buckets. The columns can be named with a string or a column parameter function such as op:col or constructed from an expression with op:as. See col(XsStringVal)
    
    boundaries - An ordered XQuery sequence of values that specify the boundaries between buckets. The values must have the same type as the existing column.
    
    Returns:
    
    a PlanNamedGroup object
  - bucketGroup
```
public abstract PlanNamedGroup bucketGroup(XsStringVal name,
                                           PlanExprCol key,
                                           XsAnyAtomicTypeSeqVal boundaries)
```
    This function can be used as a named group in functions op:group-to-arrays or op:facet-by. After grouping, the plan can also join a literal table with descriptive metadata based for each bucket number. Developers can handle special cases by taking the same approach as the convenience function and binding a new column on the return value of an sql:bucket expression on a numeric or datetime column to use as a grouping key.
    
    Parameters:
    
    name - The name of both the group and the new grouping key column with numbered buckets.
    
    key - The identifier for the existing column with the values (typically numeric or datetime) to put into buckets. The columns can be named with a string or a column parameter function such as op:col or constructed from an expression with op:as. See col(XsStringVal)
    
    boundaries - An ordered XQuery sequence of values that specify the boundaries between buckets. The values must have the same type as the existing column.
    
    Returns:
    
    a PlanNamedGroup object
  - bucketGroup
```
public abstract PlanNamedGroup bucketGroup(java.lang.String name,
                                           java.lang.String key,
                                           java.lang.String boundaries,
                                           java.lang.String collation)
```
    This function can be used as a named group in functions op:group-to-arrays or op:facet-by. After grouping, the plan can also join a literal table with descriptive metadata based for each bucket number. Developers can handle special cases by taking the same approach as the convenience function and binding a new column on the return value of an sql:bucket expression on a numeric or datetime column to use as a grouping key.
    
    Parameters:
    
    name - The name of both the group and the new grouping key column with numbered buckets.
    
    key - The identifier for the existing column with the values (typically numeric or datetime) to put into buckets. The columns can be named with a string or a column parameter function such as op:col or constructed from an expression with op:as. See col(XsStringVal)
    
    boundaries - An ordered XQuery sequence of values that specify the boundaries between buckets. The values must have the same type as the existing column.
    
    collation - The collation to use when comparing strings as described in 'Collation URI Syntax' in the Application Developer's Guide
    
    Returns:
    
    a PlanNamedGroup object
  - bucketGroup
```
public abstract PlanNamedGroup bucketGroup(XsStringVal name,
                                           PlanExprCol key,
                                           XsAnyAtomicTypeSeqVal boundaries,
                                           XsStringVal collation)
```
    This function can be used as a named group in functions op:group-to-arrays or op:facet-by. After grouping, the plan can also join a literal table with descriptive metadata based for each bucket number. Developers can handle special cases by taking the same approach as the convenience function and binding a new column on the return value of an sql:bucket expression on a numeric or datetime column to use as a grouping key.
    
    Parameters:
    
    name - The name of both the group and the new grouping key column with numbered buckets.
    
    key - The identifier for the existing column with the values (typically numeric or datetime) to put into buckets. The columns can be named with a string or a column parameter function such as op:col or constructed from an expression with op:as. See col(XsStringVal)
    
    boundaries - An ordered XQuery sequence of values that specify the boundaries between buckets. The values must have the same type as the existing column.
    
    collation - The collation to use when comparing strings as described in 'Collation URI Syntax' in the Application Developer's Guide
    
    Returns:
    
    a PlanNamedGroup object
  - avg
```
public 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. The result is used for building the parameters used by the op:group-by function.
    
    Parameters:
    
    name - The name to be used for the aggregated column. See col(XsStringVal)
    
    column - The column to be aggregated. See col(XsStringVal)
    
    Returns:
    
    a PlanAggregateCol object
  - avg
```
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.
    
    Parameters:
    
    name - The name to be used for the aggregated column. See col(XsStringVal)
    
    column - The column to be aggregated. See col(XsStringVal)
    
    Returns:
    
    a PlanAggregateCol object
  - avg
```
public 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. The result is used for building the parameters used by the op:group-by function.
    
    Parameters:
    
    name - The name to be used for the aggregated column. See col(XsStringVal)
    
    column - The column to be aggregated. See col(XsStringVal)
    
    option - The options can take a values key with a distinct value to average the distinct values of the column.
    
    Returns:
    
    a PlanAggregateCol object
  - avg
```
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.
    
    Parameters:
    
    name - The name to be used for the aggregated column. See col(XsStringVal)
    
    column - The column to be aggregated. See col(XsStringVal)
    
    option - The options can take a values key with a distinct value to average the distinct values of the column.
    
    Returns:
    
    a PlanAggregateCol object
  - arrayAggregate
```
public 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. The result is used for building the parameters used by the op:group-by function.
    
    Parameters:
    
    name - The name to be used for the aggregated column. See col(XsStringVal)
    
    column - The columns to be aggregated. See col(XsStringVal)
    
    Returns:
    
    a PlanAggregateCol object
  - arrayAggregate
```
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.
    
    Parameters:
    
    name - The name to be used for the aggregated column. See col(XsStringVal)
    
    column - The columns to be aggregated. See col(XsStringVal)
    
    Returns:
    
    a PlanAggregateCol object
  - arrayAggregate
```
public 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. The result is used for building the parameters used by the op:group-by function.
    
    Parameters:
    
    name - The name to be used for the aggregated column. See col(XsStringVal)
    
    column - The columns to be aggregated. See col(XsStringVal)
    
    option - The options can take a values key with a distinct value to average the distinct values of the column.
    
    Returns:
    
    a PlanAggregateCol object
  - arrayAggregate
```
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.
    
    Parameters:
    
    name - The name to be used for the aggregated column. See col(XsStringVal)
    
    column - The columns to be aggregated. See col(XsStringVal)
    
    option - The options can take a values key with a distinct value to average the distinct values of the column.
    
    Returns:
    
    a PlanAggregateCol object
  - count
```
public abstract PlanAggregateCol count(java.lang.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.
    
    Parameters:
    
    name - The name to be used for the column values. See col(XsStringVal)
    
    Returns:
    
    a PlanAggregateCol object
  - count
```
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.
    
    Parameters:
    
    name - The name to be used for the column values. See col(XsStringVal)
    
    Returns:
    
    a PlanAggregateCol object
  - count
```
public abstract PlanAggregateCol count(java.lang.String name,
                                       java.lang.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.
    
    Parameters:
    
    name - The name to be used for the column values. See col(XsStringVal)
    
    column - The columns to be counted. See col(XsStringVal)
    
    Returns:
    
    a PlanAggregateCol object
  - count
```
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.
    
    Parameters:
    
    name - The name to be used for the column values. See col(XsStringVal)
    
    column - The columns to be counted. See col(XsStringVal)
    
    Returns:
    
    a PlanAggregateCol object
  - count
```
public 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. 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.
    
    Parameters:
    
    name - The name to be used for the column values. See col(XsStringVal)
    
    column - The columns to be counted. See col(XsStringVal)
    
    option - The options can take a values key with a 'distinct' value to count the distinct values of the column.
    
    Returns:
    
    a PlanAggregateCol object
  - count
```
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.
    
    Parameters:
    
    name - The name to be used for the column values. See col(XsStringVal)
    
    column - The columns to be counted. See col(XsStringVal)
    
    option - The options can take a values key with a 'distinct' value to count the distinct values of the column.
    
    Returns:
    
    a PlanAggregateCol object
  - groupKey
```
public abstract PlanAggregateCol groupKey(java.lang.String name,
                                          java.lang.String column)
```
  - groupKey
```
public abstract PlanAggregateCol groupKey(PlanColumn name,
                                          PlanExprCol column)
```
  - hasGroupKey
```
public abstract PlanAggregateCol hasGroupKey(java.lang.String name,
                                             java.lang.String column)
```
    This aggregate function adds a flag to a grouped row specifying whether a column acted as a grouping key for the row.
    
    Parameters:
    
    name - The name to be used for the aggregated flag column. See col(XsStringVal)
    
    column - The column to flag as a grouping key. The column can be named with a string or a column parameter function such as op:col or constructed from an expression with op:as. See col(XsStringVal)
    
    Returns:
    
    a PlanAggregateCol object
  - hasGroupKey
```
public abstract PlanAggregateCol hasGroupKey(PlanColumn name,
                                             PlanExprCol column)
```
    This aggregate function adds a flag to a grouped row specifying whether a column acted as a grouping key for the row.
    
    Parameters:
    
    name - The name to be used for the aggregated flag column. See col(XsStringVal)
    
    column - The column to flag as a grouping key. The column can be named with a string or a column parameter function such as op:col or constructed from an expression with op:as. See col(XsStringVal)
    
    Returns:
    
    a PlanAggregateCol object
  - max
```
public 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. The result is used for building the parameters used by the op:group-by function.
    
    Parameters:
    
    name - The name to be used for the largest value. See col(XsStringVal)
    
    column - The group or row set. See col(XsStringVal)
    
    Returns:
    
    a PlanAggregateCol object
  - max
```
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.
    
    Parameters:
    
    name - The name to be used for the largest value. See col(XsStringVal)
    
    column - The group or row set. See col(XsStringVal)
    
    Returns:
    
    a PlanAggregateCol object
  - max
```
public 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. The result is used for building the parameters used by the op:group-by function.
    
    Parameters:
    
    name - The name to be used for the largest value. See col(XsStringVal)
    
    column - The group or row set. See col(XsStringVal)
    
    option - The options can take a values key with a distinct value to average the distinct values of the column.
    
    Returns:
    
    a PlanAggregateCol object
  - max
```
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.
    
    Parameters:
    
    name - The name to be used for the largest value. See col(XsStringVal)
    
    column - The group or row set. See col(XsStringVal)
    
    option - The options can take a values key with a distinct value to average the distinct values of the column.
    
    Returns:
    
    a PlanAggregateCol object
  - min
```
public 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. The result is used for building the parameters used by the op:group-by function.
    
    Parameters:
    
    name - The name to be used for the smallest value. See col(XsStringVal)
    
    column - The group or row set. See col(XsStringVal)
    
    Returns:
    
    a PlanAggregateCol object
  - min
```
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.
    
    Parameters:
    
    name - The name to be used for the smallest value. See col(XsStringVal)
    
    column - The group or row set. See col(XsStringVal)
    
    Returns:
    
    a PlanAggregateCol object
  - min
```
public 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. The result is used for building the parameters used by the op:group-by function.
    
    Parameters:
    
    name - The name to be used for the smallest value. See col(XsStringVal)
    
    column - The group or row set. See col(XsStringVal)
    
    option - The options can take a values key with a distinct value to average the distinct values of the column.
    
    Returns:
    
    a PlanAggregateCol object
  - min
```
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.
    
    Parameters:
    
    name - The name to be used for the smallest value. See col(XsStringVal)
    
    column - The group or row set. See col(XsStringVal)
    
    option - The options can take a values key with a distinct value to average the distinct values of the column.
    
    Returns:
    
    a PlanAggregateCol object
  - sample
```
public 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. The result is used for building the parameters used by the op:group-by function.
    
    Parameters:
    
    name - The name to be used for the value. See col(XsStringVal)
    
    column - The group or row set. See col(XsStringVal)
    
    Returns:
    
    a PlanAggregateCol object
  - sample
```
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.
    
    Parameters:
    
    name - The name to be used for the value. See col(XsStringVal)
    
    column - The group or row set. See col(XsStringVal)
    
    Returns:
    
    a PlanAggregateCol object
  - sequenceAggregate
```
public 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. The result is used for building the parameters used by the op:group-by function.
    
    Parameters:
    
    name - The name to be used for the aggregated column. See col(XsStringVal)
    
    column - The column with the values to aggregate. See col(XsStringVal)
    
    Returns:
    
    a PlanAggregateCol object
  - sequenceAggregate
```
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.
    
    Parameters:
    
    name - The name to be used for the aggregated column. See col(XsStringVal)
    
    column - The column with the values to aggregate. See col(XsStringVal)
    
    Returns:
    
    a PlanAggregateCol object
  - sequenceAggregate
```
public 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. The result is used for building the parameters used by the op:group-by function.
    
    Parameters:
    
    name - The name to be used for the aggregated column. See col(XsStringVal)
    
    column - The column with the values to aggregate. See col(XsStringVal)
    
    option - The options can take a values key with a distinct value to average the distinct values of the column.
    
    Returns:
    
    a PlanAggregateCol object
  - sequenceAggregate
```
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.
    
    Parameters:
    
    name - The name to be used for the aggregated column. See col(XsStringVal)
    
    column - The column with the values to aggregate. See col(XsStringVal)
    
    option - The options can take a values key with a distinct value to average the distinct values of the column.
    
    Returns:
    
    a PlanAggregateCol object
  - sum
```
public 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. The result is used for building the parameters used by the op:group-by function.
    
    Parameters:
    
    name - The name to be used for the aggregated column. See col(XsStringVal)
    
    column - The column with the values to add. See col(XsStringVal)
    
    Returns:
    
    a PlanAggregateCol object
  - sum
```
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.
    
    Parameters:
    
    name - The name to be used for the aggregated column. See col(XsStringVal)
    
    column - The column with the values to add. See col(XsStringVal)
    
    Returns:
    
    a PlanAggregateCol object
  - sum
```
public 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. The result is used for building the parameters used by the op:group-by function.
    
    Parameters:
    
    name - The name to be used for the aggregated column. See col(XsStringVal)
    
    column - The column with the values to add. See col(XsStringVal)
    
    option - The options can take a values key with a distinct value to average the distinct values of the column.
    
    Returns:
    
    a PlanAggregateCol object
  - sum
```
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.
    
    Parameters:
    
    name - The name to be used for the aggregated column. See col(XsStringVal)
    
    column - The column with the values to add. See col(XsStringVal)
    
    option - The options can take a values key with a distinct value to average the distinct values of the column.
    
    Returns:
    
    a PlanAggregateCol object
  - uda
```
public 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. The UDF plugin must be installed on each host. The result is used for building the parameters used by the op:group-by function.
    
    Parameters:
    
    name - The name to be used for the aggregated column. See col(XsStringVal)
    
    column - The column with the values to aggregate. See col(XsStringVal)
    
    module - The path to the installed plugin module.
    
    function - The name of the UDF function.
    
    Returns:
    
    a PlanAggregateCol object
  - uda
```
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.
    
    Parameters:
    
    name - The name to be used for the aggregated column. See col(XsStringVal)
    
    column - The column with the values to aggregate. See col(XsStringVal)
    
    module - The path to the installed plugin module.
    
    function - The name of the UDF function.
    
    Returns:
    
    a PlanAggregateCol object
  - uda
```
public 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. The UDF plugin must be installed on each host. The result is used for building the parameters used by the op:group-by function.
    
    Parameters:
    
    name - The name to be used for the aggregated column. See col(XsStringVal)
    
    column - The column with the values to aggregate. See col(XsStringVal)
    
    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.
    
    Returns:
    
    a PlanAggregateCol object
  - uda
```
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.
    
    Parameters:
    
    name - The name to be used for the aggregated column. See col(XsStringVal)
    
    column - The column with the values to aggregate. See col(XsStringVal)
    
    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.
    
    Returns:
    
    a PlanAggregateCol object
  - aggregateSeq
```
public abstract PlanAggregateColSeq aggregateSeq(PlanAggregateCol... aggregate)
```
    Constructs a sequence from multiple aggregate values to pass as a parameter to an operation.
    
    Parameters:
    
    aggregate - the aggregate values for the sequence
    
    Returns:
    
    a PlanAggregateColSeq object sequence
  - asc
```
public abstract PlanSortKey asc(java.lang.String column)
```
    This function sorts the rows by the values of the specified column in ascending order. The results are used by the op:order-by function.
    
    Parameters:
    
    column - The column by which order the output. See col(XsStringVal)
    
    Returns:
    
    a PlanSortKey object
  - asc
```
public abstract PlanSortKey asc(PlanExprCol column)
```
    This function sorts the rows by the values of the specified column in ascending order. The results are used by the op:order-by function.
    
    Parameters:
    
    column - The column by which order the output. See col(XsStringVal)
    
    Returns:
    
    a PlanSortKey object
  - desc
```
public abstract PlanSortKey desc(java.lang.String column)
```
    This function sorts the rows by the values of the specified column in descending order. The results are used by the op:order-by function.
    
    Parameters:
    
    column - The column by which order the output. See col(XsStringVal)
    
    Returns:
    
    a PlanSortKey object
  - desc
```
public abstract PlanSortKey desc(PlanExprCol column)
```
    This function sorts the rows by the values of the specified column in descending order. The results are used by the op:order-by function.
    
    Parameters:
    
    column - The column by which order the output. See col(XsStringVal)
    
    Returns:
    
    a PlanSortKey object
  - sortKeySeq
```
public abstract PlanSortKeySeq sortKeySeq(PlanSortKey... key)
```
    Constructs a sequence from multiple key values to pass as a parameter to an operation.
    
    Parameters:
    
    key - the key values for the sequence See desc(PlanExprCol)
    
    Returns:
    
    a PlanSortKeySeq object sequence
  - modulo
```
public abstract ServerExpression 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 the op:modulo server function.
    
    Parameters:
    
    left - The dividend numeric expression. (of xs:numeric)
    
    right - The divisor numeric expression. (of xs:numeric)
    
    Returns:
    
    a server expression with the xs:numeric server data type
  - modulo
```
public abstract ServerExpression modulo(ServerExpression left,
                                        ServerExpression 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 the op:modulo server function.
    
    Parameters:
    
    left - The dividend numeric expression. (of xs:numeric)
    
    right - The divisor numeric expression. (of xs:numeric)
    
    Returns:
    
    a server expression with the xs:numeric server data type
  - when
```
public abstract PlanCase when(boolean condition,
                              ServerExpression... 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.
    
    Parameters:
    
    condition - A boolean expression. (of xs:boolean)
    
    value - The value expression to return if the boolean expression is true. (of item)
    
    Returns:
    
    a PlanCase object
  - when
```
public abstract PlanCase when(ServerExpression condition,
                              ServerExpression... 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.
    
    Parameters:
    
    condition - A boolean expression. (of xs:boolean)
    
    value - The value expression to return if the boolean expression is true. (of item)
    
    Returns:
    
    a PlanCase object
  - xpath
```
public 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. 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 the op:xpath server function.
    
    Parameters:
    
    column - The name of the column from which to extract the child nodes. See col(XsStringVal)
    
    path - An XPath (specified as a string) to apply to each node. (of xs:string)
    
    Returns:
    
    a server expression with the node server data type
  - xpath
```
public 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. 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 the op:xpath server function.
    
    Parameters:
    
    column - The name of the column from which to extract the child nodes. See col(XsStringVal)
    
    path - An XPath (specified as a string) to apply to each node. (of xs:string)
    
    Returns:
    
    a server expression with the node server data type
  - xpath
```
public abstract ServerExpression xpath(java.lang.String column,
                                       java.lang.String path,
                                       PlanNamespaceBindingsSeq namespaceBindings)
```
    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 the op:xpath server function.
    
    Parameters:
    
    column - The name of the column from which to extract the child nodes. See col(XsStringVal)
    
    path - An XPath (specified as a string) to apply to each node. (of xs:string)
    
    namespaceBindings - A map of namespace bindings. The keys should be namespace prefixes and the values should be namespace URIs. These namespace bindings will be added to the in-scope namespace bindings in the evaluation of the path.
    
    Returns:
    
    a server expression with the node server data type
  - xpath
```
public abstract ServerExpression xpath(PlanColumn column,
                                       ServerExpression path,
                                       PlanNamespaceBindingsSeq namespaceBindings)
```
    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 the op:xpath server function.
    
    Parameters:
    
    column - The name of the column from which to extract the child nodes. See col(XsStringVal)
    
    path - An XPath (specified as a string) to apply to each node. (of xs:string)
    
    namespaceBindings - A map of namespace bindings. The keys should be namespace prefixes and the values should be namespace URIs. These namespace bindings will be added to the in-scope namespace bindings in the evaluation of the path.
    
    Returns:
    
    a server expression with the node server data type
  - jsonDocument
```
public 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.
    Provides a client interface to the op:json-document server function.
    
    Parameters:
    
    root - The JSON object or array node used to construct the JSON document. (of json-root-node)
    
    Returns:
    
    a server expression with the document-node server data type
  - prop
```
public 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 constructed by the op:json-object function.
    
    Parameters:
    
    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)
    
    Returns:
    
    a PlanJsonProperty object
  - prop
```
public abstract PlanJsonProperty prop(ServerExpression key,
                                      ServerExpression value)
```
    This function specifies the key expression and value content for a JSON property of a JSON object constructed by the op:json-object function.
    
    Parameters:
    
    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)
    
    Returns:
    
    a PlanJsonProperty object
  - jsonString
```
public abstract ServerExpression jsonString(java.lang.String value)
```
    This function constructs a JSON text node with the specified value.
    Provides a client interface to the op:json-string server function.
    
    Parameters:
    
    value - The value of the JSON text node. (of xs:anyAtomicType)
    
    Returns:
    
    a server expression with the text-node server data type
  - jsonString
```
public abstract ServerExpression jsonString(ServerExpression value)
```
    This function constructs a JSON text node with the specified value.
    Provides a client interface to the op:json-string server function.
    
    Parameters:
    
    value - The value of the JSON text node. (of xs:anyAtomicType)
    
    Returns:
    
    a server expression with the text-node server data type
  - jsonNumber
```
public abstract ServerExpression jsonNumber(double value)
```
    This function constructs a JSON number node with the specified value.
    Provides a client interface to the op:json-number server function.
    
    Parameters:
    
    value - The value of the JSON number node. (of xs:numeric)
    
    Returns:
    
    a server expression with the number-node server data type
  - jsonNumber
```
public abstract ServerExpression jsonNumber(ServerExpression value)
```
    This function constructs a JSON number node with the specified value.
    Provides a client interface to the op:json-number server function.
    
    Parameters:
    
    value - The value of the JSON number node. (of xs:numeric)
    
    Returns:
    
    a server expression with the number-node server data type
  - jsonBoolean
```
public abstract ServerExpression jsonBoolean(boolean value)
```
    This function constructs a JSON boolean node with the specified value.
    Provides a client interface to the op:json-boolean server function.
    
    Parameters:
    
    value - The value of the JSON boolean node. (of xs:boolean)
    
    Returns:
    
    a server expression with the boolean-node server data type
  - jsonBoolean
```
public abstract ServerExpression jsonBoolean(ServerExpression value)
```
    This function constructs a JSON boolean node with the specified value.
    Provides a client interface to the op:json-boolean server function.
    
    Parameters:
    
    value - The value of the JSON boolean node. (of xs:boolean)
    
    Returns:
    
    a server expression with the boolean-node server data type
  - jsonNull
```
public abstract ServerExpression jsonNull()
```
    This function constructs a JSON null node.
    Provides a client interface to the op:json-null server function.
    
    Returns:
    
    a server expression with the null-node server data type
  - xmlDocument
```
public abstract ServerExpression xmlDocument(ServerExpression root)
```
    This function constructs an XML document with the root content, which must be exactly one node.
    Provides a client interface to the op:xml-document server function.
    
    Parameters:
    
    root - The XML node used to construct the XML document. (of xml-root-node)
    
    Returns:
    
    a server expression with the document-node server data type
  - xmlElement
```
public 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. 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 the op:xml-element server function.
    
    Parameters:
    
    name - The string or QName for the constructed element. (of xs:QName)
    
    Returns:
    
    a server expression with the element-node server data type
  - xmlElement
```
public 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. 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 the op:xml-element server function.
    
    Parameters:
    
    name - The string or QName for the constructed element. (of xs:QName)
    
    Returns:
    
    a server expression with the element-node server data type
  - xmlElement
```
public 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. 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 the op:xml-element server function.
    
    Parameters:
    
    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)
    
    Returns:
    
    a server expression with the element-node server data type
  - xmlElement
```
public 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. 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 the op:xml-element server function.
    
    Parameters:
    
    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)
    
    Returns:
    
    a server expression with the element-node server data type
  - xmlElement
```
public 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. 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 the op:xml-element server function.
    
    Parameters:
    
    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)
    
    Returns:
    
    a server expression with the element-node server data type
  - xmlElement
```
public 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. 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 the op:xml-element server function.
    
    Parameters:
    
    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)
    
    Returns:
    
    a server expression with the element-node server data type
  - xmlAttribute
```
public 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.
    Provides a client interface to the op:xml-attribute server function.
    
    Parameters:
    
    name - The attribute name. (of xs:QName)
    
    value - The attribute value. (of xs:anyAtomicType)
    
    Returns:
    
    a server expression with the attribute-node server data type
  - xmlAttribute
```
public 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.
    Provides a client interface to the op:xml-attribute server function.
    
    Parameters:
    
    name - The attribute name. (of xs:QName)
    
    value - The attribute value. (of xs:anyAtomicType)
    
    Returns:
    
    a server expression with the attribute-node server data type
  - xmlText
```
public abstract ServerExpression xmlText(java.lang.String value)
```
    This function constructs an XML text node with the specified value.
    Provides a client interface to the op:xml-text server function.
    
    Parameters:
    
    value - The value of the XML text node. (of xs:anyAtomicType)
    
    Returns:
    
    a server expression with the text-node server data type
  - xmlText
```
public abstract ServerExpression xmlText(ServerExpression value)
```
    This function constructs an XML text node with the specified value.
    Provides a client interface to the op:xml-text server function.
    
    Parameters:
    
    value - The value of the XML text node. (of xs:anyAtomicType)
    
    Returns:
    
    a server expression with the text-node server data type
  - xmlComment
```
public abstract ServerExpression xmlComment(java.lang.String content)
```
    This function constructs an XML comment with the atomic value.
    Provides a client interface to the op:xml-comment server function.
    
    Parameters:
    
    content - The comment text. (of xs:anyAtomicType)
    
    Returns:
    
    a server expression with the comment-node server data type
  - xmlComment
```
public abstract ServerExpression xmlComment(ServerExpression content)
```
    This function constructs an XML comment with the atomic value.
    Provides a client interface to the op:xml-comment server function.
    
    Parameters:
    
    content - The comment text. (of xs:anyAtomicType)
    
    Returns:
    
    a server expression with the comment-node server data type
  - xmlPi
```
public abstract ServerExpression xmlPi(java.lang.String name,
                                       java.lang.String value)
```
    This function constructs an XML processing instruction with the atomic value.
    Provides a client interface to the op:xml-pi server function.
    
    Parameters:
    
    name - The name of the processing instruction. (of xs:string)
    
    value - The value of the processing instruction. (of xs:anyAtomicType)
    
    Returns:
    
    a server expression with the processing-instruction-node server data type
  - xmlPi
```
public abstract ServerExpression xmlPi(ServerExpression name,
                                       ServerExpression value)
```
    This function constructs an XML processing instruction with the atomic value.
    Provides a client interface to the op:xml-pi server function.
    
    Parameters:
    
    name - The name of the processing instruction. (of xs:string)
    
    value - The value of the processing instruction. (of xs:anyAtomicType)
    
    Returns:
    
    a server expression with the processing-instruction-node server data type
  - xmlAttributeSeq
```
public abstract ServerExpression xmlAttributeSeq(ServerExpression... attribute)
```
    Constructs a sequence from multiple attribute values to pass as a parameter to an operation.
    Provides a client interface to the op:xml-attribute-seq server function.
    
    Parameters:
    
    attribute - the attribute values for the sequence
    
    Returns:
    
    a server expression with the attribute-node server data type
  - resolveFunction
```
public abstract PlanFunction resolveFunction(java.lang.String 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.
    
    Parameters:
    
    functionName - the name of the function installed on the server
    
    modulePath - the path on the server for the library module providing the function
    
    Returns:
    
    a PlanFunction object
  - resolveFunction
```
public abstract PlanFunction resolveFunction(XsQNameVal functionName,
                                             XsStringVal modulePath)
```
    Specifies a JavaScript or XQuery function installed on the server for use in post-processing in a map() or reduce() operation.
    
    Parameters:
    
    functionName - the name of the function installed on the server
    
    modulePath - the path on the server for the library module providing the function
    
    Returns:
    
    a PlanFunction object
  - docCols
```
public abstract PlanDocColsIdentifier docCols()
```
    Constructs a document column identifier object for columns of uri, doc, collections, metadata, permissions, quality and temporalCollection. The document column identifier object can be passed to the op:join-doc-cols or op:write.
    
    Returns:
    
    a PlanDocColsIdentifier object
  - docCols
```
public abstract PlanDocColsIdentifier docCols(java.lang.String qualifier)
```
    Constructs a document column identifier object for columns of uri, doc, collections, metadata, permissions, quality and temporalCollection. The document column identifier object can be passed to the op:join-doc-cols or op:write.
    
    Parameters:
    
    qualifier - Specifies a name for qualifying the column names.
    
    Returns:
    
    a PlanDocColsIdentifier object
  - docCols
```
public abstract PlanDocColsIdentifier docCols(XsStringVal qualifier)
```
    Constructs a document column identifier object for columns of uri, doc, collections, metadata, permissions, quality and temporalCollection. The document column identifier object can be passed to the op:join-doc-cols or op:write.
    
    Parameters:
    
    qualifier - Specifies a name for qualifying the column names.
    
    Returns:
    
    a PlanDocColsIdentifier object
  - docCols
```
public abstract PlanDocColsIdentifier docCols(java.lang.String qualifier,
                                              java.lang.String names)
```
    Constructs a document column identifier object for columns of uri, doc, collections, metadata, permissions, quality and temporalCollection. The document column identifier object can be passed to the op:join-doc-cols or op:write.
    
    Parameters:
    
    qualifier - Specifies a name for qualifying the column names.
    
    names - A sequence of columns names, a combination of uri, doc, collections, metadata, permissions, quality and temporalCollection.
    
    Returns:
    
    a PlanDocColsIdentifier object
  - docCols
```
public abstract PlanDocColsIdentifier docCols(XsStringVal qualifier,
                                              XsStringSeqVal names)
```
    Constructs a document column identifier object for columns of uri, doc, collections, metadata, permissions, quality and temporalCollection. The document column identifier object can be passed to the op:join-doc-cols or op:write.
    
    Parameters:
    
    qualifier - Specifies a name for qualifying the column names.
    
    names - A sequence of columns names, a combination of uri, doc, collections, metadata, permissions, quality and temporalCollection.
    
    Returns:
    
    a PlanDocColsIdentifier object
  - docColTypes
```
public abstract PlanRowColTypesSeq docColTypes()
```
    Provides the 3rd parameter for op:from-param for row column types.
    
    Returns:
    
    a PlanRowColTypesSeq object sequence

Class PlanBuilder

Nested Class Summary

Nested classes/interfaces inherited from interface com.marklogic.client.expression.PlanBuilderBase

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.marklogic.client.expression.PlanBuilderBase

Field Detail

cts

fn

geo

json

map

math

rdf

sem

spell

sql

vec

xdmp

xs

rdt

Constructor Detail

PlanBuilder

Method Detail

add

and

divide

eq

ge

gt

in

isDefined

le

lt

multiply

ne

not

or

subtract

patchBuilder

patchBuilder

patchBuilder

patchBuilder

param

param

col

col

schemaCol

schemaCol

viewCol

viewCol

fragmentIdCol

fragmentIdCol

graphCol

graphCol

as

as

colSeq

colSeq

fromView

fromView

fromView

fromView

fromView

fromView

prefixer

prefixer

fromTriples

fromTriples

fromTriples

fromTriples

fromTriples

fromTriples

fromTriples

fromTriples

pattern

pattern

patternSeq