Interface RawPlanDefinition

All Superinterfaces:

PlanBuilder.Plan, PlanBuilderBase.PlanBase, RawPlan

• Method Summary

  All MethodsInstance MethodsAbstract Methods

  Modifier and Type

  Method

  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 Details

  • 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

Copyright (c) 2010-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.