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

- Packages that use Visitable
  Package | Description
  --- | ---
  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.validate | This package provides the interfaces that define the tables and columns that can be queried.

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

    Subinterfaces of Visitable in org.modeshape.jcr.query.model
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `Command` Represents the abstract base class for all top-level language objects that are the root of a language object tree.
    `interface` | `Constraint` Represents the abstract base class for all constraints.
    `interface` | `DynamicOperand` A dynamic operand used in a `Comparison` constraint.
    `interface` | `JoinCondition` The condition used for a join between two sources.
    `interface` | `LanguageObject` A common interface for all query language objects.
    `interface` | `QueryCommand` Represents the abstract base class for all query commands.
    `interface` | `Source` The source that represents a set of node tuples.
    `interface` | `StaticOperand` A static operand used in a `Comparison` constraint.

    Classes in org.modeshape.jcr.query.model that implement Visitable
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AllNodes` A selector that represents a source that returns all nodes.
    `class` | `And` A constraint that evaluates to true when both of the other constraints evaluate to true.
    `class` | `ArithmeticOperand` A dynamic operand that represents a (binary) arithmetic operation upon one or more other operands, used in `Comparison` and `Ordering` components.
    `class` | `Between` A constraint that evaluates to true when the value defined by the dynamic operand evaluates to be within the specified range.
    `class` | `BindVariableName` A value bound to a variable name used in a `Comparison` constraint.
    `class` | `ChildCount` A dynamic operand that evaluates to the number of children for each node given by a selector, used in a `Comparison` constraint.
    `class` | `ChildNode` A constraint requiring that the selected node is a child of the node reachable by the supplied absolute path
    `class` | `ChildNodeJoinCondition` A join condition that evaluates to true only when the named child node is indeed a child of the named parent node.
    `class` | `Column`
    `class` | `Comparison` A constraint that evaluates to true when the defined operation evaluates to true.
    `class` | `DescendantNode` A constraint requiring that the selected node is a descendant of the node reachable by the supplied absolute path
    `class` | `DescendantNodeJoinCondition` A join condition that evaluates to true only when the named node is a descendant of another named node.
    `class` | `EquiJoinCondition` A join condition that tests whether a property on a node is equal to a property on another node.
    `class` | `FullTextSearch` A constraint that evaluates to true only when a full-text search applied to the search scope results in positive findings.
    `class` | `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.
    `class` | `Join`
    `class` | `Length` A dynamic operand that evaluates to the length of the supplied propety values, used in a `Comparison` constraint.
    `class` | `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.
    `class` | `Literal` A literal value used in a `Comparison` constraint.
    `class` | `LiteralValue` Implementation of the literal value static operand for the JCR Query Object Model, used only in bound variables.
    `class` | `LowerCase` A dynamic operand that evaluates to the lower-case representation of the supplied operand, used in a `Comparison` constraint.
    `class` | `NamedSelector` A Selector that has a name.
    `class` | `NodeDepth` A dynamic operand that evaluates to the depth of a node given by a selector, used in a `Comparison` constraint.
    `class` | `NodeId` A dynamic operand that evaluates to the `identifier` of a node given by a selector, used in a `Comparison` constraint.
    `class` | `NodeLocalName` A dynamic operand that evaluates to the local name of a node given by a selector, used in a `Comparison` constraint.
    `class` | `NodeName` A dynamic operand that evaluates to the qualified name of a node given by a selector, used in a `Comparison` constraint.
    `class` | `NodePath` A dynamic operand that evaluates to the path of a node given by a selector, used in a `Comparison` constraint.
    `class` | `Not` A constraint that negates another constraint.
    `class` | `Or` A constraint that evaluates to true when either of the other constraints evaluates to true.
    `class` | `Ordering` A specification of the ordering for the results.
    `class` | `PropertyExistence` A constraint that evaluates to true only when a named property exists on a node.
    `class` | `PropertyValue` A dynamic operand that evaluates to the value(s) of a property on a selector, used in a `Comparison` constraint.
    `class` | `Query`
    `class` | `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.
    `class` | `Relike` A constraint that evaluates to true when the reverse like operation evaluates to true.
    `class` | `SameNode` A constraint requiring that the selected node is reachable by the supplied absolute path
    `class` | `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).
    `class` | `Selector`
    `class` | `SelectQuery` An implementation of `SelectQuery`.
    `class` | `SetCriteria` A constraint that evaluates to true when the defined operation evaluates to true.
    `class` | `SetQuery` This object acts as a Set operator on multiple `queries`, such as performing UNION, INTERSECT, and EXCEPT operations.
    `class` | `Subquery` A representation of a non-correlated subquery.
    `class` | `UpperCase` A dynamic operand that evaluates to the upper-case representation of the supplied operand, used in a `Comparison` constraint.

    Methods in org.modeshape.jcr.query.model with parameters of type Visitable
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | Visitors.NavigationVisitor.`enqueue(Visitable objectToBeVisited)`
    `static Map<SelectorName,SelectorName>` | Visitors.`getSelectorAliasesByName(Visitable visitable)` Get a map of the selector aliases keyed by their names.
    `static Map<SelectorName,SelectorName>` | Visitors.`getSelectorNamesByAlias(Visitable visitable)` Get a map of the selector names keyed by their aliases.
    `static Set<SelectorName>` | Visitors.`getSelectorsReferencedBy(Visitable visitable)` Get the names of the selectors referenced by the visitable object.
    `static String` | Visitors.`readable(Visitable visitable)` Using a visitor, obtain the readable string representation of the supplied `object`
    `static String` | Visitors.`readable(Visitable visitable, ExecutionContext context)` Using a visitor, obtain the readable string representation of the supplied `object`
    `static Collection<Subquery>` | Visitors.`subqueries(Visitable visitable, boolean includeNestedSubqueries)` Using a visitor, obtain the `Subquery` objects that are contained within the supplied `object`.
    `static <GeneralVisitor extends Visitor> GeneralVisitor` | Visitors.`visit(Visitable visitable, GeneralVisitor visitor)` Visit the supplied `object` using the supplied `Visitor`, which must be responsible for navigation as well as any business logic.
    `static <StrategyVisitor extends Visitor> StrategyVisitor` | Visitors.`visitAll(Visitable visitable, StrategyVisitor strategyVisitor)` Visit all objects in the supplied `object` using a `Visitors.NavigationVisitor` (specifically a `Visitors.WalkAllVisitor`), and with each of these visited objects calling the appropriate `visit(...)` method on the supplied `Visitor`.

    Method parameters in org.modeshape.jcr.query.model with type arguments of type Visitable
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | Visitors.NavigationVisitor.`enqueue(Iterable<? extends Visitable> objectsToBeVisited)`
    `static <StrategyVisitor extends Visitor> StrategyVisitor` | Visitors.`visitAll(Iterable<? extends Visitable> visitables, StrategyVisitor strategyVisitor)` Visit all objects in the supplied `object` using a `Visitors.NavigationVisitor` (specifically a `Visitors.WalkAllVisitor`), and with each of these visited objects calling the appropriate `visit(...)` method on the supplied `Visitor`.

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

    Methods in org.modeshape.jcr.query.optimize with parameters of type Visitable
    Modifier and Type | Method and Description
    --- | ---
    `static Set<Column>` | RaiseSelectCriteria.`getColumnsReferencedBy(Visitable visitable)` Get the set of Column objects that represent those columns referenced by the visitable object.
    `static Set<Column>` | CopyCriteria.`getColumnsReferencedBy(Visitable visitable)` Get the set of Column objects that represent those columns referenced by the visitable object.

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

    Classes in org.modeshape.jcr.query.parse that implement Visitable
    Modifier and Type | Class and Description
    --- | ---
    `protected static class` | `JcrSqlQueryParser.JoinableSources`

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

    Methods in org.modeshape.jcr.query.validate with parameters of type Visitable
    Modifier and Type | Method and Description
    --- | ---
    `protected String` | Validator.`readable(Visitable visitable)`

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