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.configuration | |
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.frontbase |
FrontBase DbAdapter.
|
org.apache.cayenne.dba.hsqldb |
HSQLDB DbAdapter.
|
org.apache.cayenne.dba.ingres | |
org.apache.cayenne.dba.mysql |
MySQL DbAdapter.
|
org.apache.cayenne.dba.openbase |
OpenBase 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.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 | |
org.apache.cayenne.util |
General utility classes.
|
Modifier and Type | Method and Description |
---|---|
static Object |
Cayenne.objectForQuery(ObjectContext context,
Query query)
Returns an object or a DataRow that is a result of a given query.
|
QueryResponse |
DataChannelFilterChain.onQuery(ObjectContext originatingContext,
Query query) |
QueryResponse |
DataChannel.onQuery(ObjectContext originatingContext,
Query query)
Executes a query, using provided context to register persistent objects if
query returns any objects.
|
QueryResponse |
CayenneContext.onQuery(ObjectContext context,
Query query) |
QueryResponse |
DataChannelFilter.onQuery(ObjectContext originatingContext,
Query query,
DataChannelFilterChain filterChain) |
QueryResponse |
ObjectContext.performGenericQuery(Query query)
Executes any kind of query providing the result in a form of
QueryResponse.
|
QueryResponse |
CayenneContext.performGenericQuery(Query query) |
abstract QueryResponse |
BaseContext.performGenericQuery(Query query) |
List |
ObjectContext.performQuery(Query query)
Executes a selecting query, returning a list of persistent objects or
data rows.
|
List |
CayenneContext.performQuery(Query query)
Runs a query, returning result as list.
|
abstract List |
BaseContext.performQuery(Query query) |
Modifier and Type | Method and Description |
---|---|
Query |
DataPortDelegate.willCleanData(DataPort portTool,
DbEntity entity,
Query query)
Deprecated.
Invoked by DataPort right before the start of data cleanup for a given entity.
|
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.
|
Query |
DataPortDelegate.willPortEntity(DataPort portTool,
DbEntity entity,
Query query)
Deprecated.
Invoked by DataPort right before the start of data port for a given entity.
|
Modifier and Type | Method and Description |
---|---|
protected void |
IncrementalFaultList.fillIn(Query query,
List 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 |
DataDomain.onQuery(ObjectContext originatingContext,
Query query)
Runs query returning generic QueryResponse.
|
QueryResponse |
DataContext.onQuery(ObjectContext context,
Query query)
An implementation of a
DataChannel method that is used by child
contexts to execute queries. |
QueryResponse |
ClientServerChannel.onQuery(ObjectContext context,
Query query) |
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 |
DataPortDelegate.willCleanData(DataPort portTool,
DbEntity entity,
Query query)
Deprecated.
Invoked by DataPort right before the start of data cleanup for a given entity.
|
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.
|
Query |
DataPortDelegate.willPortEntity(DataPort portTool,
DbEntity entity,
Query query)
Deprecated.
Invoked by DataPort right before the start of data port for a given entity.
|
Modifier and Type | Method and Description |
---|---|
void |
QueryEngine.performQueries(Collection<? extends Query> queries,
OperationObserver resultConsumer)
Executes a list of queries wrapping them in its own transaction.
|
void |
DataNode.performQueries(Collection<? extends Query> queries,
OperationObserver callback)
Runs queries using Connection obtained from internal DataSource.
|
void |
DataDomain.performQueries(Collection<? extends Query> queries,
OperationObserver callback)
Routes queries to appropriate DataNodes for execution.
|
Constructor and Description |
---|
IncrementalFaultList(DataContext dataContext,
Query query,
int maxFetchSize)
Creates a new IncrementalFaultList using a given DataContext and query.
|
Modifier and Type | Method and Description |
---|---|
protected void |
BaseSQLAction.readResultSet(ResultSet resultSet,
RowDescriptor descriptor,
Query query,
OperationObserver delegate)
Helper method to process a ResultSet.
|
Modifier and Type | Field and Description |
---|---|
protected Query |
QueryAssembler.query |
Modifier and Type | Method and Description |
---|---|
Query |
QueryAssembler.getQuery()
Returns query object being processed.
|
Constructor and Description |
---|
QueryAssembler(Query query,
DataNode dataNode,
Connection connection) |
SelectTranslator(Query query,
DataNode dataNode,
Connection connection) |
Modifier and Type | Field and Description |
---|---|
protected Map<Query,Throwable> |
DefaultOperationObserver.queryExceptions |
Modifier and Type | Method and Description |
---|---|
Map<Query,Throwable> |
DefaultOperationObserver.getQueryExceptions()
Returns a list of exceptions that occured during data operation run by
query.
|
Modifier and Type | Method and Description |
---|---|
void |
DoNothingOperationObserver.nextBatchCount(Query query,
int[] resultCount) |
void |
DefaultOperationObserver.nextBatchCount(Query query,
int[] resultCount) |
void |
DoNothingOperationObserver.nextCount(Query query,
int resultCount) |
void |
DefaultOperationObserver.nextCount(Query query,
int resultCount) |
void |
DoNothingOperationObserver.nextGeneratedRows(Query query,
ResultIterator<?> keys,
ObjectId idToUpdate) |
void |
DefaultOperationObserver.nextGeneratedRows(Query query,
ResultIterator keys,
ObjectId idToUpdate)
Closes ResultIterator without reading its data.
|
void |
DoNothingOperationObserver.nextQueryException(Query query,
Exception ex) |
void |
DefaultOperationObserver.nextQueryException(Query query,
Exception ex) |
void |
IteratedSelectObserver.nextRows(Query query,
List<?> dataRows) |
void |
DoNothingOperationObserver.nextRows(Query query,
List<?> dataRows) |
void |
DefaultOperationObserver.nextRows(Query query,
List<?> dataRows) |
void |
IteratedSelectObserver.nextRows(Query q,
ResultIterator it) |
void |
DefaultOperationObserver.nextRows(Query query,
ResultIterator it)
Closes ResultIterator without reading its data.
|
void |
DoNothingOperationObserver.nextRows(Query q,
ResultIterator<?> it) |
Modifier and Type | Method and Description |
---|---|
T |
ConfigurationNodeVisitor.visitQuery(Query query) |
T |
BaseConfigurationNodeVisitor.visitQuery(Query query) |
Modifier and Type | Method and Description |
---|---|
SQLAction |
JdbcAdapter.getAction(Query query,
DataNode node)
Uses JdbcActionBuilder to create the right action.
|
SQLAction |
DbAdapter.getAction(Query query,
DataNode node)
Returns an instance of SQLAction that should handle the query.
|
SQLAction |
AutoAdapter.getAction(Query query,
DataNode node) |
Modifier and Type | Method and Description |
---|---|
SQLAction |
DB2Adapter.getAction(Query query,
DataNode node)
Uses special action builder to create the right action.
|
Modifier and Type | Method and Description |
---|---|
SQLAction |
FrontBaseAdapter.getAction(Query query,
DataNode node)
Uses special action builder to create the right action.
|
Modifier and Type | Method and Description |
---|---|
SQLAction |
HSQLDBAdapter.getAction(Query query,
DataNode node)
Uses special action builder to create the right action.
|
Modifier and Type | Method and Description |
---|---|
SQLAction |
IngresAdapter.getAction(Query query,
DataNode node) |
Constructor and Description |
---|
IngresSelectTranslator(Query query,
DataNode dataNode,
Connection connection) |
Modifier and Type | Method and Description |
---|---|
SQLAction |
MySQLAdapter.getAction(Query query,
DataNode node)
Uses special action builder to create the right action.
|
Modifier and Type | Method and Description |
---|---|
SQLAction |
OpenBaseAdapter.getAction(Query query,
DataNode node)
Uses special action builder to create the right action.
|
Modifier and Type | Method and Description |
---|---|
SQLAction |
OracleAdapter.getAction(Query query,
DataNode node)
Uses OracleActionBuilder to create the right action.
|
SQLAction |
Oracle8Adapter.getAction(Query query,
DataNode node)
Uses OracleActionBuilder to create the right action.
|
Modifier and Type | Method and Description |
---|---|
SQLAction |
PostgresAdapter.getAction(Query query,
DataNode node)
Uses PostgresActionBuilder to create the right action.
|
Modifier and Type | Method and Description |
---|---|
SQLAction |
SQLiteAdapter.getAction(Query query,
DataNode node) |
Modifier and Type | Method and Description |
---|---|
SQLAction |
SQLServerAdapter.getAction(Query query,
DataNode node)
Uses SQLServerActionBuilder to create the right action.
|
Constructor and Description |
---|
SQLServerSelectTranslator(Query query,
DataNode dataNode,
Connection connection) |
Modifier and Type | Method and Description |
---|---|
Query |
MappingNamespace.getQuery(String name)
Returns Query for a given name, or null if no such Query is found in the
MappingNamespace.
|
Query |
EntityResolver.getQuery(String name)
Returns a named query or null if no query exists for a given name.
|
Query |
DataMap.getQuery(String queryName)
Returns a named query associated with this DataMap.
|
Query |
EntityResolver.lookupQuery(String name)
Deprecated.
since 4.0 use
EntityResolver.getQuery(String) . |
Modifier and Type | Method and Description |
---|---|
Collection<Query> |
MappingNamespace.getQueries()
Returns all Queries in the namespace.
|
Collection<Query> |
EntityResolver.getQueries() |
Collection<Query> |
DataMap.getQueries()
Returns an unmodifiable collection of mapped queries.
|
SortedMap<String,Query> |
DataMap.getQueryMap() |
Modifier and Type | Method and Description |
---|---|
void |
DataMap.addQuery(Query query)
Stores a query under its name.
|
Procedure |
EntityResolver.lookupProcedure(Query q)
Deprecated.
since 4.0. Use q.getMetaData(resolver).getProcedure()
|
Modifier and Type | Interface and 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.
|
Modifier and Type | Class and Description |
---|---|
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 |
DeleteBatchQuery
Batched delete query.
|
class |
EJBQLQuery
An EJBQL query representation in Cayenne.
|
class |
IndirectQuery
A base superclass for queries that resolve into some other queries during the
routing phase.
|
class |
InsertBatchQuery
Batched INSERT query.
|
class |
NamedQuery
A query that is a reference to a named parameterized 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
A SelectQuery to perform a prefetch based on another query.
|
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 |
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.
|
Modifier and Type | Field and Description |
---|---|
protected Query |
RefreshQuery.query |
protected Query |
IndirectQuery.replacementQuery |
Modifier and Type | Field and Description |
---|---|
protected Collection<Query> |
QueryChain.chain |
Modifier and Type | Method and Description |
---|---|
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.
|
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 |
ParameterizedQuery.createQuery(Map<String,?> parameters)
Creates a new query based on current query as a template, and using a Map of named
parameters.
|
protected Query |
SQLSelect.createReplacementQuery(EntityResolver resolver) |
protected Query |
SelectById.createReplacementQuery(EntityResolver resolver) |
protected Query |
RelationshipQuery.createReplacementQuery(EntityResolver resolver) |
protected Query |
ObjectSelect.createReplacementQuery(EntityResolver resolver)
Translates self to a SelectQuery.
|
protected Query |
ObjectIdQuery.createReplacementQuery(EntityResolver resolver) |
protected Query |
NamedQuery.createReplacementQuery(EntityResolver resolver) |
protected abstract Query |
IndirectQuery.createReplacementQuery(EntityResolver resolver)
Creates a substitute query.
|
Query |
QueryMetadata.getOrginatingQuery()
Returns a query that originated this query.
|
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.
|
protected Query |
NamedQuery.resolveQuery(EntityResolver resolver)
Returns a query for name, throwing an exception if such query is not mapped in the
EntityResolver.
|
Modifier and Type | Method and 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 |
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 |
SQLTemplate.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 |
RefreshQuery.route(QueryRouter router,
EntityResolver resolver,
Query substitutedQuery) |
void |
QueryChain.route(QueryRouter router,
EntityResolver resolver,
Query substitutedQuery)
Delegates routing to each individual query in the chain.
|
void |
Query.route(QueryRouter router,
EntityResolver resolver,
Query substitutedQuery)
A callback method invoked by Cayenne during the routing phase of the query
execution.
|
void |
IndirectQuery.route(QueryRouter router,
EntityResolver resolver,
Query substitutedQuery)
Delegates routing to a replacement query.
|
void |
EJBQLQuery.route(QueryRouter router,
EntityResolver resolver,
Query substitutedQuery) |
void |
BatchQuery.route(QueryRouter router,
EntityResolver resolver,
Query substitutedQuery) |
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.
|
Constructor and 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 and Description |
---|
QueryChain(Collection<? extends Query> queries)
Creates a new QueryChain with a collection of Queries.
|
Modifier and Type | Field and Description |
---|---|
protected Query |
RemoteIncrementalFaultList.paginatedQuery |
protected Query |
QueryMessage.query |
Modifier and Type | Method and Description |
---|---|
Query |
QueryMessage.getQuery() |
Constructor and Description |
---|
QueryMessage(Query query) |
RemoteIncrementalFaultList(ObjectContext context,
Query paginatedQuery) |
Modifier and Type | Field and Description |
---|---|
protected Query |
ObjectContextQueryAction.query |
Constructor and Description |
---|
ObjectContextQueryAction(ObjectContext actingContext,
ObjectContext targetContext,
Query query) |
Copyright © 2001–2015 Apache Cayenne. All rights reserved.