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

- Packages that use Constraint
  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.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.

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

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

    Methods in org.modeshape.jcr.query with parameters of type Constraint
    Modifier and Type | Method and Description
    --- | ---
    `protected QueryBuilder.ConstraintBuilder` | QueryBuilder.ConstraintBuilder.`setConstraint(Constraint constraint)`
    `protected QueryBuilder.ConstraintBuilder` | QueryBuilder.UpperCaser.`setConstraint(Constraint constraint)`
    `protected QueryBuilder.ConstraintBuilder` | QueryBuilder.LowerCaser.`setConstraint(Constraint constraint)`

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

    Methods in org.modeshape.jcr.query.engine with parameters of type Constraint
    Modifier and Type | Method and Description
    --- | ---
    `protected NodeSequence.RowFilter` | ScanningQueryEngine.`createRowFilter(Constraint constraint, QueryContext context, QueryResults.Columns columns, QuerySources sources)` Create a `NodeSequence.RowFilter` implementation given the supplied constraints.
    `static boolean` | QueryUtil.`includeFullTextScores(Constraint constraint)`

    Method parameters in org.modeshape.jcr.query.engine with type arguments of type Constraint
    Modifier and Type | Method and Description
    --- | ---
    `static boolean` | QueryUtil.`includeFullTextScores(Iterable<Constraint> constraints)`

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

    Methods in org.modeshape.jcr.query.model that return Constraint
    Modifier and Type | Method and Description
    --- | ---
    `Constraint` | Query.`constraint()` Get the constraints, if there are any.
    `Constraint` | SelectQuery.`getConstraint()`
    `Constraint` | Not.`getConstraint()`
    `Constraint` | Or.`getConstraint1()`
    `Constraint` | And.`getConstraint1()`
    `Constraint` | Or.`getConstraint2()`
    `Constraint` | And.`getConstraint2()`
    `Constraint` | Or.`left()` Get the left-hand constraint.
    `Constraint` | And.`left()` Get the constraint that is on the left-hand-side of the AND operation.
    `Constraint` | Or.`right()` Get the right-hand constraint.
    `Constraint` | And.`right()` Get the constraint that is on the right-hand-side of the AND operation.

    Methods in org.modeshape.jcr.query.model with parameters of type Constraint
    Modifier and Type | Method and Description
    --- | ---
    `Query` | Query.`constrainedBy(Constraint constraint)` Create a copy of this query, but one that uses the supplied constraint.

    Constructors in org.modeshape.jcr.query.model with parameters of type Constraint
    Constructor and Description
    `And(Constraint left, Constraint right)`
    `Not(Constraint constraint)` Create a constraint that negates another constraint.
    `Or(Constraint left, Constraint right)` Create a constraint that evaluates to true if either of the two supplied constraints evaluates to true.
    `Query(Source source, Constraint constraint, List<? extends Ordering> orderings, List<? extends Column> columns, Limit limit, boolean isDistinct)` Create a new query that uses the supplied source, constraint, orderings, columns and limits.
    `SelectQuery(Source source, Constraint constraint, List<? extends Ordering> orderings, List<? extends Column> columns, Limit limit, boolean isDistinct)` Create a new query that uses the supplied source, constraint, orderings, columns and limits.

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

    Fields in org.modeshape.jcr.query.optimize declared as Constraint
    Modifier and Type | Field and Description
    --- | ---
    `protected static Constraint` | RewriteAsRangeCriteria.`CONFLICTING_CONSTRAINT`

    Methods in org.modeshape.jcr.query.optimize that return Constraint
    Modifier and Type | Method and Description
    --- | ---
    `protected Constraint` | RewritePseudoColumns.`rewrite(QueryContext context, Constraint constraint)`
    `protected Constraint` | RewriteAsRangeCriteria.`rewrite(QueryContext context, List<Comparison> comparisons)` Rewrite the supplied comparisons, returning the new constraint and nulling in the supplied list those comparisons that were rewritten (and leaving those that were not rewritten)
    `protected Constraint` | RewritePathAndNameCriteria.`rewriteCriteria(QueryContext context, Constraint constraint)`

    Methods in org.modeshape.jcr.query.optimize that return types with arguments of type Constraint
    Modifier and Type | Method and Description
    --- | ---
    `protected List<Constraint>` | RewritePseudoColumns.`rewrite(QueryContext context, List<Constraint> constraints)`

    Methods in org.modeshape.jcr.query.optimize with parameters of type Constraint
    Modifier and Type | Method and Description
    --- | ---
    `protected Constraint` | RewritePseudoColumns.`rewrite(QueryContext context, Constraint constraint)`
    `protected Constraint` | RewritePathAndNameCriteria.`rewriteCriteria(QueryContext context, Constraint constraint)`

    Method parameters in org.modeshape.jcr.query.optimize with type arguments of type Constraint
    Modifier and Type | Method and Description
    --- | ---
    `protected List<Constraint>` | RewritePseudoColumns.`rewrite(QueryContext context, List<Constraint> constraints)`

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

    Methods in org.modeshape.jcr.query.parse that return Constraint
    Modifier and Type | Method and Description
    --- | ---
    `protected Constraint` | JcrSqlQueryParser.`parseConstraint(TokenStream tokens, TypeSystem typeSystem, Source source)` Parse a constraint clause.
    `protected Constraint` | BasicSqlQueryParser.`parseConstraint(TokenStream tokens, TypeSystem typeSystem, Source source)`
    `protected Constraint` | JcrSqlQueryParser.`parsePropertyExistance(TokenStream tokens, TypeSystem typeSystem, Source source)`
    `protected Constraint` | BasicSqlQueryParser.`parsePropertyExistance(TokenStream tokens, TypeSystem typeSystem, Source source)`
    `protected Constraint` | BasicSqlQueryParser.`parseWhere(TokenStream tokens, TypeSystem typeSystem, Source source)`
    `protected Constraint` | JcrSqlQueryParser.`rewriteConstraint(Constraint constraint)`

    Methods in org.modeshape.jcr.query.parse with parameters of type Constraint
    Modifier and Type | Method and Description
    --- | ---
    `protected And` | BasicSqlQueryParser.`and(Constraint constraint1, Constraint constraint2)`
    `protected Not` | BasicSqlQueryParser.`not(Constraint constraint)`
    `protected Or` | BasicSqlQueryParser.`or(Constraint constraint1, Constraint constraint2)`
    `protected Query` | BasicSqlQueryParser.`query(Source source, Constraint constraint, List<? extends Ordering> orderings, List<? extends Column> columns, Limit limit, boolean distinct)`
    `protected Constraint` | JcrSqlQueryParser.`rewriteConstraint(Constraint constraint)`

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

    Methods in org.modeshape.jcr.query.plan that return Constraint
    Modifier and Type | Method and Description
    --- | ---
    `static Constraint` | PlanUtil.`replaceAliasesWithProperties(QueryContext context, Constraint constraint, Map<String,String> propertyByAlias)`
    `static Constraint` | PlanUtil.`replaceReferences(QueryContext context, Constraint constraint, PlanUtil.ColumnMapping mapping, PlanNode node)`
    `static Constraint` | PlanUtil.`replaceReferencesToRemovedSource(QueryContext context, Constraint constraint, Map<SelectorName,SelectorName> rewrittenSelectors)`
    `static Constraint` | PlanUtil.`replaceSubqueriesWithBindVariables(QueryContext context, Constraint constraint, Map<String,Subquery> subqueriesByVariableName)`

    Methods in org.modeshape.jcr.query.plan with parameters of type Constraint
    Modifier and Type | Method and Description
    --- | ---
    `protected PlanNode` | CanonicalPlanner.`attachCriteria(QueryContext context, PlanNode plan, Constraint constraint, List<? extends Column> columns, Map<String,Subquery> subqueriesByVariableName)` Attach all criteria above the join nodes.
    `static Constraint` | PlanUtil.`replaceAliasesWithProperties(QueryContext context, Constraint constraint, Map<String,String> propertyByAlias)`
    `static Constraint` | PlanUtil.`replaceReferences(QueryContext context, Constraint constraint, PlanUtil.ColumnMapping mapping, PlanNode node)`
    `static Constraint` | PlanUtil.`replaceReferencesToRemovedSource(QueryContext context, Constraint constraint, Map<SelectorName,SelectorName> rewrittenSelectors)`
    `static Constraint` | PlanUtil.`replaceSubqueriesWithBindVariables(QueryContext context, Constraint constraint, Map<String,Subquery> subqueriesByVariableName)`
    `protected void` | CanonicalPlanner.`separateAndConstraints(Constraint constraint, List<Constraint> andableConstraints)` Walk the supplied constraint to extract a list of the constraints that can be AND-ed together.

    Method parameters in org.modeshape.jcr.query.plan with type arguments of type Constraint
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | CanonicalPlanner.`separateAndConstraints(Constraint constraint, List<Constraint> andableConstraints)` Walk the supplied constraint to extract a list of the constraints that can be AND-ed together.

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