PlanBuilderBase (MarkLogic Java Client API 7.0.0)

All Known Implementing Classes:

PlanBuilder
```
public interface PlanBuilderBase
```
Defines base methods for PlanBuilder. This interface is an implementation detail. Use PlanBuilder as the type for instances of PlanBuilder.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`PlanBuilderBase.AccessPlanBase` Defines base methods for AccessPlan.
`static interface`	`PlanBuilderBase.ExportablePlanBase` Defines base methods for ExportablePlan.
`static interface`	`PlanBuilderBase.ModifyPlanBase` Defines base methods for ModifyPlan.
`static interface`	`PlanBuilderBase.PlanBase` Defines base methods for Plan.
`static interface`	`PlanBuilderBase.PreparePlanBase` Defines base methods for PreparePlan.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ServerExpression`	`caseExpr(PlanCase... cases)` This function returns the specified value expression if the specified value expression is true.
`PlanRowColTypes`	`colType(java.lang.String column)` Build a new column identifier; the type will default to "none" and nullable will default to "false".
`PlanRowColTypes`	`colType(java.lang.String column, java.lang.String type)` Build a new column identifier; nullable will default to "false".
`PlanRowColTypes`	`colType(java.lang.String column, java.lang.String type, java.lang.Boolean nullable)` Build a new column identifier.
`PlanRowColTypesSeq`	`colTypes(PlanRowColTypes... colTypes)` Build a sequence of column identifiers that can be used with `fromParam`.
`PlanGroupSeq`	`cube(java.lang.String... keys)` Specifies the keys for a sequence of groups that provide a cube for a row set.
`PlanDocColsIdentifier`	`docCols(java.util.Map<java.lang.String,PlanColumn> descriptorColumnMapping)` Construct a mapping of document descriptor column names to columns in the plan.
`PlanDocDescriptor`	`docDescriptor(DocumentWriteOperation writeOp)` Build a single doc descriptor that can be used with `fromDocDescriptors`.
`PlanDocDescriptorSeq`	`docDescriptors(DocumentWriteSet writeSet)` Build a sequence of doc descriptors that can be used with `fromDocDescriptors`.
`PlanCase`	`elseExpr(ServerExpression value)` This function returns the specified value if none of the preceeding when() conditions are true.
`PlanBuilder.AccessPlan`	`fromDocUris(CtsQueryExpr querydef)` Construct an `AccessPlan` based on the URIs returned by the given query.
`PlanBuilder.AccessPlan`	`fromDocUris(CtsQueryExpr querydef, java.lang.String qualifierName)` Construct an `AccessPlan` based on the URIs returned by the given query.
`PlanBuilder.AccessPlan`	`fromDocUris(java.lang.String... uris)` Convenience method for constructing an `AccessPlan` based on a given set of URIs.
`PlanBuilder.AccessPlan`	`fromLiterals(java.util.Map<java.lang.String,java.lang.Object>... rows)` Constructs a literal row set as in the SQL VALUES or SPARQL VALUES statements.
`PlanBuilder.AccessPlan`	`fromLiterals(java.util.Map<java.lang.String,java.lang.Object>[] rows, java.lang.String qualifierName)` Constructs a literal row set as in the SQL VALUES or SPARQL VALUES statements.
`PlanBuilder.AccessPlan`	`fromLiterals(java.util.Map<java.lang.String,java.lang.Object>[] rows, XsStringVal qualifierName)` Constructs a literal row set as in the SQL VALUES or SPARQL VALUES statements.
`PlanBuilder.AccessPlan`	`fromSearch(CtsQueryExpr query)` Supports document matching and relevance by constructing rows with the document fragment id and columns for relevance factors.
`PlanBuilder.AccessPlan`	`fromSearch(CtsQueryExpr query, PlanExprCol... columns)` Supports document matching and relevance by constructing rows with the document fragment id and columns for relevance factors.
`PlanBuilder.AccessPlan`	`fromSearch(CtsQueryExpr query, PlanExprColSeq columns, java.lang.String qualifierName)` Supports document matching and relevance by constructing rows with the document fragment id and columns for relevance factors.
`PlanBuilder.AccessPlan`	`fromSearch(CtsQueryExpr query, PlanExprColSeq columns, XsStringVal qualifierName, PlanSearchOptions options)` Supports document matching and relevance by constructing rows with the document fragment id and columns for relevance factors.
`PlanBuilder.AccessPlan`	`fromSearchDocs(CtsQueryExpr query)` Provides a convenience for matching documents and constructing rows with the score, document URI, and document content.
`PlanBuilder.AccessPlan`	`fromSearchDocs(CtsQueryExpr query, java.lang.String qualifierName)` Provides a convenience for matching documents and constructing rows with the score, document URI, and document content.
`PlanBuilder.AccessPlan`	`fromSearchDocs(CtsQueryExpr query, java.lang.String qualifierName, PlanSearchOptions options)` Provides a convenience for matching documents and constructing rows with the score, document URI, and document content.
`PlanGroup`	`group(java.lang.String... keys)` Specifies the keys for a group when grouping a row set in multiple ways with `PlanBuilderBase.ModifyPlanBase.groupByUnion(PlanGroupSeq, PlanAggregateColSeq)`.
`PlanAggregateCol`	`groupConcat(PlanColumn name, PlanExprCol column)` This function concatenates the non-null values of the column for the rows in the group or row set.
`PlanAggregateCol`	`groupConcat(PlanColumn name, PlanExprCol column, PlanGroupConcatOptionSeq options)` This function concatenates the non-null values of the column for the rows in the group or row set.
`PlanAggregateCol`	`groupConcat(java.lang.String name, java.lang.String column)` This function concatenates the non-null values of the column for the rows in the group or row set.
`PlanAggregateCol`	`groupConcat(java.lang.String name, java.lang.String column, PlanGroupConcatOptionSeq options)` This function concatenates the non-null values of the column for the rows in the group or row set.
`PlanGroupConcatOptionSeq`	`groupConcatOptions(PlanValueOption option)` Specifies options for aggregating the values of a column for the rows belonging to each group by concatenating the values into a single string value.
`PlanGroupConcatOptionSeq`	`groupConcatOptions(java.lang.String separator)` Specifies options for aggregating the values of a column for the rows belonging to each group by concatenating the values into a single string value.
`PlanGroupConcatOptionSeq`	`groupConcatOptions(java.lang.String separator, PlanValueOption option)` Specifies options for aggregating the values of a column for the rows belonging to each group by concatenating the values into a single string value.
`PlanGroupSeq`	`groupSeq(PlanGroup... group)` Provides the sequence of groups when grouping a row set in multiple ways with `PlanBuilderBase.ModifyPlanBase.groupByUnion(PlanGroupSeq, PlanAggregateColSeq)`.
`ServerExpression`	`jsonArray(ServerExpression... property)` This function constructs a JSON array during row processing.
`ServerExpression`	`jsonObject(PlanJsonProperty... property)` This function constructs a JSON object with the specified properties.
`PlanNamedGroup`	`namedGroup(java.lang.String name)` Specifies the name for a named group over all rows when grouping a row set in multiple ways with `PlanBuilderBase.ModifyPlanBase.groupToArrays(PlanNamedGroupSeq, PlanAggregateColSeq)`.
`PlanNamedGroup`	`namedGroup(java.lang.String name, PlanExprColSeq keys)` Specifies the name and keys for a named group when grouping a row set in multiple ways with `PlanBuilderBase.ModifyPlanBase.groupToArrays(PlanNamedGroupSeq, PlanAggregateColSeq)`.
`PlanNamedGroupSeq`	`namedGroupSeq(PlanNamedGroup... namedGroup)` Provides the sequence of named groups when grouping a row set in multiple ways with `PlanBuilderBase.ModifyPlanBase.groupToArrays(PlanNamedGroupSeq, PlanAggregateColSeq)`.
`ServerExpression`	`permission(java.lang.String roleName, java.lang.String capability)` Convenience method for constructing a permission that can then be used e.g.
`PlanFunction`	`resolveFunction(XsQNameVal functionName, java.lang.String modulePath)` Specifies a JavaScript or XQuery function installed on the server for use in post-processing in a map() or reduce() operation.
`PlanGroupSeq`	`rollup(java.lang.String... keys)` Specifies the keys for a sequence of groups that provide a rollup for a row set.
`PlanSampleByOptions`	`sampleByOptions()` Provides a sample-by option object to configure the execution of the `PlanBuilder.sample(PlanColumn, PlanExprCol)` modifier for sampling a view, triples, or lexicon index.
`SchemaDefExpr`	`schemaDefinition(java.lang.String kind)` Build a schema definition for use with `validateDoc`.
`PlanSearchOptions`	`searchOptions()` Provides a search options object to configure the execution of the `fromSearch(CtsQueryExpr, PlanExprColSeq, XsStringVal, PlanSearchOptions)` accessor.
`ServerExpression`	`seq(ServerExpression... expression)` Collects a sequence of server expressions as a new server expression for evaluation on the server.
`PlanSparqlOptions`	`sparqlOptions()` Provides a SPARQL option object to configure the execution of the `PlanBuilder.fromSparql(XsStringVal, XsStringVal, PlanSparqlOptions)` accessor.
`TransformDef`	`transformDef(java.lang.String path)` Build a transform definition for use with `transformDoc`.

- Method Detail
  - fromSearchDocs
```
PlanBuilder.AccessPlan fromSearchDocs(CtsQueryExpr query)
```
    Provides a convenience for matching documents and constructing rows with the score, document URI, and document content. The convenience is equivalent to chaining fromSearch(CtsQueryExpr), PlanBuilder.ModifyPlan.joinDocUri(String, String), and PlanBuilder.ModifyPlan.joinDoc(String, String).
    The documents can be ordered by the score and limited for the most relevant documents.
    
    Parameters:
    
    query - The cts.query expression for matching the documents.
    
    Returns:
    
    a ModifyPlan object
  - fromSearchDocs
```
PlanBuilder.AccessPlan fromSearchDocs(CtsQueryExpr query,
                                      java.lang.String qualifierName)
```
    Provides a convenience for matching documents and constructing rows with the score, document URI, and document content. The convenience is equivalent to chaining fromSearch(CtsQueryExpr), PlanBuilder.ModifyPlan.joinDocUri(String, String), and PlanBuilder.ModifyPlan.joinDoc(String, String).
    The documents can be ordered by the score and limited for the most relevant documents.
    
    Parameters:
    
    query - The cts.query expression for matching the documents.
    
    qualifierName - Specifies a name for qualifying the column names similar to a view name.
    
    Returns:
    
    a ModifyPlan object
  - fromSearchDocs
```
PlanBuilder.AccessPlan fromSearchDocs(CtsQueryExpr query,
                                      java.lang.String qualifierName,
                                      PlanSearchOptions options)
```
    Provides a convenience for matching documents and constructing rows with the score, document URI, and document content. The convenience is equivalent to chaining fromSearch(CtsQueryExpr), PlanBuilder.ModifyPlan.joinDocUri(String, String), and PlanBuilder.ModifyPlan.joinDoc(String, String).
    The documents can be ordered by the score and limited for the most relevant documents.
    
    Parameters:
    
    query - The cts.query expression for matching the documents.
    
    qualifierName - Specifies a name for qualifying the column names similar to a view name.
    
    Returns:
    
    a ModifyPlan object
    
    Since:
    
    7.0.0; requires MarkLogic 12 or higher.
  - fromSearch
```
PlanBuilder.AccessPlan fromSearch(CtsQueryExpr query)
```
    Supports document matching and relevance by constructing rows with the document fragment id and columns for relevance factors. Typically, the plan will join the rows on the document fragment id with the content of documents or with rows, triples, or lexicons indexed on the documents (where the lexicons include range indexes, the document URI lexicon, and the collection lexicon).
    The documents can be ordered by the score or other relevance factors and limited for the most relevant documents.
    
    By default, the rows provide fragmentId and score columns.
    
    Parameters:
    
    query - The cts.query expression for matching the documents.
    
    Returns:
    
    an AccessPlan object
  - fromSearch
```
PlanBuilder.AccessPlan fromSearch(CtsQueryExpr query,
                                  PlanExprCol... columns)
```
    Supports document matching and relevance by constructing rows with the document fragment id and columns for relevance factors. Typically, the plan will join the rows on the document fragment id with the content of documents or with rows, triples, or lexicons indexed on the documents (where the lexicons include range indexes, the document URI lexicon, and the collection lexicon).
    The documents can be ordered by the score or other relevance factors and limited for the most relevant documents.
    
    The list of possible columns to project consists of fragmentId, confidence, fitness, quality, and score. The columns other than the fragmentId provide the same relevance factors as the cts.confidence(), cts.fitness(), cts.quality(), and cts.score() functions on the server. Pass PlanBuilder.as(String, ServerExpression) to rename a column. The default columns are fragmentId and score.
    
    Parameters:
    
    query - The cts.query expression for matching the documents.
    
    columns - The columns to project for the documents. See PlanBuilder.colSeq(String...)
    
    Returns:
    
    an AccessPlan object
  - fromSearch
```
PlanBuilder.AccessPlan fromSearch(CtsQueryExpr query,
                                  PlanExprColSeq columns,
                                  java.lang.String qualifierName)
```
    Supports document matching and relevance by constructing rows with the document fragment id and columns for relevance factors. Typically, the plan will join the rows on the document fragment id with the content of documents or with rows, triples, or lexicons indexed on the documents (where the lexicons include range indexes, the document URI lexicon, and the collection lexicon).
    The documents can be ordered by the score or other relevance factors and limited for the most relevant documents.
    
    The list of possible columns to project consists of fragmentId, confidence, fitness, quality, and score. The columns other than the fragmentId provide the same relevance factors as the cts.confidence(), cts.fitness(), cts.quality(), and cts.score() functions on the server. Pass PlanBuilder.as(String, ServerExpression) to rename a column. The default columns are fragmentId and score.
    
    Parameters:
    
    query - The cts.query expression for matching the documents.
    
    columns - The columns to project for the documents. See PlanBuilder.colSeq(String...)
    
    qualifierName - Specifies a name for qualifying the column names similar to a view name.
    
    Returns:
    
    an AccessPlan object
  - fromSearch
```
PlanBuilder.AccessPlan fromSearch(CtsQueryExpr query,
                                  PlanExprColSeq columns,
                                  XsStringVal qualifierName,
                                  PlanSearchOptions options)
```
    Supports document matching and relevance by constructing rows with the document fragment id and columns for relevance factors. Typically, the plan will join the rows on the document fragment id with the content of documents or with rows, triples, or lexicons indexed on the documents (where the lexicons include range indexes, the document URI lexicon, and the collection lexicon).
    The documents can be ordered by the score or other relevance factors and limited for the most relevant documents.
    
    The list of possible columns to project consists of fragmentId, confidence, fitness, quality, and score. The columns other than the fragmentId provide the same relevance factors as the cts.confidence(), cts.fitness(), cts.quality(), and cts.score() functions on the server. Pass PlanBuilder.as(String, ServerExpression) to rename a column. The default columns are fragmentId and score.
    
    Parameters:
    
    query - The cts.query expression for matching the documents.
    
    columns - The columns to project for the documents. See PlanBuilder.colSeq(String...)
    
    qualifierName - Specifies a name for qualifying the column names similar to a view name.
    
    options - Specifies how to calculate the score for the matching documents. See searchOptions()
    
    Returns:
    
    an AccessPlan object
  - fromLiterals
```
PlanBuilder.AccessPlan fromLiterals(java.util.Map<java.lang.String,java.lang.Object>... rows)
```
    Constructs a literal row set as in the SQL VALUES or SPARQL VALUES statements.
    
    Parameters:
    
    rows - This parameter provides any number of objects in which the key is a column name string identifying the column and the value is a literal with the value of the column.
    
    Returns:
    
    an AccessPlan object
  - fromLiterals
```
PlanBuilder.AccessPlan fromLiterals(java.util.Map<java.lang.String,java.lang.Object>[] rows,
                                    java.lang.String qualifierName)
```
    Constructs a literal row set as in the SQL VALUES or SPARQL VALUES statements. When specifying rows with arrays, values are mapped to column names by position.
    
    Parameters:
    
    rows - This parameter is either an array of object literals or sem:binding objects in which the key is a column name string identifying the column and the value is a literal with the value of the column, or this parameter is an object with a columnNames key having a value of an array of column names and a rowValues key having a value of an array of arrays with literal values.
    
    qualifierName - Specifies a name for qualifying the column names similar to a view name
    
    Returns:
    
    an AccessPlan object
  - fromLiterals
```
PlanBuilder.AccessPlan fromLiterals(java.util.Map<java.lang.String,java.lang.Object>[] rows,
                                    XsStringVal qualifierName)
```
    Constructs a literal row set as in the SQL VALUES or SPARQL VALUES statements. When specifying rows with arrays, values are mapped to column names by position.
    
    Parameters:
    
    rows - This parameter is either an array of object literals or sem:binding objects in which the key is a column name string identifying the column and the value is a literal with the value of the column, or this parameter is an object with a columnNames key having a value of an array of column names and a rowValues key having a value of an array of arrays with literal values.
    
    qualifierName - Specifies a name for qualifying the column names similar to a view name
    
    Returns:
    
    an AccessPlan object
  - fromDocUris
```
PlanBuilder.AccessPlan fromDocUris(CtsQueryExpr querydef)
```
    Construct an AccessPlan based on the URIs returned by the given query.
    
    Parameters:
    
    querydef - a CTS query
    
    Returns:
    
    an AccessPlan object
  - fromDocUris
```
PlanBuilder.AccessPlan fromDocUris(CtsQueryExpr querydef,
                                   java.lang.String qualifierName)
```
    Construct an AccessPlan based on the URIs returned by the given query.
    
    Parameters:
    
    querydef - a CTS query
    
    qualifierName - Optional name for qualifying the column names similar to a view name
    
    Returns:
    
    an AccessPlan object
  - fromDocUris
```
PlanBuilder.AccessPlan fromDocUris(java.lang.String... uris)
```
    Convenience method for constructing an AccessPlan based on a given set of URIs.
    
    Parameters:
    
    uris - one or more URIs to pass into a cts.documentQuery
    
    Returns:
    
    an AccessPlanObject
  - jsonObject
```
ServerExpression jsonObject(PlanJsonProperty... property)
```
    This function constructs a JSON object with the specified properties. The object can be used as the value of a column in a row or passed to a builtin function.
    Provides a client interface to a server function. See op:json-object
    
    Parameters:
    
    property - The properties to be used to contruct the object. This is constructed by the op:prop function.
    
    Returns:
    
    a ObjectNodeExpr expression
  - jsonArray
```
ServerExpression jsonArray(ServerExpression... property)
```
    This function constructs a JSON array during row processing. The array can be used as the value of a column in a row or passed to a builtin expression function. The node is constructed during processing of the plan, rather than when building the plan.
    Provides a client interface to a server function. See op:json-array
    
    Parameters:
    
    property - The JSON nodes for the array.
    
    Returns:
    
    a ArrayNodeExpr expression
  - caseExpr
```
ServerExpression caseExpr(PlanCase... cases)
```
    This function returns the specified value expression if the specified value expression is true. Otherwise, it returns null.
    Provides a client interface to a server function. See op:case
    
    Parameters:
    
    cases - One or more when or else expressions.
    
    Returns:
    
    a ItemSeqExpr expression sequence
  - elseExpr
```
PlanCase elseExpr(ServerExpression value)
```
    This function returns the specified value if none of the preceeding when() conditions are true.
    
    Parameters:
    
    value - The value expression to return
    
    Returns:
    
    a PlanCase object
  - groupConcat
```
PlanAggregateCol groupConcat(java.lang.String name,
                             java.lang.String column)
```
    This function concatenates the non-null values of the column for the rows in the group or row set. The result is used for building the parameters used by the groupBy() function.
    
    Parameters:
    
    name - The name to be used for column with the concatenated values.
    
    column - The name of the column with the values to be concatenated for the group.
    
    Returns:
    
    a PlanAggregateCol object
  - groupConcat
```
PlanAggregateCol groupConcat(PlanColumn name,
                             PlanExprCol column)
```
    This function concatenates the non-null values of the column for the rows in the group or row set. The result is used for building the parameters used by the groupBy() function.
    
    Parameters:
    
    name - The name to be used for column with the concatenated values.
    
    column - The name of the column with the values to be concatenated for the group.
    
    Returns:
    
    a PlanAggregateCol object
  - groupConcat
```
PlanAggregateCol groupConcat(java.lang.String name,
                             java.lang.String column,
                             PlanGroupConcatOptionSeq options)
```
    This function concatenates the non-null values of the column for the rows in the group or row set. The result is used for building the parameters used by the groupBy() function.
    
    Parameters:
    
    name - The name to be used for column with the concatenated values.
    
    column - The name of the column with the values to be concatenated for the group.
    
    options - The options can take a values key with a distinct value to average the distinct values of the column. In addition to the values key, the options can take a separator key specifying a separator character. The value can be a string or placeholder parameter. See groupConcatOptions(String, PlanValueOption)
    
    Returns:
    
    a PlanAggregateCol object
  - groupConcat
```
PlanAggregateCol groupConcat(PlanColumn name,
                             PlanExprCol column,
                             PlanGroupConcatOptionSeq options)
```
    This function concatenates the non-null values of the column for the rows in the group or row set. The result is used for building the parameters used by the groupBy() function.
    
    Parameters:
    
    name - The name to be used for column with the concatenated values.
    
    column - The name of the column with the values to be concatenated for the group.
    
    options - The options can take a values key with a distinct value to average the distinct values of the column. In addition to the values key, the options can take a separator key specifying a separator character. The value can be a string or placeholder parameter. See groupConcatOptions(String, PlanValueOption)
    
    Returns:
    
    a PlanAggregateCol object
  - groupConcatOptions
```
PlanGroupConcatOptionSeq groupConcatOptions(java.lang.String separator)
```
    Specifies options for aggregating the values of a column for the rows belonging to each group by concatenating the values into a single string value.
    
    Parameters:
    
    separator - a string for separating the values
    
    Returns:
    
    a PlanGroupConcatOptionSeq object
  - groupConcatOptions
```
PlanGroupConcatOptionSeq groupConcatOptions(PlanValueOption option)
```
    Specifies options for aggregating the values of a column for the rows belonging to each group by concatenating the values into a single string value.
    
    Parameters:
    
    option - an option controlling whether to concatenate all values including duplicates or concatenate distinct values
    
    Returns:
    
    a PlanGroupConcatOptionSeq object
  - groupConcatOptions
```
PlanGroupConcatOptionSeq groupConcatOptions(java.lang.String separator,
                                            PlanValueOption option)
```
    Specifies options for aggregating the values of a column for the rows belonging to each group by concatenating the values into a single string value.
    
    Parameters:
    
    separator - a string for separating the values
    
    option - an option controlling whether to concatenate all values including duplicates or concatenate distinct values
    
    Returns:
    
    a PlanGroupConcatOptionSeq object
  - group
```
PlanGroup group(java.lang.String... keys)
```
    Specifies the keys for a group when grouping a row set in multiple ways with PlanBuilderBase.ModifyPlanBase.groupByUnion(PlanGroupSeq, PlanAggregateColSeq). Omit the keys to group over all rows.
    
    Parameters:
    
    keys - the columns, if any, in the group
    
    Returns:
    
    a PlanGroup object defining the keys for a group
  - rollup
```
PlanGroupSeq rollup(java.lang.String... keys)
```
    Specifies the keys for a sequence of groups that provide a rollup for a row set. The rollup consists of each group formed by dropping key columns from right to left including the empty group for all rows. The group sequence for the rollup can be passed to PlanBuilderBase.ModifyPlanBase.groupByUnion(PlanGroupSeq, PlanAggregateColSeq) or PlanBuilderBase.ModifyPlanBase.groupToArrays(PlanNamedGroupSeq, PlanAggregateColSeq).
    
    Parameters:
    
    keys - the columns in the rollup
    
    Returns:
    
    a PlanGroupSeq object with the groups for the rollup
  - cube
```
PlanGroupSeq cube(java.lang.String... keys)
```
    Specifies the keys for a sequence of groups that provide a cube for a row set. The cube consists of each group with a unique set of key columns including the empty group for all rows. The group sequence for the cube can be passed to PlanBuilderBase.ModifyPlanBase.groupByUnion(PlanGroupSeq, PlanAggregateColSeq) or PlanBuilderBase.ModifyPlanBase.groupToArrays(PlanNamedGroupSeq, PlanAggregateColSeq).
    
    Parameters:
    
    keys - the columns in the cube
    
    Returns:
    
    a PlanGroupSeq object with the groups for the cube
  - groupSeq
```
PlanGroupSeq groupSeq(PlanGroup... group)
```
    Provides the sequence of groups when grouping a row set in multiple ways with PlanBuilderBase.ModifyPlanBase.groupByUnion(PlanGroupSeq, PlanAggregateColSeq). Each group must provide a unique set of key columns, but a key column can appear in multiple groups
    
    Parameters:
    
    group - the groups to apply to the row set
    
    Returns:
    
    a PlanGroupSeq object with the groups of key columns
  - namedGroup
```
PlanNamedGroup namedGroup(java.lang.String name)
```
    Specifies the name for a named group over all rows when grouping a row set in multiple ways with PlanBuilderBase.ModifyPlanBase.groupToArrays(PlanNamedGroupSeq, PlanAggregateColSeq).
    
    Parameters:
    
    name - the name of the array for the group
    
    Returns:
    
    a PlanNamedGroup object defining the name for a named group over all rows
  - namedGroup
```
PlanNamedGroup namedGroup(java.lang.String name,
                          PlanExprColSeq keys)
```
    Specifies the name and keys for a named group when grouping a row set in multiple ways with PlanBuilderBase.ModifyPlanBase.groupToArrays(PlanNamedGroupSeq, PlanAggregateColSeq).
    
    Parameters:
    
    name - the name of the array for the group
    
    keys - the columns, if any, in the group. See PlanBuilder.colSeq(String...)
    
    Returns:
    
    a PlanNamedGroup object defining the name and keys for a named group
  - namedGroupSeq
```
PlanNamedGroupSeq namedGroupSeq(PlanNamedGroup... namedGroup)
```
    Provides the sequence of named groups when grouping a row set in multiple ways with PlanBuilderBase.ModifyPlanBase.groupToArrays(PlanNamedGroupSeq, PlanAggregateColSeq). Each group must provide a unique set of key columns, but a key column can appear in multiple groups. Names are assigned to groups without a name; if supplied, the group name must be unique.
    
    Parameters:
    
    namedGroup - the named groups to apply to the row set
    
    Returns:
    
    a PlanNamedGroupSeq object with the named groups of key columns
  - searchOptions
```
PlanSearchOptions searchOptions()
```
    Provides a search options object to configure the execution of the fromSearch(CtsQueryExpr, PlanExprColSeq, XsStringVal, PlanSearchOptions) accessor. Use the fluent methods of the search options object to set the configuration.
    
    Returns:
    
    the configuration object
  - sampleByOptions
```
PlanSampleByOptions sampleByOptions()
```
    Provides a sample-by option object to configure the execution of the PlanBuilder.sample(PlanColumn, PlanExprCol) modifier for sampling a view, triples, or lexicon index. Use the fluent methods of the sample-by option object to set the configuration.
    
    Returns:
    
    the configuration object
  - sparqlOptions
```
PlanSparqlOptions sparqlOptions()
```
    Provides a SPARQL option object to configure the execution of the PlanBuilder.fromSparql(XsStringVal, XsStringVal, PlanSparqlOptions) accessor. Use the fluent methods of the sample-by option object to set the configuration.
    
    Returns:
    
    the configuration object
  - resolveFunction
```
PlanFunction resolveFunction(XsQNameVal functionName,
                             java.lang.String modulePath)
```
    Specifies a JavaScript or XQuery function installed on the server for use in post-processing in a map() or reduce() operation.
    
    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
  - seq
```
ServerExpression seq(ServerExpression... expression)
```
    Collects a sequence of server expressions as a new server expression for evaluation on the server. The collected server expressions can include values, the results produced by executing callson the server, and other sequences of server expressions. The individual items in another sequence of server expressions become items in the new sequence. The XsValue class provides methods for constructing sequences of literals values such as XsValue.dateSeq(String...). These sequences can be passed to any parameter with a ServerExpression type as well as to the seq() function.
    
    Parameters:
    
    expression - one or more server expressions
    
    Returns:
    
    a server expression representing a sequence of server expressions
    
    See Also:
    
    XsValue.doubleSeq(double...), XsValue.intSeq(int...), XsValue.stringSeq(String...)
  - colType
```
PlanRowColTypes colType(java.lang.String column)
```
    Build a new column identifier; the type will default to "none" and nullable will default to "false".
    
    Parameters:
    
    column - name of the column
    
    Returns:
    
    a new column identifier
  - colType
```
PlanRowColTypes colType(java.lang.String column,
                        java.lang.String type)
```
    Build a new column identifier; nullable will default to "false".
    
    Parameters:
    
    column - name of the column
    
    type - type of the column, e.g. "string"
    
    Returns:
    
    a new column identifier
  - colType
```
PlanRowColTypes colType(java.lang.String column,
                        java.lang.String type,
                        java.lang.Boolean nullable)
```
    Build a new column identifier.
    
    Parameters:
    
    column - name of the column
    
    type - type of the column, e.g. "string"
    
    nullable - whether a column value is required
    
    Returns:
    
    a new column identifier
  - colTypes
```
PlanRowColTypesSeq colTypes(PlanRowColTypes... colTypes)
```
    Build a sequence of column identifiers that can be used with fromParam.
    
    Parameters:
    
    colTypes - the column identifiers to associate with the plan
    
    Returns:
    
    a sequence of column identifiers
  - docCols
```
PlanDocColsIdentifier docCols(java.util.Map<java.lang.String,PlanColumn> descriptorColumnMapping)
```
    Construct a mapping of document descriptor column names to columns in the plan. The available set of document descriptor names are: uri, doc, collections, permissions, metadata, quality, and temporalCollection. Use this when mapping to non-standard column names.
    
    Parameters:
    
    descriptorColumnMapping - contains the mapping for column names to String values.
    
    Returns:
    
    a new PlanDocColsIdentifier
  - docDescriptor
```
PlanDocDescriptor docDescriptor(DocumentWriteOperation writeOp)
```
    Build a single doc descriptor that can be used with fromDocDescriptors.
    
    Parameters:
    
    writeOp - contains the inputs for the doc descriptor
    
    Returns:
    
    a doc descriptor
  - docDescriptors
```
PlanDocDescriptorSeq docDescriptors(DocumentWriteSet writeSet)
```
    Build a sequence of doc descriptors that can be used with fromDocDescriptors.
    
    Parameters:
    
    writeSet - each DocumentWriteOperation in this will be converted into a doc descriptor
    
    Returns:
    
    a sequence of doc descriptors
  - transformDef
```
TransformDef transformDef(java.lang.String path)
```
    Build a transform definition for use with transformDoc.
    
    Parameters:
    
    path - the path (URI) of either a *.mjs or *.xslt module in a modules database
    
    Returns:
    
    a new TransformDef
  - schemaDefinition
```
SchemaDefExpr schemaDefinition(java.lang.String kind)
```
    Build a schema definition for use with validateDoc.
    
    Parameters:
    
    kind - the kind of schema - jsonSchema, xmlSchema or schematron.
    
    Returns:
    
    a new SchemaDefExpr
  - permission
```
ServerExpression permission(java.lang.String roleName,
                            java.lang.String capability)
```
    Convenience method for constructing a permission that can then be used e.g. with jsonArray when binding an array of permissions to a column.
    
    Parameters:
    
    roleName - name of the role for the permission
    
    capability - lower-cased capability; e.g. "read", "update", "execute"
    
    Returns:
    
    a new ServerExpression

Interface PlanBuilderBase

Nested Class Summary

Method Summary

Method Detail

fromSearchDocs

fromSearchDocs

fromSearchDocs

fromSearch

fromSearch

fromSearch

fromSearch

fromLiterals

fromLiterals

fromLiterals

fromDocUris

fromDocUris

fromDocUris

jsonObject

jsonArray

caseExpr

elseExpr

groupConcat

groupConcat

groupConcat

groupConcat

groupConcatOptions

groupConcatOptions

groupConcatOptions

group

rollup

cube

groupSeq

namedGroup

namedGroup

namedGroupSeq

searchOptions

sampleByOptions

sparqlOptions

resolveFunction

seq

colType

colType

colType

colTypes

docCols

docDescriptor

docDescriptors

transformDef

schemaDefinition

permission