# Uses of Package
org.modeshape.jcr.query.model

- Packages that use org.modeshape.jcr.query.model
  Package | Description
  --- | ---
  org.modeshape.jcr |
  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.engine.process | When executing a query, the processing phase involves "running" each branch in the optimized query plan, determining the set of nodes that satisfies each branch, and then joining each branch into a single result.
  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.
  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.
  org.modeshape.jcr.spi.index.provider | This package contains the Service Provider Interface (SPI) for custom index providers, which are components that encapsulate how ModeShape updates and uses a set of particular indexes.
  org.modeshape.jcr.value | Nodes in a graph contain properties, and this package defines the interfaces, classes and exceptions for representing and working with properties and their values.

- Classes in org.modeshape.jcr.query.model used by org.modeshape.jcr
  Class and Description
  SelectorName A representation of a qualified or expanded name.
  TypeSystem An interface that defines the value types used in tuples.

- Classes in org.modeshape.jcr.query.model used by org.modeshape.jcr.query
  Class and Description
  ArithmeticOperator The arithmetic operators.
  Column
  Constraint Represents the abstract base class for all constraints.
  DynamicOperand A dynamic operand used in a `Comparison` constraint.
  JoinCondition The condition used for a join between two sources.
  JoinType
  Limit A specification of the limit placed on a query, detailing the a maximum number of result rows and an offset for the first row in the results.
  NamedSelector A Selector that has a name.
  NullOrder An enumeration for the kind of `Ordering`.
  Order An enumeration for the kind of `Ordering`.
  Ordering A specification of the ordering for the results.
  QueryCommand Represents the abstract base class for all query commands.
  SelectorName A representation of a qualified or expanded name.
  SetQuery.Operation
  Source The source that represents a set of node tuples.
  StaticOperand A static operand used in a `Comparison` constraint.
  Subquery A representation of a non-correlated subquery.
  TypeSystem An interface that defines the value types used in tuples.
  TypeSystem.TypeFactory Factory interface for creating values from strings.

- Classes in org.modeshape.jcr.query.model used by org.modeshape.jcr.query.engine
  Class and Description
  Column
  Constraint Represents the abstract base class for all constraints.
  DynamicOperand A dynamic operand used in a `Comparison` constraint.
  Ordering A specification of the ordering for the results.
  QueryCommand Represents the abstract base class for all query commands.
  SelectorName A representation of a qualified or expanded name.
  SetCriteria A constraint that evaluates to true when the defined operation evaluates to true.
  StaticOperand A static operand used in a `Comparison` constraint.
  TypeSystem An interface that defines the value types used in tuples.
  TypeSystem.TypeFactory Factory interface for creating values from strings.

- Classes in org.modeshape.jcr.query.model used by org.modeshape.jcr.query.engine.process
  Class and Description
  JoinType
  NullOrder An enumeration for the kind of `Ordering`.
  TypeSystem An interface that defines the value types used in tuples.
  TypeSystem.TypeFactory Factory interface for creating values from strings.

- Classes in org.modeshape.jcr.query.model used by org.modeshape.jcr.query.model
  Class and Description
  AllNodes A selector that represents a source that returns all nodes.
  And A constraint that evaluates to true when both of the other constraints evaluate to true.
  ArithmeticOperand A dynamic operand that represents a (binary) arithmetic operation upon one or more other operands, used in `Comparison` and `Ordering` components.
  ArithmeticOperator The arithmetic operators.
  ArithmeticOperator.Arity
  Between A constraint that evaluates to true when the value defined by the dynamic operand evaluates to be within the specified range.
  BindVariableName A value bound to a variable name used in a `Comparison` constraint.
  ChildCount A dynamic operand that evaluates to the number of children for each node given by a selector, used in a `Comparison` constraint.
  ChildNode A constraint requiring that the selected node is a child of the node reachable by the supplied absolute path
  ChildNodeJoinCondition A join condition that evaluates to true only when the named child node is indeed a child of the named parent node.
  Column
  Command Represents the abstract base class for all top-level language objects that are the root of a language object tree.
  Comparison A constraint that evaluates to true when the defined operation evaluates to true.
  Constraint Represents the abstract base class for all constraints.
  DescendantNode A constraint requiring that the selected node is a descendant of the node reachable by the supplied absolute path
  DescendantNodeJoinCondition A join condition that evaluates to true only when the named node is a descendant of another named node.
  DynamicOperand A dynamic operand used in a `Comparison` constraint.
  EquiJoinCondition A join condition that tests whether a property on a node is equal to a property on another node.
  FullTextSearch A constraint that evaluates to true only when a full-text search applied to the search scope results in positive findings.
  FullTextSearch.CompoundTerm A list of `FullTextSearch.Term`s.
  FullTextSearch.Term The general notion of a term that makes up a full-text search.
  FullTextSearchScore A dynamic operand that evaluates to the full-text search score of a node given by a selector, used in a `Comparison` constraint and `Ordering`s.
  Join
  JoinCondition The condition used for a join between two sources.
  JoinType
  LanguageObject A common interface for all query language objects.
  Length A dynamic operand that evaluates to the length of the supplied propety values, used in a `Comparison` constraint.
  Limit A specification of the limit placed on a query, detailing the a maximum number of result rows and an offset for the first row in the results.
  Literal A literal value used in a `Comparison` constraint.
  LiteralValue Implementation of the literal value static operand for the JCR Query Object Model, used only in bound variables.
  LowerCase A dynamic operand that evaluates to the lower-case representation of the supplied operand, used in a `Comparison` constraint.
  NamedSelector A Selector that has a name.
  NodeDepth A dynamic operand that evaluates to the depth of a node given by a selector, used in a `Comparison` constraint.
  NodeId A dynamic operand that evaluates to the `identifier` of a node given by a selector, used in a `Comparison` constraint.
  NodeLocalName A dynamic operand that evaluates to the local name of a node given by a selector, used in a `Comparison` constraint.
  NodeName A dynamic operand that evaluates to the qualified name of a node given by a selector, used in a `Comparison` constraint.
  NodePath A dynamic operand that evaluates to the path of a node given by a selector, used in a `Comparison` constraint.
  Not A constraint that negates another constraint.
  NullOrder An enumeration for the kind of `Ordering`.
  Or A constraint that evaluates to true when either of the other constraints evaluates to true.
  Order An enumeration for the kind of `Ordering`.
  Ordering A specification of the ordering for the results.
  PropertyExistence A constraint that evaluates to true only when a named property exists on a node.
  PropertyValue A dynamic operand that evaluates to the value(s) of a property on a selector, used in a `Comparison` constraint.
  Query
  QueryCommand Represents the abstract base class for all query commands.
  QueryObjectModel Implementation of `QueryObjectModel` that represents a `select query`.
  Readable
  ReferenceValue A dynamic operand that evaluates to the value(s) of a single or any reference property on a selector, used in a `Comparison` constraint.
  Relike A constraint that evaluates to true when the reverse like operation evaluates to true.
  SameNode A constraint requiring that the selected node is reachable by the supplied absolute path
  SameNodeJoinCondition A join condition that tests whether two nodes are the same nodes (that is, have the same identifier or have the same relative path from the nearest ancestor with an identifiers).
  Selector
  SelectorName A representation of a qualified or expanded name.
  SelectQuery An implementation of `SelectQuery`.
  SetCriteria A constraint that evaluates to true when the defined operation evaluates to true.
  SetQuery This object acts as a Set operator on multiple `queries`, such as performing UNION, INTERSECT, and EXCEPT operations.
  SetQuery.Operation
  SetQueryObjectModel Implementation of `SetQueryObjectModel` that represents a `set query`.
  Source The source that represents a set of node tuples.
  StaticOperand A static operand used in a `Comparison` constraint.
  Subquery A representation of a non-correlated subquery.
  TypeSystem.TypeFactory Factory interface for creating values from strings.
  UpperCase A dynamic operand that evaluates to the upper-case representation of the supplied operand, used in a `Comparison` constraint.
  Visitable An interface called by a visitor when that visitor is visiting the node.
  Visitor The basic interface for all query visitor implementations.
  Visitors.NavigationVisitor An abstract visitor implementation that performs navigation of the query object.
  Visitors.ReadableVisitor

- Classes in org.modeshape.jcr.query.model used by org.modeshape.jcr.query.optimize
  Class and Description
  Column
  Comparison A constraint that evaluates to true when the defined operation evaluates to true.
  Constraint Represents the abstract base class for all constraints.
  DynamicOperand A dynamic operand used in a `Comparison` constraint.
  JoinCondition The condition used for a join between two sources.
  SelectorName A representation of a qualified or expanded name.
  StaticOperand A static operand used in a `Comparison` constraint.
  Visitable An interface called by a visitor when that visitor is visiting the node.

- Classes in org.modeshape.jcr.query.model used by org.modeshape.jcr.query.parse
  Class and Description
  And A constraint that evaluates to true when both of the other constraints evaluate to true.
  ArithmeticOperand A dynamic operand that represents a (binary) arithmetic operation upon one or more other operands, used in `Comparison` and `Ordering` components.
  ArithmeticOperator The arithmetic operators.
  Between A constraint that evaluates to true when the value defined by the dynamic operand evaluates to be within the specified range.
  BindVariableName A value bound to a variable name used in a `Comparison` constraint.
  ChildCount A dynamic operand that evaluates to the number of children for each node given by a selector, used in a `Comparison` constraint.
  ChildNode A constraint requiring that the selected node is a child of the node reachable by the supplied absolute path
  ChildNodeJoinCondition A join condition that evaluates to true only when the named child node is indeed a child of the named parent node.
  Column
  Comparison A constraint that evaluates to true when the defined operation evaluates to true.
  Constraint Represents the abstract base class for all constraints.
  DescendantNode A constraint requiring that the selected node is a descendant of the node reachable by the supplied absolute path
  DescendantNodeJoinCondition A join condition that evaluates to true only when the named node is a descendant of another named node.
  DynamicOperand A dynamic operand used in a `Comparison` constraint.
  EquiJoinCondition A join condition that tests whether a property on a node is equal to a property on another node.
  FullTextSearch A constraint that evaluates to true only when a full-text search applied to the search scope results in positive findings.
  FullTextSearch.Term The general notion of a term that makes up a full-text search.
  FullTextSearchScore A dynamic operand that evaluates to the full-text search score of a node given by a selector, used in a `Comparison` constraint and `Ordering`s.
  Join
  JoinCondition The condition used for a join between two sources.
  JoinType
  LanguageObject A common interface for all query language objects.
  Length A dynamic operand that evaluates to the length of the supplied propety values, used in a `Comparison` constraint.
  Limit A specification of the limit placed on a query, detailing the a maximum number of result rows and an offset for the first row in the results.
  Literal A literal value used in a `Comparison` constraint.
  LiteralValue Implementation of the literal value static operand for the JCR Query Object Model, used only in bound variables.
  LowerCase A dynamic operand that evaluates to the lower-case representation of the supplied operand, used in a `Comparison` constraint.
  NamedSelector A Selector that has a name.
  NodeDepth A dynamic operand that evaluates to the depth of a node given by a selector, used in a `Comparison` constraint.
  NodeId A dynamic operand that evaluates to the `identifier` of a node given by a selector, used in a `Comparison` constraint.
  NodeLocalName A dynamic operand that evaluates to the local name of a node given by a selector, used in a `Comparison` constraint.
  NodeName A dynamic operand that evaluates to the qualified name of a node given by a selector, used in a `Comparison` constraint.
  NodePath A dynamic operand that evaluates to the path of a node given by a selector, used in a `Comparison` constraint.
  Not A constraint that negates another constraint.
  NullOrder An enumeration for the kind of `Ordering`.
  Or A constraint that evaluates to true when either of the other constraints evaluates to true.
  Order An enumeration for the kind of `Ordering`.
  Ordering A specification of the ordering for the results.
  PropertyExistence A constraint that evaluates to true only when a named property exists on a node.
  PropertyValue A dynamic operand that evaluates to the value(s) of a property on a selector, used in a `Comparison` constraint.
  Query
  QueryCommand Represents the abstract base class for all query commands.
  ReferenceValue A dynamic operand that evaluates to the value(s) of a single or any reference property on a selector, used in a `Comparison` constraint.
  SameNode A constraint requiring that the selected node is reachable by the supplied absolute path
  SameNodeJoinCondition A join condition that tests whether two nodes are the same nodes (that is, have the same identifier or have the same relative path from the nearest ancestor with an identifiers).
  Selector
  SelectorName A representation of a qualified or expanded name.
  SetCriteria A constraint that evaluates to true when the defined operation evaluates to true.
  SetQuery This object acts as a Set operator on multiple `queries`, such as performing UNION, INTERSECT, and EXCEPT operations.
  SetQuery.Operation
  Source The source that represents a set of node tuples.
  StaticOperand A static operand used in a `Comparison` constraint.
  Subquery A representation of a non-correlated subquery.
  TypeSystem An interface that defines the value types used in tuples.
  UpperCase A dynamic operand that evaluates to the upper-case representation of the supplied operand, used in a `Comparison` constraint.
  Visitable An interface called by a visitor when that visitor is visiting the node.
  Visitor The basic interface for all query visitor implementations.

- Classes in org.modeshape.jcr.query.model used by org.modeshape.jcr.query.plan
  Class and Description
  Column
  Constraint Represents the abstract base class for all constraints.
  DynamicOperand A dynamic operand used in a `Comparison` constraint.
  EquiJoinCondition A join condition that tests whether a property on a node is equal to a property on another node.
  JoinCondition The condition used for a join between two sources.
  Limit A specification of the limit placed on a query, detailing the a maximum number of result rows and an offset for the first row in the results.
  Ordering A specification of the ordering for the results.
  PropertyExistence A constraint that evaluates to true only when a named property exists on a node.
  PropertyValue A dynamic operand that evaluates to the value(s) of a property on a selector, used in a `Comparison` constraint.
  Query
  QueryCommand Represents the abstract base class for all query commands.
  Readable
  ReferenceValue A dynamic operand that evaluates to the value(s) of a single or any reference property on a selector, used in a `Comparison` constraint.
  SelectorName A representation of a qualified or expanded name.
  SetQuery This object acts as a Set operator on multiple `queries`, such as performing UNION, INTERSECT, and EXCEPT operations.
  Source The source that represents a set of node tuples.
  StaticOperand A static operand used in a `Comparison` constraint.
  Subquery A representation of a non-correlated subquery.
  Visitor The basic interface for all query visitor implementations.
  Visitors.AbstractVisitor A common base class for all visitors, which provides no-op implementations for all `visit(...)` methods.

- Classes in org.modeshape.jcr.query.model used by org.modeshape.jcr.query.validate
  Class and Description
  AllNodes A selector that represents a source that returns all nodes.
  ArithmeticOperand A dynamic operand that represents a (binary) arithmetic operation upon one or more other operands, used in `Comparison` and `Ordering` components.
  ChildCount A dynamic operand that evaluates to the number of children for each node given by a selector, used in a `Comparison` constraint.
  ChildNode A constraint requiring that the selected node is a child of the node reachable by the supplied absolute path
  ChildNodeJoinCondition A join condition that evaluates to true only when the named child node is indeed a child of the named parent node.
  Column
  Comparison A constraint that evaluates to true when the defined operation evaluates to true.
  DescendantNode A constraint requiring that the selected node is a descendant of the node reachable by the supplied absolute path
  DescendantNodeJoinCondition A join condition that evaluates to true only when the named node is a descendant of another named node.
  DynamicOperand A dynamic operand used in a `Comparison` constraint.
  EquiJoinCondition A join condition that tests whether a property on a node is equal to a property on another node.
  FullTextSearch A constraint that evaluates to true only when a full-text search applied to the search scope results in positive findings.
  FullTextSearchScore A dynamic operand that evaluates to the full-text search score of a node given by a selector, used in a `Comparison` constraint and `Ordering`s.
  Length A dynamic operand that evaluates to the length of the supplied propety values, used in a `Comparison` constraint.
  LowerCase A dynamic operand that evaluates to the lower-case representation of the supplied operand, used in a `Comparison` constraint.
  NamedSelector A Selector that has a name.
  NodeDepth A dynamic operand that evaluates to the depth of a node given by a selector, used in a `Comparison` constraint.
  NodeLocalName A dynamic operand that evaluates to the local name of a node given by a selector, used in a `Comparison` constraint.
  NodeName A dynamic operand that evaluates to the qualified name of a node given by a selector, used in a `Comparison` constraint.
  NodePath A dynamic operand that evaluates to the path of a node given by a selector, used in a `Comparison` constraint.
  Ordering A specification of the ordering for the results.
  PropertyExistence A constraint that evaluates to true only when a named property exists on a node.
  PropertyValue A dynamic operand that evaluates to the value(s) of a property on a selector, used in a `Comparison` constraint.
  Query
  QueryCommand Represents the abstract base class for all query commands.
  ReferenceValue A dynamic operand that evaluates to the value(s) of a single or any reference property on a selector, used in a `Comparison` constraint.
  SameNode A constraint requiring that the selected node is reachable by the supplied absolute path
  SameNodeJoinCondition A join condition that tests whether two nodes are the same nodes (that is, have the same identifier or have the same relative path from the nearest ancestor with an identifiers).
  SelectorName A representation of a qualified or expanded name.
  StaticOperand A static operand used in a `Comparison` constraint.
  Subquery A representation of a non-correlated subquery.
  Visitable An interface called by a visitor when that visitor is visiting the node.
  Visitor The basic interface for all query visitor implementations.
  Visitors.AbstractVisitor A common base class for all visitors, which provides no-op implementations for all `visit(...)` methods.

- Classes in org.modeshape.jcr.query.model used by org.modeshape.jcr.query.xpath
  Class and Description
  Order An enumeration for the kind of `Ordering`.
  QueryCommand Represents the abstract base class for all query commands.
  TypeSystem An interface that defines the value types used in tuples.

- Classes in org.modeshape.jcr.query.model used by org.modeshape.jcr.spi.index.provider
  Class and Description
  And A constraint that evaluates to true when both of the other constraints evaluate to true.
  Comparison A constraint that evaluates to true when the defined operation evaluates to true.
  FullTextSearch A constraint that evaluates to true only when a full-text search applied to the search scope results in positive findings.
  Length A dynamic operand that evaluates to the length of the supplied propety values, used in a `Comparison` constraint.
  LowerCase A dynamic operand that evaluates to the lower-case representation of the supplied operand, used in a `Comparison` constraint.
  NodeLocalName A dynamic operand that evaluates to the local name of a node given by a selector, used in a `Comparison` constraint.
  NodeName A dynamic operand that evaluates to the qualified name of a node given by a selector, used in a `Comparison` constraint.
  Not A constraint that negates another constraint.
  Or A constraint that evaluates to true when either of the other constraints evaluates to true.
  PropertyExistence A constraint that evaluates to true only when a named property exists on a node.
  PropertyValue A dynamic operand that evaluates to the value(s) of a property on a selector, used in a `Comparison` constraint.
  UpperCase A dynamic operand that evaluates to the upper-case representation of the supplied operand, used in a `Comparison` constraint.

- Classes in org.modeshape.jcr.query.model used by org.modeshape.jcr.value
  Class and Description
  TypeSystem An interface that defines the value types used in tuples.
  TypeSystem.TypeFactory Factory interface for creating values from strings.

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