## Uses of Class
org.modeshape.jcr.query.plan.PlanHints

- Packages that use PlanHints
  Package | Description
  --- | ---
  org.modeshape.jcr.query | The Query API provides a mechanism for building and executing queries.
  org.modeshape.jcr.query.engine | This package contains several fully-functional query engine implementations.
  org.modeshape.jcr.query.model | The Abstract Query Model is a vocabulary that can be used to construct a language-neutral representation of a query.
  org.modeshape.jcr.query.optimize | This package contains the Optimizer interface, a rule-based optimizer implementation, and library of optimization rules.
  org.modeshape.jcr.query.plan | This package defines the `Planner` interface, the `CanonicalPlanner` implementation, and the `PlanNode` class that is used to represent a canonical query plan.

- - ### Uses of PlanHints in org.modeshape.jcr.query

    Fields in org.modeshape.jcr.query declared as PlanHints
    Modifier and Type | Field and Description
    --- | ---
    `protected PlanHints` | QueryContext.`hints`

    Methods in org.modeshape.jcr.query that return PlanHints
    Modifier and Type | Method and Description
    --- | ---
    `PlanHints` | QueryContext.`getHints()` Get the plan hints.

    Methods in org.modeshape.jcr.query with parameters of type PlanHints
    Modifier and Type | Method and Description
    --- | ---
    `CancellableQuery` | JcrQueryContext.`createExecutableQuery(QueryCommand query, PlanHints hints, Map<String,Object> variables)` Create a query object that can be `executed` and optionally `cancelled`.
    `QueryContext` | QueryEngine.`createQueryContext(ExecutionContext context, RepositoryCache repositoryCache, Set<String> workspaceNames, Map<String,NodeCache> overriddenNodeCachesByWorkspaceName, Schemata schemata, RepositoryIndexes indexDefns, NodeTypes nodeTypes, BufferManager bufferManager, PlanHints hints, Map<String,Object> variables)` Create a new context for query execution.
    `QueryContext` | QueryContext.`with(PlanHints hints)` Obtain a copy of this context, except that the copy uses the supplied hints.

    Constructors in org.modeshape.jcr.query with parameters of type PlanHints
    Constructor and Description
    `JcrQuery(JcrQueryContext context, String statement, String language, QueryCommand query, PlanHints hints, Path storedAtPath)` Creates a new JCR `Query` by specifying the query statement itself, the language in which the query is stated, the `QueryCommand` representation and, optionally, the node from which the query was loaded.
    `QueryContext(ExecutionContext context, RepositoryCache repositoryCache, Set<String> workspaceNames, Map<String,NodeCache> overriddenNodeCachesByWorkspaceName, Schemata schemata, RepositoryIndexes indexDefns, NodeTypes nodeTypes, BufferManager bufferManager, PlanHints hints, Problems problems, Map<String,Object> variables)` Create a new context for query execution.
    `QueryContext(ExecutionContext context, RepositoryCache repositoryCache, Set<String> workspaceNames, Map<String,NodeCache> overriddenNodeCachesByWorkspaceName, Schemata schemata, RepositoryIndexes indexDefns, NodeTypes nodeTypes, BufferManager bufferManager, PlanHints hints, Problems problems, Map<String,Object> variables, long id)` Create a new context for query execution.
    `QueryContext(ExecutionContext context, RepositoryCache repositoryCache, Set<String> workspaceNames, Schemata schemata, RepositoryIndexes indexDefns, NodeTypes nodeTypes, BufferManager bufferManager, PlanHints hints, Problems problems)` Create a new context for query execution.

  - ### Uses of PlanHints in org.modeshape.jcr.query.engine

    Methods in org.modeshape.jcr.query.engine with parameters of type PlanHints
    Modifier and Type | Method and Description
    --- | ---
    `QueryContext` | ScanningQueryEngine.`createQueryContext(ExecutionContext context, RepositoryCache repositoryCache, Set<String> workspaceNames, Map<String,NodeCache> overriddenNodeCachesByWorkspaceName, Schemata schemata, RepositoryIndexes indexDefns, NodeTypes nodeTypes, BufferManager bufferManager, PlanHints hints, Map<String,Object> variables)`

  - ### Uses of PlanHints in org.modeshape.jcr.query.model

    Constructors in org.modeshape.jcr.query.model with parameters of type PlanHints
    Constructor and Description
    `QueryObjectModel(JcrQueryContext context, String statement, String language, SelectQuery query, PlanHints hints, Path storedAtPath)` Creates a new JCR `Query` by specifying the query statement itself, the language in which the query is stated, the `QueryCommand` representation and, optionally, the node from which the query was loaded.
    `SetQueryObjectModel(JcrQueryContext context, String statement, String language, SetQuery query, PlanHints hints, Path storedAtPath)` Creates a new JCR `Query` by specifying the set query statement itself, the language in which the query is stated, the `SetQuery` representation and, optionally, the node from which the query was loaded.

  - ### Uses of PlanHints in org.modeshape.jcr.query.optimize

    Methods in org.modeshape.jcr.query.optimize with parameters of type PlanHints
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | RuleBasedOptimizer.`populateIndexingRules(LinkedList<OptimizerRule> ruleStack, PlanHints hints)` Method that is used to add the indexing rules to the rule stack.
    `protected void` | RuleBasedOptimizer.`populateRuleStack(LinkedList<OptimizerRule> ruleStack, PlanHints hints)` Method that is used to create the initial rule stack.

  - ### Uses of PlanHints in org.modeshape.jcr.query.plan

    Methods in org.modeshape.jcr.query.plan that return PlanHints
    Modifier and Type | Method and Description
    --- | ---
    `PlanHints` | PlanHints.`clone()`

Copyright © 2008-2014 JBoss, a division of Red Hat. All Rights Reserved.