com.marklogic.client.expression

Interface PlanBuilderBase.ExportablePlanBase

All Known Subinterfaces:

PlanBuilder.AccessPlan, PlanBuilder.ExportablePlan, PlanBuilder.ModifyPlan, PlanBuilder.PreparePlan

Enclosing interface:

PlanBuilderBase

public static interface PlanBuilderBase.ExportablePlanBase

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

Method Summary

Modifier and Type	Method and Description
<T extends JSONReadHandle> T	export(T handle) This method exports the plan to an AST (Abstract Sytax Tree) using the specified JSON handle.
<T> T	exportAs(java.lang.Class<T> as) This method exports the plan to an AST (Abstract Sytax Tree) using the specified JSON handle.

Method Detail

export

<T extends JSONReadHandle> T export(T handle)

This method exports the plan to an AST (Abstract Sytax Tree) using the specified JSON handle.

Type Parameters:

T - the type of the handle for reading the AST as JSON

Parameters:

handle - a handle for reading the AST as JSON

Returns:

the JSON handle populated with the AST

exportAs

<T> T exportAs(java.lang.Class<T> as)

This method exports the plan to an AST (Abstract Sytax Tree) using the specified JSON handle.

The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered.

Learn more about shortcut methods

Type Parameters:

T - the type of the IO object for the AST

Parameters:

as - the IO class for reading the AST by means of JSON

Returns:

an object of the IO class populated with the AST