Google Git
Sign in
apache / cayenne-website / 017cf03748c43ba409f0544b0c0a0f42b7e1cddc / . / src / main / site / static / docs / 4.0 / api / org / apache / cayenne / query / package-summary.html
blob: 0e631c34f8b18d14d55bfacf184ce36db586231b [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_112) on Mon Oct 14 11:36:20 MSK 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.cayenne.query (cayenne-doc: Cayenne Documentation 4.0.2 API)</title>
<meta name="date" content="2019-10-14">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.cayenne.query (cayenne-doc: Cayenne Documentation 4.0.2 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/cayenne/map/event/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/cayenne/reflect/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cayenne/query/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.cayenne.query</h1>
<div class="docSummary">
<div class="block">Defines standard queries supported by Cayenne and extension mechanism to create
custom queries.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/EntityResultSegment.html" title="interface in org.apache.cayenne.query">EntityResultSegment</a></td>
<td class="colLast">
<div class="block">A "compiled" version of a <a href="../../../../org/apache/cayenne/map/EntityResult.html" title="class in org.apache.cayenne.map"><code>EntityResult</code></a> descriptor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/ParameterizedQuery.html" title="interface in org.apache.cayenne.query">ParameterizedQuery</a></td>
<td class="colLast">
<div class="block">Defines a query that can serve as a template for other queries.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/PrefetchProcessor.html" title="interface in org.apache.cayenne.query">PrefetchProcessor</a></td>
<td class="colLast">
<div class="block">A hierarchical visitor interface for traversing a tree of PrefetchTreeNodes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a></td>
<td class="colLast">
<div class="block">Defines minimal API of a query descriptor that is executable via Cayenne.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/QueryMetadata.html" title="interface in org.apache.cayenne.query">QueryMetadata</a></td>
<td class="colLast">
<div class="block">Provides a common interface for accessing query metadata.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/QueryRouter.html" title="interface in org.apache.cayenne.query">QueryRouter</a></td>
<td class="colLast">
<div class="block">An interface used by Queries to route themselves to an appropriate QueryEngine.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/ScalarResultSegment.html" title="interface in org.apache.cayenne.query">ScalarResultSegment</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/Select.html" title="interface in org.apache.cayenne.query">Select</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A common interface for grouping together different kinds of queries that
return results.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</a></td>
<td class="colLast">
<div class="block">Defines API for query execution strategy over JDBC connection (as in Strategy Pattern).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/SQLActionVisitor.html" title="interface in org.apache.cayenne.query">SQLActionVisitor</a></td>
<td class="colLast">
<div class="block">A factory interface to create standard SQLActions for a set of standard queries.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/AbstractMappedQuery.html" title="class in org.apache.cayenne.query">AbstractMappedQuery</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</a></td>
<td class="colLast">
<div class="block">A common superclass of Cayenne queries.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/BatchQuery.html" title="class in org.apache.cayenne.query">BatchQuery</a></td>
<td class="colLast">
<div class="block">BatchQuery and its descendants allow to group similar data for the batch
database modifications, including inserts, updates and deletes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/BatchQueryRow.html" title="class in org.apache.cayenne.query">BatchQueryRow</a></td>
<td class="colLast">
<div class="block">Represents a single row of values in a BatchQuery.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/CacheableQuery.html" title="class in org.apache.cayenne.query">CacheableQuery</a></td>
<td class="colLast">
<div class="block">Shared functionality for cacheable queries.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/ColumnSelect.html" title="class in org.apache.cayenne.query">ColumnSelect</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A helper builder for queries selecting individual properties based on the root object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/DeleteBatchQuery.html" title="class in org.apache.cayenne.query">DeleteBatchQuery</a></td>
<td class="colLast">
<div class="block">Batched delete query.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/EJBQLQuery.html" title="class in org.apache.cayenne.query">EJBQLQuery</a></td>
<td class="colLast">
<div class="block">An EJBQL query representation in Cayenne.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/FluentSelect.html" title="class in org.apache.cayenne.query">FluentSelect</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Base class for <a href="../../../../org/apache/cayenne/query/ObjectSelect.html" title="class in org.apache.cayenne.query"><code>ObjectSelect</code></a> and <a href="../../../../org/apache/cayenne/query/ColumnSelect.html" title="class in org.apache.cayenne.query"><code>ColumnSelect</code></a></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/IndirectQuery.html" title="class in org.apache.cayenne.query">IndirectQuery</a></td>
<td class="colLast">
<div class="block">A base superclass for queries that resolve into some other queries during the
routing phase.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/InsertBatchQuery.html" title="class in org.apache.cayenne.query">InsertBatchQuery</a></td>
<td class="colLast">
<div class="block">Batched INSERT query.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/MappedExec.html" title="class in org.apache.cayenne.query">MappedExec</a></td>
<td class="colLast">
<div class="block">A query that represents a named parameterized non selecting query stored in the mapping.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A query that represents a named parameterized selecting query stored in the mapping.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/NamedQuery.html" title="class in org.apache.cayenne.query">NamedQuery</a></td>
<td class="colLast">Deprecated
<div class="block"><span class="deprecationComment">since 4.0 you should use <a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="class in org.apache.cayenne.query"><code>MappedSelect</code></a> or <a href="../../../../org/apache/cayenne/query/MappedExec.html" title="class in org.apache.cayenne.query"><code>MappedExec</code></a> instead.</span></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/ObjectIdQuery.html" title="class in org.apache.cayenne.query">ObjectIdQuery</a></td>
<td class="colLast">
<div class="block">A query that matches zero or one object or data row corresponding to the ObjectId.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/ObjectSelect.html" title="class in org.apache.cayenne.query">ObjectSelect</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A selecting query providing chainable API.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a></td>
<td class="colLast">
<div class="block">Defines object sorting criteria, used either for in-memory sorting of object
lists or as a specification for building <em>ORDER BY</em> clause of a
SelectQuery query.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/PrefetchSelectQuery.html" title="class in org.apache.cayenne.query">PrefetchSelectQuery</a></td>
<td class="colLast">
<div class="block">A SelectQuery to perform a prefetch based on another query.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a></td>
<td class="colLast">
<div class="block">Defines a node in a prefetch tree.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/ProcedureCall.html" title="class in org.apache.cayenne.query">ProcedureCall</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Fluent API for calling stored procedures.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/ProcedureQuery.html" title="class in org.apache.cayenne.query">ProcedureQuery</a></td>
<td class="colLast">
<div class="block">A query based on Procedure.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/QueryChain.html" title="class in org.apache.cayenne.query">QueryChain</a></td>
<td class="colLast">
<div class="block">A Query decorator for a collection of other queries.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/QueryMetadataProxy.html" title="class in org.apache.cayenne.query">QueryMetadataProxy</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/RefreshQuery.html" title="class in org.apache.cayenne.query">RefreshQuery</a></td>
<td class="colLast">
<div class="block">A query that allows to explicitly clear both object and list caches either via refetch
(eager refresh) or invalidate (lazy refresh).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/RelationshipQuery.html" title="class in org.apache.cayenne.query">RelationshipQuery</a></td>
<td class="colLast">
<div class="block">A query that selects objects related to a given object via a mapped relationship.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/SelectById.html" title="class in org.apache.cayenne.query">SelectById</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A query to select single objects by id.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A query that selects persistent objects of a certain type or "raw data" (aka
DataRows).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/SQLExec.html" title="class in org.apache.cayenne.query">SQLExec</a></td>
<td class="colLast">
<div class="block">A generic query based on raw SQL and featuring fluent API.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/SQLSelect.html" title="class in org.apache.cayenne.query">SQLSelect</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A selecting query based on raw SQL and featuring fluent API.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/SQLTemplate.html" title="class in org.apache.cayenne.query">SQLTemplate</a></td>
<td class="colLast">
<div class="block">A query that executes unchanged (except for template preprocessing) "raw" SQL
specified by the user.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/UpdateBatchQuery.html" title="class in org.apache.cayenne.query">UpdateBatchQuery</a></td>
<td class="colLast">
<div class="block">Batched UPDATE query.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/CapsStrategy.html" title="enum in org.apache.cayenne.query">CapsStrategy</a></td>
<td class="colLast">
<div class="block">Defines forced capitalization of the result column names in the DataRow.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/QueryCacheStrategy.html" title="enum in org.apache.cayenne.query">QueryCacheStrategy</a></td>
<td class="colLast">
<div class="block">Defines query result caching policy.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/cayenne/query/SortOrder.html" title="enum in org.apache.cayenne.query">SortOrder</a></td>
<td class="colLast">
<div class="block">Constants to order query results (the ORDER BY clause).</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.cayenne.query Description">Package org.apache.cayenne.query Description</h2>
<div class="block">Defines standard queries supported by Cayenne and extension mechanism to create
custom queries. Many of the queries in this package are used by the framework internally.
Normally users would only care about these general query classes:
<ul>
<li>SelectQuery</li>
<li>SQLTemplate</li>
<li>ProcedureQuery</li>
</ul>
and sometimes - these specialized queries:
<ul>
<li>QueryChain</li>
<li>RelationshipQuery</li>
<li>SingleObjectQuery</li>
</ul>
<p>Cayenne can "execute" any object as a query as long as it implements
Query interface and provides meaningful implementation of either <em>Query.route(...)</em>
and/or
<em>Query.createSQLAction(SQLActionVisitor)}</em> methods.
So users can extend/customize queries if they need to. Custom implementations would
normally either create a query from a standard Cayenne set
and delegate the execution to it (acting as a sort of "query builder"),
or can implement its own non-standard SQLAction.</p></div>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/cayenne/map/event/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/cayenne/reflect/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cayenne/query/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2001&#x2013;2019 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p>
</body>
</html>