com.redhat.lightblue.assoc.ep

Class ExecutionPlan

java.lang.Object

com.redhat.lightblue.assoc.ep.ExecutionPlan

public class ExecutionPlan
extends Object

Execution plan is a tree of execution blocks. Every node in the query plan is converted to an execution block, and connected in the same way query plan nodes are connected. Each execution block contains a pipeline, and every step of the pipeline performs a step of the operation. The search plan and retrieval plan are constructed differently. In the retrieval plan, the root entity is at the root, and every destination node is a child node. So, the assembler first runs the parent node, gets the docs, and then runs the child nodes and attaches the documents to the slots. Query plan is optional, and it has a different layout than the retrieval plan. All that we do with the query plan is to retrieve the root node documents, so query plan does not retrieve all associated entities.

Constructor Summary

Constructors

Constructor and Description
ExecutionPlan(QueryExpression requestQuery, Projection requestProjection, Sort requestSort, Long from, Long to, CompositeMetadata rootMd, QueryPlan searchQueryPlan, QueryPlan retrievalQueryPlan) Creates an execution plan

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	explain(ExecutionContext ctx)
static Set<Path>	getIncludedFieldsOfEntityForProjection(ExecutionBlock block, CompositeMetadata root, Projection requestProjection) Returns the fields included based on the requested projection and reference field projection
static Set<Path>	getIncludedFieldsOfEntityForSearch(ExecutionBlock block, List<QueryFieldInfo> fieldInfo) Returns the included fields of an entity based on query information.
static Set<Path>	getIncludedFieldsOfEntityForSort(ExecutionBlock block)
static Set<Path>	getIncludedFieldsOfRootEntityForSort(CompositeMetadata root, Sort rootSort)
StepResult<ResultDocument>	getResults(ExecutionContext ctx)
com.fasterxml.jackson.databind.JsonNode	toJson()
String	toString()
static Projection	writeProjection(Collection<Path> fields) Writes a projection to include the given set of fields

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutionPlan

public ExecutionPlan(QueryExpression requestQuery,
                     Projection requestProjection,
                     Sort requestSort,
                     Long from,
                     Long to,
                     CompositeMetadata rootMd,
                     QueryPlan searchQueryPlan,
                     QueryPlan retrievalQueryPlan)

Creates an execution plan

Parameters:

requestQuery - query requested by the client

requestProjection - projection requested by the client

requestSort - sort requested by the client.

from - request.from

to - request.to

rootMd - Root entity composite metadata

searchQueryPlan - if the results of a search is to be retrieved in a second pass, not null. Otherwise, null.

retrievalQueryPlan - Never null. Contains the plan for the retrieval of found documents. If the searchQueryPlan is not null, retrieves the documents found by that search. If searchQueryPlan is null, this plan performs the search and retrieval.

Method Detail

getResults

public StepResult<ResultDocument> getResults(ExecutionContext ctx)

writeProjection

public static Projection writeProjection(Collection<Path> fields)

Writes a projection to include the given set of fields

getIncludedFieldsOfEntityForSearch

public static Set<Path> getIncludedFieldsOfEntityForSearch(ExecutionBlock block,
                                                           List<QueryFieldInfo> fieldInfo)

Returns the included fields of an entity based on query information. This is to be used for search plan nodes only

getIncludedFieldsOfEntityForProjection

public static Set<Path> getIncludedFieldsOfEntityForProjection(ExecutionBlock block,
                                                               CompositeMetadata root,
                                                               Projection requestProjection)

Returns the fields included based on the requested projection and reference field projection

getIncludedFieldsOfRootEntityForSort

public static Set<Path> getIncludedFieldsOfRootEntityForSort(CompositeMetadata root,
                                                             Sort rootSort)

getIncludedFieldsOfEntityForSort

public static Set<Path> getIncludedFieldsOfEntityForSort(ExecutionBlock block)

toJson

public com.fasterxml.jackson.databind.JsonNode toJson()

toString

public String toString()

Overrides:

toString in class Object

explain

public com.fasterxml.jackson.databind.JsonNode explain(ExecutionContext ctx)