## Uses of Interface
org.apache.cayenne.query.Query

- Packages that use Query
  Package | Description
  --- | ---
  org.apache.cayenne | Contains persistence APIs directly accessible by users.
  org.apache.cayenne.access | Contains classes that make up Cayenne ORM stack.
  org.apache.cayenne.access.jdbc | Contains classes that handle JDBC interactions.
  org.apache.cayenne.access.translator.select |
  org.apache.cayenne.access.util |
  org.apache.cayenne.dba | Contains database adapter API (DbAdapter) and its default implementation.
  org.apache.cayenne.dba.db2 | IBM DB2 DbAdapter.
  org.apache.cayenne.dba.hsqldb | HSQLDB DbAdapter.
  org.apache.cayenne.dba.ingres |
  org.apache.cayenne.dba.mysql | MySQL DbAdapter.
  org.apache.cayenne.dba.oracle | Oracle DbAdapter.
  org.apache.cayenne.dba.postgres | PostgreSQL DbAdapter.
  org.apache.cayenne.dba.sqlite |
  org.apache.cayenne.dba.sqlserver | MS SQLServer DbAdapter.
  org.apache.cayenne.dba.sybase | Sybase DbAdapter.
  org.apache.cayenne.map | Contains O/R mapping classes that store relational database metadata information and map it to Java classes.
  org.apache.cayenne.query | Defines standard queries supported by Cayenne and extension mechanism to create custom queries.
  org.apache.cayenne.remote | Contains classes an interfaces related to Cayenne remote object persistence features.
  org.apache.cayenne.util | General utility classes.

- - ### Uses of Query in org.apache.cayenne

    Methods in org.apache.cayenne with parameters of type Query
    Modifier and Type | Method | Description
    --- | --- | ---
    `static Object` | Cayenne.`objectForQuery​(ObjectContext context, Query query)` | Returns an object or a DataRow that is a result of a given query.
    `QueryResponse` | DataChannel.`onQuery​(ObjectContext originatingContext, Query query)` | Executes a query, using provided context to register persistent objects if query returns any objects.
    `QueryResponse` | DataChannelFilter.`onQuery​(ObjectContext originatingContext, Query query, DataChannelFilterChain filterChain)` | Deprecated.
    `default QueryResponse` | DataChannelFilter.`onQuery​(ObjectContext originatingContext, Query query, DataChannelQueryFilterChain filterChain)` | Deprecated. Adapter method that allows to use old DataChannelFilter as new query filter
    `default QueryResponse` | DataChannelFilterChain.`onQuery​(ObjectContext originatingContext, Query query)` | Deprecated.
    `QueryResponse` | DataChannelQueryFilter.`onQuery​(ObjectContext originatingContext, Query query, DataChannelQueryFilterChain filterChain)` |
    `QueryResponse` | DataChannelQueryFilterChain.`onQuery​(ObjectContext originatingContext, Query query)` |
    `abstract QueryResponse` | BaseContext.`performGenericQuery​(Query query)` |
    `QueryResponse` | ObjectContext.`performGenericQuery​(Query query)` | Executes any kind of query providing the result in a form of QueryResponse.
    `abstract List` | BaseContext.`performQuery​(Query query)` |
    `List` | ObjectContext.`performQuery​(Query query)` | Executes a selecting query, returning a list of persistent objects or data rows.

  - ### Uses of Query in org.apache.cayenne.access

    Methods in org.apache.cayenne.access that return Query
    Modifier and Type | Method | Description
    --- | --- | ---
    `Query` | DataContextDelegate.`willPerformGenericQuery​(DataContext context, Query query)` | Invoked before a Query is executed via DataContext.performGenericQuery.
    `Query` | DataContextDelegate.`willPerformQuery​(DataContext context, Query query)` | Invoked before a Query is executed via DataContext.performQuery.

    Methods in org.apache.cayenne.access with parameters of type Query
    Modifier and Type | Method | Description
    --- | --- | ---
    `protected void` | IncrementalFaultList.`fillIn​(Query query, List<Object> elementsList)` | Performs initialization of the list of objects.
    `void` | OperationObserver.`nextBatchCount​(Query query, int[] resultCount)` | Callback method invoked after a batch update is executed.
    `void` | OperationObserver.`nextCount​(Query query, int resultCount)` | Callback method invoked after an updating query is executed.
    `void` | OperationObserver.`nextGeneratedRows​(Query query, ResultIterator<?> keys, ObjectId idToUpdate)` | Callback method invoked after each batch of generated values is read during an update.
    `void` | OperationObserver.`nextQueryException​(Query query, Exception ex)` | Callback method invoked on exceptions that happen during an execution of a specific query.
    `void` | OperationObserver.`nextRows​(Query query, List<?> dataRows)` | Callback method invoked for each processed ResultSet.
    `void` | OperationObserver.`nextRows​(Query q, ResultIterator<?> it)` | Callback method invoked for each opened ResultIterator.
    `QueryResponse` | ClientServerChannel.`onQuery​(ObjectContext context, Query query)` |
    `QueryResponse` | DataContext.`onQuery​(ObjectContext context, Query query)` | An implementation of a `DataChannel` method that is used by child contexts to execute queries.
    `QueryResponse` | DataDomain.`onQuery​(ObjectContext originatingContext, Query query)` | Runs query returning generic QueryResponse.
    `QueryResponse` | DataContext.`performGenericQuery​(Query query)` | Executes a query returning a generic response.
    `ResultIterator` | DataContext.`performIteratedQuery​(Query query)` | Performs a single database select query returning result as a ResultIterator.
    `int[]` | DataContext.`performNonSelectingQuery​(Query query)` | Performs a single database query that does not select rows.
    `List` | DataContext.`performQuery​(Query query)` | Performs a single selecting query.
    `Query` | DataContextDelegate.`willPerformGenericQuery​(DataContext context, Query query)` | Invoked before a Query is executed via DataContext.performGenericQuery.
    `Query` | DataContextDelegate.`willPerformQuery​(DataContext context, Query query)` | Invoked before a Query is executed via DataContext.performQuery.

    Method parameters in org.apache.cayenne.access with type arguments of type Query
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | DataDomain.`performQueries​(Collection<? extends Query> queries, OperationObserver callback)` | Routes queries to appropriate DataNodes for execution.
    `void` | DataNode.`performQueries​(Collection<? extends Query> queries, OperationObserver callback)` | Runs queries using Connection obtained from internal DataSource.
    `void` | QueryEngine.`performQueries​(Collection<? extends Query> queries, OperationObserver resultConsumer)` | Executes a list of queries wrapping them in its own transaction.

    Constructors in org.apache.cayenne.access with parameters of type Query
    Constructor | Description
    --- | ---
    `IncrementalFaultList​(DataContext dataContext, Query query, int maxFetchSize)` | Creates a new IncrementalFaultList using a given DataContext and query.

  - ### Uses of Query in org.apache.cayenne.access.jdbc

    Methods in org.apache.cayenne.access.jdbc with parameters of type Query
    Modifier and Type | Method | Description
    --- | --- | ---
    `protected void` | BaseSQLAction.`readResultSet​(ResultSet resultSet, RowDescriptor descriptor, Query query, OperationObserver delegate)` | Helper method to process a ResultSet.

  - ### Uses of Query in org.apache.cayenne.access.translator.select

    Fields in org.apache.cayenne.access.translator.select declared as Query
    Modifier and Type | Field | Description
    --- | --- | ---
    `protected Query` | QueryAssembler.`query` |

    Methods in org.apache.cayenne.access.translator.select that return Query
    Modifier and Type | Method | Description
    --- | --- | ---
    `Query` | QueryAssembler.`getQuery()` | Returns query object being processed.

    Constructors in org.apache.cayenne.access.translator.select with parameters of type Query
    Constructor | Description
    --- | ---
    `DefaultSelectTranslator​(Query query, DbAdapter adapter, EntityResolver entityResolver)` |
    `QueryAssembler​(Query query, DbAdapter adapter, EntityResolver entityResolver)` |

  - ### Uses of Query in org.apache.cayenne.access.util

    Fields in org.apache.cayenne.access.util with type parameters of type Query
    Modifier and Type | Field | Description
    --- | --- | ---
    `protected Map<Query,​Throwable>` | DefaultOperationObserver.`queryExceptions` |

    Methods in org.apache.cayenne.access.util that return types with arguments of type Query
    Modifier and Type | Method | Description
    --- | --- | ---
    `Map<Query,​Throwable>` | DefaultOperationObserver.`getQueryExceptions()` | Returns a list of exceptions that occured during data operation run by query.

    Methods in org.apache.cayenne.access.util with parameters of type Query
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | DefaultOperationObserver.`nextBatchCount​(Query query, int[] resultCount)` |
    `void` | DoNothingOperationObserver.`nextBatchCount​(Query query, int[] resultCount)` |
    `void` | DefaultOperationObserver.`nextCount​(Query query, int resultCount)` |
    `void` | DoNothingOperationObserver.`nextCount​(Query query, int resultCount)` |
    `void` | DefaultOperationObserver.`nextGeneratedRows​(Query query, ResultIterator keys, ObjectId idToUpdate)` | Closes ResultIterator without reading its data.
    `void` | DoNothingOperationObserver.`nextGeneratedRows​(Query query, ResultIterator<?> keys, ObjectId idToUpdate)` |
    `void` | DefaultOperationObserver.`nextQueryException​(Query query, Exception ex)` |
    `void` | DoNothingOperationObserver.`nextQueryException​(Query query, Exception ex)` |
    `void` | DefaultOperationObserver.`nextRows​(Query query, List<?> dataRows)` |
    `void` | DefaultOperationObserver.`nextRows​(Query query, ResultIterator it)` | Closes ResultIterator without reading its data.
    `void` | DoNothingOperationObserver.`nextRows​(Query query, List<?> dataRows)` |
    `void` | DoNothingOperationObserver.`nextRows​(Query q, ResultIterator<?> it)` |
    `void` | IteratedSelectObserver.`nextRows​(Query query, List<?> dataRows)` |
    `void` | IteratedSelectObserver.`nextRows​(Query q, ResultIterator it)` |

  - ### Uses of Query in org.apache.cayenne.dba

    Methods in org.apache.cayenne.dba with parameters of type Query
    Modifier and Type | Method | Description
    --- | --- | ---
    `SQLAction` | AutoAdapter.`getAction​(Query query, DataNode node)` |
    `SQLAction` | DbAdapter.`getAction​(Query query, DataNode node)` | Returns an instance of SQLAction that should handle the query.
    `SQLAction` | JdbcAdapter.`getAction​(Query query, DataNode node)` | Uses JdbcActionBuilder to create the right action.

  - ### Uses of Query in org.apache.cayenne.dba.db2

    Methods in org.apache.cayenne.dba.db2 with parameters of type Query
    Modifier and Type | Method | Description
    --- | --- | ---
    `SQLAction` | DB2Adapter.`getAction​(Query query, DataNode node)` | Uses special action builder to create the right action.

  - ### Uses of Query in org.apache.cayenne.dba.hsqldb

    Methods in org.apache.cayenne.dba.hsqldb with parameters of type Query
    Modifier and Type | Method | Description
    --- | --- | ---
    `SQLAction` | HSQLDBAdapter.`getAction​(Query query, DataNode node)` | Uses special action builder to create the right action.

  - ### Uses of Query in org.apache.cayenne.dba.ingres

    Methods in org.apache.cayenne.dba.ingres with parameters of type Query
    Modifier and Type | Method | Description
    --- | --- | ---
    `SQLAction` | IngresAdapter.`getAction​(Query query, DataNode node)` |

    Constructors in org.apache.cayenne.dba.ingres with parameters of type Query
    Constructor | Description
    --- | ---
    `IngresSelectTranslator​(Query query, DbAdapter adapter, EntityResolver entityResolver)` |

  - ### Uses of Query in org.apache.cayenne.dba.mysql

    Methods in org.apache.cayenne.dba.mysql with parameters of type Query
    Modifier and Type | Method | Description
    --- | --- | ---
    `SQLAction` | MySQLAdapter.`getAction​(Query query, DataNode node)` | Uses special action builder to create the right action.

  - ### Uses of Query in org.apache.cayenne.dba.oracle

    Methods in org.apache.cayenne.dba.oracle with parameters of type Query
    Modifier and Type | Method | Description
    --- | --- | ---
    `SQLAction` | Oracle8Adapter.`getAction​(Query query, DataNode node)` | Uses OracleActionBuilder to create the right action.
    `SQLAction` | OracleAdapter.`getAction​(Query query, DataNode node)` | Uses OracleActionBuilder to create the right action.

  - ### Uses of Query in org.apache.cayenne.dba.postgres

    Methods in org.apache.cayenne.dba.postgres with parameters of type Query
    Modifier and Type | Method | Description
    --- | --- | ---
    `SQLAction` | PostgresAdapter.`getAction​(Query query, DataNode node)` | Uses PostgresActionBuilder to create the right action.

  - ### Uses of Query in org.apache.cayenne.dba.sqlite

    Methods in org.apache.cayenne.dba.sqlite with parameters of type Query
    Modifier and Type | Method | Description
    --- | --- | ---
    `SQLAction` | SQLiteAdapter.`getAction​(Query query, DataNode node)` |

  - ### Uses of Query in org.apache.cayenne.dba.sqlserver

    Methods in org.apache.cayenne.dba.sqlserver with parameters of type Query
    Modifier and Type | Method | Description
    --- | --- | ---
    `SQLAction` | SQLServerAdapter.`getAction​(Query query, DataNode node)` | Uses SQLServerActionBuilder to create the right action.

    Constructors in org.apache.cayenne.dba.sqlserver with parameters of type Query
    Constructor | Description
    --- | ---
    `SQLServerSelectTranslator​(Query query, DbAdapter adapter, EntityResolver entityResolver)` |

  - ### Uses of Query in org.apache.cayenne.dba.sybase

    Constructors in org.apache.cayenne.dba.sybase with parameters of type Query
    Constructor | Description
    --- | ---
    `SybaseSelectTranslator​(Query query, DbAdapter adapter, EntityResolver entityResolver)` |

  - ### Uses of Query in org.apache.cayenne.map

    Methods in org.apache.cayenne.map that return Query
    Modifier and Type | Method | Description
    --- | --- | ---
    `Query` | QueryDescriptor.`buildQuery()` | Assembles Cayenne query instance of appropriate type from this descriptor.

  - ### Uses of Query in org.apache.cayenne.query

    Subinterfaces of Query in org.apache.cayenne.query
    Modifier and Type | Interface | Description
    --- | --- | ---
    `interface` | `ParameterizedQuery` | Defines a query that can serve as a template for other queries.
    `interface` | `Select<T>` | A common interface for grouping together different kinds of queries that return results.

    Classes in org.apache.cayenne.query that implement Query
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `AbstractMappedQuery` |
    `class` | `AbstractQuery` | A common superclass of Cayenne queries.
    `class` | `BatchQuery` | BatchQuery and its descendants allow to group similar data for the batch database modifications, including inserts, updates and deletes.
    `class` | `CacheableQuery` | Shared functionality for cacheable queries.
    `class` | `ColumnSelect<T>` | A helper builder for queries selecting individual properties based on the root object.
    `class` | `DeleteBatchQuery` | Batched delete query.
    `class` | `EJBQLQuery` | An EJBQL query representation in Cayenne.
    `class` | `FluentSelect<T>` | Base class for `ObjectSelect` and `ColumnSelect`
    `class` | `IndirectQuery` | A base superclass for queries that resolve into some other queries during the routing phase.
    `class` | `InsertBatchQuery` | Batched INSERT query.
    `class` | `MappedExec` | A query that represents a named parameterized non selecting query stored in the mapping.
    `class` | `MappedSelect<T>` | A query that represents a named parameterized selecting query stored in the mapping.
    `class` | `ObjectIdQuery` | A query that matches zero or one object or data row corresponding to the ObjectId.
    `class` | `ObjectSelect<T>` | A selecting query providing chainable API.
    `class` | `PrefetchSelectQuery<T>` | A SelectQuery to perform a prefetch based on another query.
    `class` | `ProcedureCall<T>` | Fluent API for calling stored procedures.
    `class` | `ProcedureQuery` | A query based on Procedure.
    `class` | `QueryChain` | A Query decorator for a collection of other queries.
    `class` | `RefreshQuery` | A query that allows to explicitly clear both object and list caches either via refetch (eager refresh) or invalidate (lazy refresh).
    `class` | `RelationshipQuery` | A query that selects objects related to a given object via a mapped relationship.
    `class` | `SelectById<T>` | A query to select single objects by id.
    `class` | `SelectQuery<T>` | A query that selects persistent objects of a certain type or "raw data" (aka DataRows).
    `class` | `SQLExec` | A generic query based on raw SQL and featuring fluent API.
    `class` | `SQLSelect<T>` | A selecting query based on raw SQL and featuring fluent API.
    `class` | `SQLTemplate` | A query that executes unchanged (except for template preprocessing) "raw" SQL specified by the user.
    `class` | `UpdateBatchQuery` | Batched UPDATE query.

    Fields in org.apache.cayenne.query declared as Query
    Modifier and Type | Field | Description
    --- | --- | ---
    `protected Query` | RefreshQuery.`query` |
    `protected Query` | IndirectQuery.`replacementQuery` |

    Fields in org.apache.cayenne.query with type parameters of type Query
    Modifier and Type | Field | Description
    --- | --- | ---
    `protected Collection<Query>` | QueryChain.`chain` |

    Methods in org.apache.cayenne.query that return Query
    Modifier and Type | Method | Description
    --- | --- | ---
    `Query` | ParameterizedQuery.`createQuery​(Map<String,​?> parameters)` | Creates a new query based on current query as a template, and using a Map of named parameters.
    `Query` | ProcedureQuery.`createQuery​(Map<String,​?> parameters)` | Creates and returns a new ProcedureQuery built using this query as a prototype and substituting template parameters with the values from the map.
    `Query` | SQLTemplate.`createQuery​(Map<String,​?> parameters)` | Creates and returns a new SQLTemplate built using this query as a prototype and substituting template parameters with the values from the map.
    `protected Query` | AbstractMappedQuery.`createReplacementQuery​(EntityResolver resolver)` |
    `protected Query` | ColumnSelect.`createReplacementQuery​(EntityResolver resolver)` |
    `protected Query` | FluentSelect.`createReplacementQuery​(EntityResolver resolver)` | Translates self to a SelectQuery.
    `protected abstract Query` | IndirectQuery.`createReplacementQuery​(EntityResolver resolver)` | Creates a substitute query.
    `protected Query` | MappedSelect.`createReplacementQuery​(EntityResolver resolver)` |
    `protected Query` | ObjectIdQuery.`createReplacementQuery​(EntityResolver resolver)` |
    `protected Query` | ObjectSelect.`createReplacementQuery​(EntityResolver resolver)` | Translates self to a SelectQuery.
    `protected Query` | ProcedureCall.`createReplacementQuery​(EntityResolver resolver)` |
    `protected Query` | RelationshipQuery.`createReplacementQuery​(EntityResolver resolver)` |
    `protected Query` | SelectById.`createReplacementQuery​(EntityResolver resolver)` |
    `protected Query` | SQLExec.`createReplacementQuery​(EntityResolver resolver)` |
    `protected Query` | SQLSelect.`createReplacementQuery​(EntityResolver resolver)` |
    `Query` | QueryMetadata.`getOriginatingQuery()` | Returns a query that originated this query.
    `Query` | QueryMetadataProxy.`getOriginatingQuery()` |
    `Query` | RefreshQuery.`getQuery()` | Returns an internal query, overriding cache policy to force a refresh.
    `protected Query` | IndirectQuery.`getReplacementQuery​(EntityResolver resolver)` | Returns a replacement query, creating it on demand and caching it for reuse.

    Methods in org.apache.cayenne.query with parameters of type Query
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | QueryChain.`addQuery​(Query query)` | Adds a query to the chain.
    `boolean` | QueryChain.`removeQuery​(Query query)` | Removes a query from the chain, returning true if the query was indeed present in the chain and was removed.
    `void` | AbstractQuery.`route​(QueryRouter router, EntityResolver resolver, Query substitutedQuery)` | Implements default routing mechanism relying on the EntityResolver to find DataMap based on the query root.
    `void` | BatchQuery.`route​(QueryRouter router, EntityResolver resolver, Query substitutedQuery)` |
    `void` | EJBQLQuery.`route​(QueryRouter router, EntityResolver resolver, Query substitutedQuery)` |
    `void` | IndirectQuery.`route​(QueryRouter router, EntityResolver resolver, Query substitutedQuery)` | Delegates routing to a replacement query.
    `void` | Query.`route​(QueryRouter router, EntityResolver resolver, Query substitutedQuery)` | A callback method invoked by Cayenne during the routing phase of the query execution.
    `void` | QueryChain.`route​(QueryRouter router, EntityResolver resolver, Query substitutedQuery)` | Delegates routing to each individual query in the chain.
    `void` | QueryRouter.`route​(QueryEngine engine, Query query, Query substitutedQuery)` | A callback method that allows a query to set its preferred engine during the routing phase.
    `void` | RefreshQuery.`route​(QueryRouter router, EntityResolver resolver, Query substitutedQuery)` |
    `void` | SelectQuery.`route​(QueryRouter router, EntityResolver resolver, Query substitutedQuery)` | Routes itself and if there are any prefetches configured, creates prefetch queries and routes them as well.
    `void` | SQLTemplate.`route​(QueryRouter router, EntityResolver resolver, Query substitutedQuery)` |

    Constructors in org.apache.cayenne.query with parameters of type Query
    Constructor | Description
    --- | ---
    `QueryChain​(Query[] queries)` | Creates a new QueryChain out of an array of queries.
    `RefreshQuery​(Query query)` | Creates a RefreshQuery that refreshes results of a query and individual objects in the result.

    Constructor parameters in org.apache.cayenne.query with type arguments of type Query
    Constructor | Description
    --- | ---
    `QueryChain​(Collection<? extends Query> queries)` | Creates a new QueryChain with a collection of Queries.

  - ### Uses of Query in org.apache.cayenne.remote

    Methods in org.apache.cayenne.remote with parameters of type Query
    Modifier and Type | Method | Description
    --- | --- | ---
    `QueryResponse` | ClientChannel.`onQuery​(ObjectContext context, Query query)` |

  - ### Uses of Query in org.apache.cayenne.util

    Fields in org.apache.cayenne.util declared as Query
    Modifier and Type | Field | Description
    --- | --- | ---
    `protected Query` | ObjectContextQueryAction.`query` |

    Constructors in org.apache.cayenne.util with parameters of type Query
    Constructor | Description
    --- | ---
    `ObjectContextQueryAction​(ObjectContext actingContext, ObjectContext targetContext, Query query)` |