com.marklogic.client.row

Interface RawPlanDefinition

All Superinterfaces:

PlanBuilder.Plan, PlanBuilderBase.PlanBase, RawPlan

public interface RawPlanDefinition
extends RawPlan

A Raw Plan Definition provides access to a plan in a JSON serialization of the exported AST (Abstract Syntax Tree) for the plan.

Method Summary

Modifier and Type	Method and Description
JSONWriteHandle	getHandle() Returns the handle for the JSON representation of the AST for the plan.
void	setHandle(JSONWriteHandle handle) Specifies the handle for the JSON representation of the AST for the plan.
RawPlanDefinition	withHandle(JSONWriteHandle handle) Assigns the handle and returns the raw plan as a convenience.

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

Method Detail

getHandle

JSONWriteHandle getHandle()

Returns the handle for the JSON representation of the AST for the plan.

Returns:

the JSON handle

setHandle

void setHandle(JSONWriteHandle handle)

Specifies the handle for the JSON representation of the AST for the plan.

Parameters:

handle - the JSON handle

withHandle

RawPlanDefinition withHandle(JSONWriteHandle handle)

Assigns the handle and returns the raw plan as a convenience.

Parameters:

handle - the JSON handle

Returns:

this raw plan object