com.marklogic.client.expression

Interface PlanBuilder.PreparePlan

All Superinterfaces:

PlanBuilder.ExportablePlan, PlanBuilder.Plan, PlanBuilderBase.ExportablePlanBase, PlanBuilderBase.PlanBase, PlanBuilderBase.PreparePlanBase

All Known Subinterfaces:

PlanBuilder.AccessPlan, PlanBuilder.ModifyPlan

Enclosing class:

PlanBuilder

public static interface PlanBuilder.PreparePlan
extends PlanBuilder.ExportablePlan, PlanBuilderBase.PreparePlanBase

Provides functions and operations in the prepare phase of the plan for executing a row pipeline on the server.

Method Summary

Modifier and Type	Method and Description
PlanBuilder.ExportablePlan	map(PlanFunction func) This method applies the specified function to each row returned by the plan to produce a different result row.
PlanBuilder.ExportablePlan	reduce(PlanFunction func) This method applies a function or the builtin reducer to each row returned by the plan to produce a single result as with the reduce() method of JavaScript Array.
PlanBuilder.ExportablePlan	reduce(PlanFunction func, java.lang.String seed) This method applies a function or the builtin reducer to each row returned by the plan to produce a single result as with the reduce() method of JavaScript Array.
PlanBuilder.ExportablePlan	reduce(PlanFunction func, XsAnyAtomicTypeVal seed) This method applies a function or the builtin reducer to each row returned by the plan to produce a single result as with the reduce() method of JavaScript Array.

Methods inherited from interface com.marklogic.client.expression.PlanBuilder.Plan

bindParam

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

bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam

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

export, exportAs

Method Detail

map

PlanBuilder.ExportablePlan map(PlanFunction func)

This method applies the specified function to each row returned by the plan to produce a different result row.

Parameters:

func - The function to be applied.

Returns:

a ExportablePlan object

reduce

PlanBuilder.ExportablePlan reduce(PlanFunction func)

This method applies a function or the builtin reducer to each row returned by the plan to produce a single result as with the reduce() method of JavaScript Array.

Parameters:

func - The function to be applied.

Returns:

a ExportablePlan object

reduce

PlanBuilder.ExportablePlan reduce(PlanFunction func,
                                  java.lang.String seed)

This method applies a function or the builtin reducer to each row returned by the plan to produce a single result as with the reduce() method of JavaScript Array.

Parameters:

func - The function to be applied.

seed - The value returned by the previous request.

Returns:

a ExportablePlan object

reduce

PlanBuilder.ExportablePlan reduce(PlanFunction func,
                                  XsAnyAtomicTypeVal seed)

This method applies a function or the builtin reducer to each row returned by the plan to produce a single result as with the reduce() method of JavaScript Array.

Parameters:

func - The function to be applied.

seed - The value returned by the previous request.

Returns:

a ExportablePlan object