Package org.apache.jackrabbit.oak.query

Class ExecutionContext

java.lang.Object

org.apache.jackrabbit.oak.query.ExecutionContext

public class ExecutionContext
extends Object

An instance of this class provides the context for the execution of a query, which in essence captures a stable state of the content tree from the time the execution context was created.

Constructor Summary

Constructors

Constructor	Description
ExecutionContext(NodeState baseState, Root root, QueryEngineSettings settings, QueryIndexProvider indexProvider, PermissionProvider permissionProvider, PrefetchNodeStore store)

Method Summary

Modifier and Type	Method	Description
@NotNull NodeState	getBaseState()	Used to evaluate the query (ie.
@NotNull QueryIndexProvider	getIndexProvider()
NodeTypeInfoProvider	getNodeTypeInfoProvider()	Get the nodetype info provider.
@Nullable PermissionProvider	getPermissionProvider()
PrefetchNodeStore	getPrefetchNodeStore()
@NotNull Root	getRoot()	Used to create the actual query results from the indexed paths, needs to be a secured version of a tree to take into account ACLs
QueryEngineSettings	getSettings()

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutionContext

public ExecutionContext(NodeState baseState,
                        Root root,
                        QueryEngineSettings settings,
                        QueryIndexProvider indexProvider,
                        PermissionProvider permissionProvider,
                        PrefetchNodeStore store)

Method Detail

getPrefetchNodeStore

public PrefetchNodeStore getPrefetchNodeStore()

getBaseState

@NotNull
public @NotNull NodeState getBaseState()

Used to evaluate the query (ie. read the existing node types, index definitions), doesn't need to be a secured version of a node state

Returns:

base state of the content tree against which the query runs.

getNodeTypeInfoProvider

public NodeTypeInfoProvider getNodeTypeInfoProvider()

Get the nodetype info provider.

Returns:

the provider

getRoot

@NotNull
public @NotNull Root getRoot()

Used to create the actual query results from the indexed paths, needs to be a secured version of a tree to take into account ACLs

Returns:

root of the content tree against which the query runs.

getIndexProvider

@NotNull
public @NotNull QueryIndexProvider getIndexProvider()

Returns:

Index provider for indexes matching the state of the content tree as returned from getBaseState().

getSettings

public QueryEngineSettings getSettings()

getPermissionProvider

@Nullable
public @Nullable PermissionProvider getPermissionProvider()