# Uses of Package
org.modeshape.jcr.query

- Packages that use org.modeshape.jcr.query
  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.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.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.

- Classes in org.modeshape.jcr.query used by org.modeshape.jcr.query
  Class and Description
  BufferManager A manager of temporary buffers used in the query system.
  BufferManager.Buffer A basic buffer interface.
  BufferManager.CloseableBuffer
  BufferManager.DistinctBuffer A buffer used to determine distinct values.
  BufferManager.DistinctBufferMaker An object use to create a new `BufferManager.DistinctBuffer`.
  BufferManager.KeySerializerWithComparator
  BufferManager.MakeOrderedBuffer
  BufferManager.Predicate
  BufferManager.QueueBuffer A buffer that maintains the insertion order of a series of values.
  BufferManager.QueueBufferMaker An object use to create a new `BufferManager.DistinctBuffer`.
  BufferManager.SortingBuffer A buffer used to sort values into ascending or descending order.
  BufferManager.SortingBufferMaker An object use to create a new `BufferManager.SortingBuffer`.
  BufferManager.UniqueKey
  CancellableQuery A simple interface that allows tracking an executing query that can be cancelled.
  JcrAbstractQuery Abstract implementation of JCR's `Query` interface.
  JcrQueryContext The context in which queries are executed.
  JcrQueryResult The results of a query.
  JcrQueryResult.AbstractRow
  JcrQueryResult.QueryResultIterator The `NodeIterator` implementation returned by the `JcrQueryResult`.
  JcrQueryResult.QueryResultRowIterator The `RowIterator` implementation returned by the `JcrQueryResult`.
  NodeSequence A sequence of nodes that is accessed by batches and that is accessible only once.
  NodeSequence.Batch A batch of rows containing nodes and scores.
  NodeSequence.Restartable
  NodeSequence.RowAccessor An interface that abstracts accessing the node(s) and score(s) in a row.
  NodeSequence.RowFilter A filter of rows.
  NodeSequence.SingleWidthBatch
  QueryBuilder A component that can be used to programmatically create `QueryCommand` objects.
  QueryBuilder.AndBuilder
  QueryBuilder.ArithmeticBuilder
  QueryBuilder.CastAs
  QueryBuilder.ComparisonBuilder An interface used to set the right-hand side of a constraint.
  QueryBuilder.ConstraintBuilder
  QueryBuilder.DynamicOperandBuilder Interface that defines a dynamic operand portion of a criteria.
  QueryBuilder.JoinClause Class used to specify a join clause of a query.
  QueryBuilder.LowerBoundary
  QueryBuilder.OrderByBuilder The component used to build the order-by clause.
  QueryBuilder.OrderByOperandBuilder
  QueryBuilder.RightHandSide
  QueryBuilder.UpperBoundary
  QueryContext An immutable context in which queries are to be executed.
  QueryEngine
  QueryEngineBuilder
  QueryResults The resulting output of a query.
  QueryResults.Columns Definition of the columns that are available in the results.
  QueryResults.Statistics
  RowExtractors.ExtractFromRow An operation that extracts a single value from the current row in a given `NodeSequence.Batch`.
  Tuples.Tuple2
  Tuples.Tuple3
  Tuples.Tuple4
  Tuples.TupleFactory
  Tuples.TupleN

- Classes in org.modeshape.jcr.query used by org.modeshape.jcr.query.engine
  Class and Description
  BufferManager A manager of temporary buffers used in the query system.
  NodeSequence A sequence of nodes that is accessed by batches and that is accessible only once.
  NodeSequence.Batch A batch of rows containing nodes and scores.
  NodeSequence.RowFilter A filter of rows.
  QueryContext An immutable context in which queries are to be executed.
  QueryEngine
  QueryEngineBuilder
  QueryResults The resulting output of a query.
  QueryResults.Columns Definition of the columns that are available in the results.
  QueryResults.Statistics
  RowExtractors.ExtractFromRow An operation that extracts a single value from the current row in a given `NodeSequence.Batch`.

- Classes in org.modeshape.jcr.query used by org.modeshape.jcr.query.engine.process
  Class and Description
  BufferManager A manager of temporary buffers used in the query system.
  BufferManager.DistinctBuffer A buffer used to determine distinct values.
  BufferManager.QueueBuffer A buffer that maintains the insertion order of a series of values.
  BufferManager.SortingBuffer A buffer used to sort values into ascending or descending order.
  NodeSequence A sequence of nodes that is accessed by batches and that is accessible only once.
  NodeSequence.Batch A batch of rows containing nodes and scores.
  NodeSequence.Restartable
  NodeSequence.RowAccessor An interface that abstracts accessing the node(s) and score(s) in a row.
  RowExtractors.ExtractFromRow An operation that extracts a single value from the current row in a given `NodeSequence.Batch`.

- Classes in org.modeshape.jcr.query used by org.modeshape.jcr.query.model
  Class and Description
  JcrAbstractQuery Abstract implementation of JCR's `Query` interface.
  JcrQuery Implementation of `Query` that represents a `query command`.
  JcrQueryContext The context in which queries are executed.

- Classes in org.modeshape.jcr.query used by org.modeshape.jcr.query.optimize
  Class and Description
  QueryContext An immutable context in which queries are to be executed.

- Classes in org.modeshape.jcr.query used by org.modeshape.jcr.query.plan
  Class and Description
  QueryContext An immutable context in which queries are to be executed.

- Classes in org.modeshape.jcr.query used by org.modeshape.jcr.query.validate
  Class and Description
  QueryContext An immutable context in which queries are to be executed.

- Classes in org.modeshape.jcr.query used by org.modeshape.jcr.query.xpath
  Class and Description
  QueryBuilder.ConstraintBuilder

- Classes in org.modeshape.jcr.query used by org.modeshape.jcr.spi.index.provider
  Class and Description
  QueryContext An immutable context in which queries are to be executed.

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