Package com.marklogic.client.expression

Interface PlanBuilderBase.PlanBase

All Known Subinterfaces:

PlanBuilder.AccessPlan, PlanBuilder.ExportablePlan, PlanBuilder.ModifyPlan, PlanBuilder.Plan, PlanBuilder.PreparePlan, RawPlan, RawPlanDefinition, RawQueryDSLPlan, RawSPARQLSelectPlan, RawSQLPlan

Enclosing interface:

PlanBuilderBase

public static interface PlanBuilderBase.PlanBase

Defines base methods for Plan. This interface is an implementation detail. Use Plan as the type for instances of Plan.

Method Summary

Modifier and Type	Method	Description
PlanBuilder.Plan	bindParam(PlanParamExpr param, boolean literal)	Specifies a boolean primitive value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.
PlanBuilder.Plan	bindParam(PlanParamExpr param, byte literal)	Specifies a byte primitive value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.
PlanBuilder.Plan	bindParam(PlanParamExpr param, double literal)	Specifies a double primitive value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.
PlanBuilder.Plan	bindParam(PlanParamExpr param, float literal)	Specifies a float primitive value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.
PlanBuilder.Plan	bindParam(PlanParamExpr param, int literal)	Specifies an int primitive value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.
PlanBuilder.Plan	bindParam(PlanParamExpr param, long literal)	Specifies a long primitive value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.
PlanBuilder.Plan	bindParam(PlanParamExpr param, short literal)	Specifies a short primitive value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.
PlanBuilder.Plan	bindParam(PlanParamExpr param, DocumentWriteSet writeSet)	Specifies a set of documents to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.
PlanBuilder.Plan	bindParam(PlanParamExpr param, AbstractWriteHandle content, java.util.Map<java.lang.String,java.util.Map<java.lang.String,AbstractWriteHandle>> columnAttachments)	Specifies a content handle to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.
PlanBuilder.Plan	bindParam(PlanParamExpr param, java.lang.String literal)	Specifies a string literal value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.
PlanBuilder.Plan	bindParam(java.lang.String paramName, boolean literal)	Specifies a boolean primitive value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.
PlanBuilder.Plan	bindParam(java.lang.String paramName, byte literal)	Specifies a byte primitive value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.
PlanBuilder.Plan	bindParam(java.lang.String paramName, double literal)	Specifies a double primitive value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.
PlanBuilder.Plan	bindParam(java.lang.String paramName, float literal)	Specifies a float primitive value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.
PlanBuilder.Plan	bindParam(java.lang.String paramName, int literal)	Specifies an int primitive value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.
PlanBuilder.Plan	bindParam(java.lang.String paramName, long literal)	Specifies a long primitive value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.
PlanBuilder.Plan	bindParam(java.lang.String paramName, short literal)	Specifies a short primitive value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.
PlanBuilder.Plan	bindParam(java.lang.String param, DocumentWriteSet writeSet)	Specifies a set of documents to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.
PlanBuilder.Plan	bindParam(java.lang.String param, AbstractWriteHandle content)	Specifies a content handle to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.
PlanBuilder.Plan	bindParam(java.lang.String param, AbstractWriteHandle content, java.util.Map<java.lang.String,java.util.Map<java.lang.String,AbstractWriteHandle>> columnAttachments)	Specifies a content handle to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.
PlanBuilder.Plan	bindParam(java.lang.String paramName, java.lang.String literal)	Specifies a string literal value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.

Method Detail

bindParam

PlanBuilder.Plan bindParam(java.lang.String paramName,
                           boolean literal)

Specifies a boolean primitive value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.

As when building a plan, binding a parameter constructs a new instance of the plan with the binding instead of mutating the existing instance of the plan.

Parameters:

paramName - the name of a placeholder parameter

literal - a boolean primitive value to replace the parameter

Returns:

a new instance of the Plan object with the parameter binding

bindParam

PlanBuilder.Plan bindParam(PlanParamExpr param,
                           boolean literal)

Specifies a boolean primitive value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.

As when building a plan, binding a parameter constructs a new instance of the plan with the binding instead of mutating the existing instance of the plan.

Parameters:

param - a placeholder parameter as constructed by the param() method

literal - a boolean primitive value to replace the parameter

Returns:

a new instance of the Plan object with the parameter binding

bindParam

PlanBuilder.Plan bindParam(java.lang.String paramName,
                           byte literal)

Specifies a byte primitive value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.

As when building a plan, binding a parameter constructs a new instance of the plan with the binding instead of mutating the existing instance of the plan.

Parameters:

paramName - the name of a placeholder parameter

literal - a byte primitive value to replace the parameter

Returns:

a new instance of the Plan object with the parameter binding

bindParam

PlanBuilder.Plan bindParam(PlanParamExpr param,
                           byte literal)

Specifies a byte primitive value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.

As when building a plan, binding a parameter constructs a new instance of the plan with the binding instead of mutating the existing instance of the plan.

Parameters:

param - a placeholder parameter as constructed by the param() method

literal - a byte primitive value to replace the parameter

Returns:

a new instance of the Plan object with the parameter binding

bindParam

PlanBuilder.Plan bindParam(java.lang.String paramName,
                           double literal)

Specifies a double primitive value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.

As when building a plan, binding a parameter constructs a new instance of the plan with the binding instead of mutating the existing instance of the plan.

Parameters:

paramName - the name of a placeholder parameter

literal - a double primitive value to replace the parameter

Returns:

a new instance of the Plan object with the parameter binding

bindParam

PlanBuilder.Plan bindParam(PlanParamExpr param,
                           double literal)

Specifies a double primitive value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.

As when building a plan, binding a parameter constructs a new instance of the plan with the binding instead of mutating the existing instance of the plan.

Parameters:

param - a placeholder parameter as constructed by the param() method

literal - a double primitive value to replace the parameter

Returns:

a new instance of the Plan object with the parameter binding

bindParam

PlanBuilder.Plan bindParam(java.lang.String paramName,
                           float literal)

Specifies a float primitive value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.

As when building a plan, binding a parameter constructs a new instance of the plan with the binding instead of mutating the existing instance of the plan.

Parameters:

paramName - the name of a placeholder parameter

literal - a float primitive value to replace the parameter

Returns:

a new instance of the Plan object with the parameter binding

bindParam

PlanBuilder.Plan bindParam(PlanParamExpr param,
                           float literal)

Specifies a float primitive value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.

As when building a plan, binding a parameter constructs a new instance of the plan with the binding instead of mutating the existing instance of the plan.

Parameters:

param - a placeholder parameter as constructed by the param() method

literal - a float primitive value to replace the parameter

Returns:

a new instance of the Plan object with the parameter binding

bindParam

PlanBuilder.Plan bindParam(java.lang.String paramName,
                           int literal)

Specifies an int primitive value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.

As when building a plan, binding a parameter constructs a new instance of the plan with the binding instead of mutating the existing instance of the plan.

Parameters:

paramName - the name of a placeholder parameter

literal - an int primitive value to replace the parameter

Returns:

a new instance of the Plan object with the parameter binding

bindParam

PlanBuilder.Plan bindParam(PlanParamExpr param,
                           int literal)

Specifies an int primitive value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.

As when building a plan, binding a parameter constructs a new instance of the plan with the binding instead of mutating the existing instance of the plan.

Parameters:

param - a placeholder parameter as constructed by the param() method

literal - an int primitive value to replace the parameter

Returns:

a new instance of the Plan object with the parameter binding

bindParam

PlanBuilder.Plan bindParam(java.lang.String paramName,
                           long literal)

Specifies a long primitive value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.

As when building a plan, binding a parameter constructs a new instance of the plan with the binding instead of mutating the existing instance of the plan.

Parameters:

paramName - the name of a placeholder parameter

literal - a long primitive value to replace the parameter

Returns:

a new instance of the Plan object with the parameter binding

bindParam

PlanBuilder.Plan bindParam(PlanParamExpr param,
                           long literal)

Specifies a long primitive value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.

As when building a plan, binding a parameter constructs a new instance of the plan with the binding instead of mutating the existing instance of the plan.

Parameters:

param - a placeholder parameter as constructed by the param() method

literal - a long primitive value to replace the parameter

Returns:

a new instance of the Plan object with the parameter binding

bindParam

PlanBuilder.Plan bindParam(java.lang.String paramName,
                           short literal)

Specifies a short primitive value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.

As when building a plan, binding a parameter constructs a new instance of the plan with the binding instead of mutating the existing instance of the plan.

Parameters:

paramName - the name of a placeholder parameter

literal - a short primitive value to replace the parameter

Returns:

a new instance of the Plan object with the parameter binding

bindParam

PlanBuilder.Plan bindParam(PlanParamExpr param,
                           short literal)

Specifies a short primitive value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.

As when building a plan, binding a parameter constructs a new instance of the plan with the binding instead of mutating the existing instance of the plan.

Parameters:

param - a placeholder parameter as constructed by the param() method

literal - a short primitive value to replace the parameter

Returns:

a new instance of the Plan object with the parameter binding

bindParam

PlanBuilder.Plan bindParam(java.lang.String paramName,
                           java.lang.String literal)

Specifies a string literal value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.

As when building a plan, binding a parameter constructs a new instance of the plan with the binding instead of mutating the existing instance of the plan.

Parameters:

paramName - the name of a placeholder parameter

literal - a string literal value to replace the parameter

Returns:

a new instance of the Plan object with the parameter binding

bindParam

PlanBuilder.Plan bindParam(PlanParamExpr param,
                           java.lang.String literal)

Specifies a string literal value to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.

As when building a plan, binding a parameter constructs a new instance of the plan with the binding instead of mutating the existing instance of the plan.

Parameters:

param - a placeholder parameter as constructed by the param() method

literal - a string literal value to replace the parameter

Returns:

a new instance of the Plan object with the parameter binding

bindParam

PlanBuilder.Plan bindParam(java.lang.String param,
                           DocumentWriteSet writeSet)

Specifies a set of documents to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.

As when building a plan, binding a parameter constructs a new instance of the plan with the binding instead of mutating the existing instance of the plan.

Parameters:

param - the name of a placeholder parameter

writeSet - the set of documents to bind; the URI, content, and metadata in each document will be honored except for the properties fragment config in the metadata

Returns:

a new instance of the Plan object with the parameter binding

bindParam

PlanBuilder.Plan bindParam(PlanParamExpr param,
                           DocumentWriteSet writeSet)

Specifies a set of documents to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.

As when building a plan, binding a parameter constructs a new instance of the plan with the binding instead of mutating the existing instance of the plan.

Parameters:

param - a placeholder parameter as constructed by the param() method

writeSet - the set of documents to bind; the URI, content, and metadata in each document will be honored except for the properties fragment config in the metadata

Returns:

a new instance of the Plan object with the parameter binding

bindParam

PlanBuilder.Plan bindParam(java.lang.String param,
                           AbstractWriteHandle content)

Specifies a content handle to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.

As when building a plan, binding a parameter constructs a new instance of the plan with the binding instead of mutating the existing instance of the plan.

Parameters:

param - the name of a placeholder parameter

content - the content to replace the parameter

Returns:

a new instance of the Plan object with the parameter binding

bindParam

PlanBuilder.Plan bindParam(java.lang.String param,
                           AbstractWriteHandle content,
                           java.util.Map<java.lang.String,java.util.Map<java.lang.String,AbstractWriteHandle>> columnAttachments)

Specifies a content handle to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.

As when building a plan, binding a parameter constructs a new instance of the plan with the binding instead of mutating the existing instance of the plan.

Parameters:

param - the name of a placeholder parameter

content - the content to replace the parameter

columnAttachments - optional (can be null) map that associates column names with maps of attachments, which map filenames to content handles. For each column name in the map, the expectation is that the associated column in the content object will contain values matching the filenames in the map of filenames to content handles. When the plan is executed, those filenames will then be replaced with the associated attachment content objects.

Returns:

a new instance of the Plan object with the parameter binding

bindParam

PlanBuilder.Plan bindParam(PlanParamExpr param,
                           AbstractWriteHandle content,
                           java.util.Map<java.lang.String,java.util.Map<java.lang.String,AbstractWriteHandle>> columnAttachments)

Specifies a content handle to replace a placeholder parameter during this execution of the plan in all expressions in which the parameter appears.

As when building a plan, binding a parameter constructs a new instance of the plan with the binding instead of mutating the existing instance of the plan.

Parameters:

param - a placeholder parameter as constructed by the param() method

content - the content to replace the parameter

columnAttachments - optional (can be null) map that associates column names with maps of attachments, which map filenames to content handles. For each column name in the map, the expectation is that the associated column in the content object will contain values matching the filenames in the map of filenames to content handles. When the plan is executed, those filenames will then be replaced with the associated attachment content objects.

Returns:

a new instance of the Plan object with the parameter binding