## Uses of Interface
org.modeshape.jcr.query.model.QueryCommand

- Packages that use QueryCommand
  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.parse | This package defines the `QueryParser` interface, which defines a component that can parse a query represented in a specific language and produce the corresponding `abstract query model` representation.
  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.
  org.modeshape.jcr.query.validate | This package provides the interfaces that define the tables and columns that can be queried.
  org.modeshape.jcr.query.xpath | The components used to parse JCR XPath queries and translate them into equivalent JCR-SQL2 queries.

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

    Fields in org.modeshape.jcr.query declared as QueryCommand
    Modifier and Type | Field and Description
    --- | ---
    `protected QueryCommand` | QueryBuilder.`firstQuery`

    Methods in org.modeshape.jcr.query that return QueryCommand
    Modifier and Type | Method and Description
    --- | ---
    `QueryCommand` | JcrQuery.`getAbstractQueryModel()` Get the underlying and immutable Abstract Query Model representation of this query.
    `QueryCommand` | QueryBuilder.`query()` Return a `QueryCommand` representing the currently-built query.
    `protected QueryCommand` | JcrQuery.`query()`

    Methods in org.modeshape.jcr.query with parameters of type QueryCommand
    Modifier and Type | Method and Description
    --- | ---
    `CancellableQuery` | JcrQueryContext.`createExecutableQuery(QueryCommand query, PlanHints hints, Map<String,Object> variables)`
    `QueryBuilder.ConstraintBuilder` | QueryBuilder.ComparisonBuilder.`is(Operator operator, QueryCommand subquery)` Define the right-hand-side of the constraint using the supplied operator.
    `QueryBuilder.ConstraintBuilder` | QueryBuilder.ComparisonBuilder.`isInSubquery(QueryCommand subquery)`
    `QueryBuilder.ConstraintBuilder` | QueryBuilder.RightHandSide.`literal(QueryCommand subquery)` Define the right-hand side of a comparison.
    `QueryBuilder.ConstraintBuilder` | QueryBuilder.UpperBoundary.`subquery(QueryCommand subquery)` Define the upper boundary value of a range.
    `QueryBuilder.AndBuilder<QueryBuilder.UpperBoundary>` | QueryBuilder.LowerBoundary.`subquery(QueryCommand subquery)` Define the lower boundary value of a range.

    Constructors in org.modeshape.jcr.query with parameters of type QueryCommand
    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.

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

    Methods in org.modeshape.jcr.query.lucene with parameters of type QueryCommand
    Modifier and Type | Method and Description
    --- | ---
    `protected ProcessingComponent` | LuceneQueryEngine.LuceneQueryProcessor.`createAccessComponent(QueryCommand originalQuery, QueryContext context, PlanNode accessNode, QueryResults.Columns resultColumns, LuceneProcessingContext processingContext)`
    `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 QueryCommand in org.modeshape.jcr.query.model

    Methods in org.modeshape.jcr.query.model that return QueryCommand
    Modifier and Type | Method and Description
    --- | ---
    `QueryCommand` | SetQueryObjectModel.`getLeft()`
    `QueryCommand` | SetQuery.`getLeft()`
    `QueryCommand` | Subquery.`getQuery()`
    `QueryCommand` | SetQueryObjectModel.`getRight()`
    `QueryCommand` | SetQuery.`getRight()`
    `QueryCommand` | QueryCommand.`withLimit(int rowLimit)` Create a copy of this query, but one that uses the supplied limit on the number of result rows.
    `QueryCommand` | QueryCommand.`withOffset(int offset)` Create a copy of this query, but one that uses the supplied offset.

    Constructors in org.modeshape.jcr.query.model with parameters of type QueryCommand
    Constructor and Description
    `SetQuery(QueryCommand left, SetQuery.Operation operation, QueryCommand right, boolean all)` Create a set query involving the supplied left- and right-hand-side queries.
    `SetQuery(QueryCommand left, SetQuery.Operation operation, QueryCommand right, boolean all, List<? extends Ordering> orderings, Limit limit)` Create a set query involving the supplied left- and right-hand-side queries.
    `Subquery(QueryCommand query)` Create a new subquery component that uses the supplied query as the subquery expression.

  - ### Uses of QueryCommand in org.modeshape.jcr.query.parse

    Methods in org.modeshape.jcr.query.parse that return QueryCommand
    Modifier and Type | Method and Description
    --- | ---
    `QueryCommand` | QueryParsers.`parse(TypeSystem typeSystem, String language, String query)` Execute the supplied query by planning, optimizing, and then processing it.
    `QueryCommand` | QueryParser.`parseQuery(String query, TypeSystem typeSystem)` Parse the supplied query from a string representation into a `QueryCommand`.
    `QueryCommand` | FullTextSearchParser.`parseQuery(String query, TypeSystem typeSystem)`
    `QueryCommand` | BasicSqlQueryParser.`parseQuery(String query, TypeSystem typeSystem)`
    `protected QueryCommand` | BasicSqlQueryParser.`parseQueryCommand(TokenStream tokens, TypeSystem typeSystem)`

    Methods in org.modeshape.jcr.query.parse with parameters of type QueryCommand
    Modifier and Type | Method and Description
    --- | ---
    `protected SetQuery` | BasicSqlQueryParser.`parseSetQuery(TokenStream tokens, QueryCommand leftHandSide, TypeSystem typeSystem)`
    `protected SetQuery` | BasicSqlQueryParser.`setQuery(QueryCommand leftQuery, SetQuery.Operation operation, QueryCommand rightQuery, boolean all)`
    `protected Subquery` | BasicSqlQueryParser.`subquery(QueryCommand queryCommand)`

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

    Methods in org.modeshape.jcr.query.plan with parameters of type QueryCommand
    Modifier and Type | Method and Description
    --- | ---
    `PlanNode` | Planner.`createPlan(QueryContext context, QueryCommand query)` Create a canonical query plan for the given command.
    `PlanNode` | CanonicalPlanner.`createPlan(QueryContext context, QueryCommand query)`
    `protected void` | CanonicalPlanner.`validate(QueryContext context, QueryCommand query, Map<SelectorName,Schemata.Table> usedSelectors)` Validate the supplied query.

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

    Methods in org.modeshape.jcr.query.process with parameters of type QueryCommand
    Modifier and Type | Method and Description
    --- | ---
    `protected abstract ProcessingComponent` | QueryProcessor.`createAccessComponent(QueryCommand originalQuery, QueryContext context, PlanNode accessNode, QueryResults.Columns resultColumns, ProcessingContextType processingContext)` Create the `ProcessingComponent` that processes a single `PlanNode.Type.ACCESS` branch of a query plan.
    `protected ProcessingComponent` | QueryProcessor.`createComponent(QueryCommand originalQuery, QueryContext context, PlanNode node, QueryResults.Columns columns, ProcessingContextType processingContext)` Method that is called to build up the `ProcessingComponent` objects that correspond to the optimized query plan.
    `QueryResults` | QueryEngine.`execute(QueryContext context, QueryCommand query)` Execute the supplied query by planning, optimizing, and then processing it.
    `QueryResults` | QueryProcessor.`execute(QueryContext context, QueryCommand command, QueryResults.Statistics statistics, PlanNode plan)`
    `QueryResults` | Processor.`execute(QueryContext context, QueryCommand command, QueryResults.Statistics statistics, PlanNode plan)` Process the supplied query plan for the given command and return the results.

  - ### Uses of QueryCommand in org.modeshape.jcr.query.validate

    Methods in org.modeshape.jcr.query.validate that return QueryCommand
    Modifier and Type | Method and Description
    --- | ---
    `QueryCommand` | Schemata.View.`getDefinition()` Get the `query` that is the definition of the view.

    Methods in org.modeshape.jcr.query.validate with parameters of type QueryCommand
    Modifier and Type | Method and Description
    --- | ---
    `ImmutableSchemata.Builder` | ImmutableSchemata.Builder.`addView(String name, QueryCommand definition)` Add a view with the supplied name and definition.

  - ### Uses of QueryCommand in org.modeshape.jcr.query.xpath

    Methods in org.modeshape.jcr.query.xpath that return QueryCommand
    Modifier and Type | Method and Description
    --- | ---
    `QueryCommand` | XPathToQueryTranslator.`createQuery(XPath.Component xpath)`
    `QueryCommand` | XPathQueryParser.`parseQuery(String query, TypeSystem typeSystem)`

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