Package com.apple.foundationdb.record.query.plan

Class QueryPlanResult

java.lang.Object

com.apple.foundationdb.record.query.plan.QueryPlanResult

All Implemented Interfaces:

PlanHashable

public class QueryPlanResult
extends Object
implements PlanHashable

The result of planning a query. This is the result of the call of QueryPlanner.plan(RecordQuery) call. It contains the actual plan produced coupled with some additional information related to the plan and the planning process.

Nested Class Summary

Nested classes/interfaces inherited from interface com.apple.foundationdb.record.PlanHashable

PlanHashable.PlanHashKind

Constructor Summary

Constructors

Constructor	Description
QueryPlanResult(RecordQueryPlan plan)

Method Summary

Modifier and Type	Method	Description
RecordQueryPlan	getPlan()
QueryPlanInfo	getPlanInfo()
int	planHash()
int	planHash(PlanHashable.PlanHashKind hashKind)	To make transition from RecordQueryPlan to QueryPlanResult smoother, this implements PlanHashable.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

QueryPlanResult

public QueryPlanResult(@Nonnull
                       RecordQueryPlan plan)

Method Detail

getPlan

@Nonnull
public RecordQueryPlan getPlan()

getPlanInfo

@Nonnull
public QueryPlanInfo getPlanInfo()

planHash

public int planHash(@Nonnull
                    PlanHashable.PlanHashKind hashKind)

To make transition from RecordQueryPlan to QueryPlanResult smoother, this implements PlanHashable.

Specified by:

planHash in interface PlanHashable

Parameters:

hashKind - the "kind" of hash to calculate. Each kind of hash has a particular logic with regards to included and excluded items.

Returns:

plan hash for the underlying plan.

planHash

public int planHash()

Specified by:

planHash in interface PlanHashable

toString

public String toString()

Overrides:

toString in class Object