## 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.lucene | The core query engine, which currently uses Lucene for indexing and raw queries, and the Hibernate Search engine (which does not depend on or use Hibernate Core or JPA) for updating and querying the Lucene indexes.
  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.
  org.modeshape.jcr.query.process | This package defines the `QueryProcessor` interface, which is responsible for constructing for each query a tree of `ProcessingComponent` objects that each are responsible for processing a specific aspect of the query and returning the tuples to the parent component.

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

    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)`
    `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, PlanHints hints, Problems problems, Map<String,Object> variables)` Create a new context for query execution.
    `QueryContext(ExecutionContext context, RepositoryCache repositoryCache, Set<String> workspaceNames, Schemata schemata, PlanHints hints, Problems problems)` Create a new context for query execution.

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

    Methods in org.modeshape.jcr.query.lucene with parameters of type PlanHints
    Modifier and Type | Method and Description
    --- | ---
    `CancellableQuery` | LuceneQueryEngine.`query(ExecutionContext context, RepositoryCache repositoryCache, Set<String> workspaceNames, Map<String,NodeCache> overriddenNodeCachesByWorkspaceName, QueryCommand query, Schemata schemata, PlanHints hints, Map<String,Object> variables)` Execute the supplied query against the named workspace, using the supplied hints, schemata and 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.`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()`

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

    Methods in org.modeshape.jcr.query.process with parameters of type PlanHints
    Modifier and Type | Method and Description
    --- | ---
    `protected QueryResultColumns` | QueryEngine.`determineQueryResultColumns(PlanNode optimizedPlan, PlanHints hints)`

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