Google Git
Sign in
apache / cayenne-website / 0af753b3ec346c0432aa26fe6065228badfd46ed / . / docs / 3.1 / api / org / apache / cayenne / query / Query.html
blob: aca4b51061f4906446b2142e0bb3d09df6fb5053 [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 (version 1.7.0_67) on Sat Sep 20 17:22:59 FET 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Query (Cayenne Documentation 3.1 API)</title>
<meta name="date" content="2014-09-20">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Query (Cayenne Documentation 3.1 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Query.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/query/QualifiedQuery.html" title="class in org.apache.cayenne.query"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cayenne/query/QueryCacheStrategy.html" title="enum in org.apache.cayenne.query"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cayenne/query/Query.html" target="_top">Frames</a></li>
<li><a href="Query.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All 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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.cayenne.query</div>
<h2 title="Interface Query" class="title">Interface Query</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../org/apache/cayenne/configuration/ConfigurationNode.html" title="interface in org.apache.cayenne.configuration">ConfigurationNode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../org/apache/cayenne/query/ParameterizedQuery.html" title="interface in org.apache.cayenne.query">ParameterizedQuery</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</a>, <a href="../../../../org/apache/cayenne/query/BatchQuery.html" title="class in org.apache.cayenne.query">BatchQuery</a>, <a href="../../../../org/apache/cayenne/query/DeleteBatchQuery.html" title="class in org.apache.cayenne.query">DeleteBatchQuery</a>, <a href="../../../../org/apache/cayenne/query/EJBQLQuery.html" title="class in org.apache.cayenne.query">EJBQLQuery</a>, <a href="../../../../org/apache/cayenne/query/IndirectQuery.html" title="class in org.apache.cayenne.query">IndirectQuery</a>, <a href="../../../../org/apache/cayenne/query/InsertBatchQuery.html" title="class in org.apache.cayenne.query">InsertBatchQuery</a>, <a href="../../../../org/apache/cayenne/query/NamedQuery.html" title="class in org.apache.cayenne.query">NamedQuery</a>, <a href="../../../../org/apache/cayenne/query/ObjectIdQuery.html" title="class in org.apache.cayenne.query">ObjectIdQuery</a>, <a href="../../../../org/apache/cayenne/query/PrefetchSelectQuery.html" title="class in org.apache.cayenne.query">PrefetchSelectQuery</a>, <a href="../../../../org/apache/cayenne/query/ProcedureQuery.html" title="class in org.apache.cayenne.query">ProcedureQuery</a>, <a href="../../../../org/apache/cayenne/query/QualifiedQuery.html" title="class in org.apache.cayenne.query">QualifiedQuery</a>, <a href="../../../../org/apache/cayenne/query/QueryChain.html" title="class in org.apache.cayenne.query">QueryChain</a>, <a href="../../../../org/apache/cayenne/query/RefreshQuery.html" title="class in org.apache.cayenne.query">RefreshQuery</a>, <a href="../../../../org/apache/cayenne/query/RelationshipQuery.html" title="class in org.apache.cayenne.query">RelationshipQuery</a>, <a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a>, <a href="../../../../org/apache/cayenne/query/SQLTemplate.html" title="class in org.apache.cayenne.query">SQLTemplate</a>, <a href="../../../../org/apache/cayenne/query/UpdateBatchQuery.html" title="class in org.apache.cayenne.query">UpdateBatchQuery</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">Query</span>
extends <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../../org/apache/cayenne/configuration/ConfigurationNode.html" title="interface in org.apache.cayenne.configuration">ConfigurationNode</a></pre>
<div class="block">Defines minimal API of a query descriptor that is executable via Cayenne.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/Query.html#createSQLAction(org.apache.cayenne.query.SQLActionVisitor)">createSQLAction</a></strong>(<a href="../../../../org/apache/cayenne/query/SQLActionVisitor.html" title="interface in org.apache.cayenne.query">SQLActionVisitor</a>&nbsp;visitor)</code>
<div class="block">A callback method invoked by Cayenne during the final execution phase of the query
run.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/cayenne/map/DataMap.html" title="class in org.apache.cayenne.map">DataMap</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/Query.html#getDataMap()">getDataMap</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/QueryMetadata.html" title="interface in org.apache.cayenne.query">QueryMetadata</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/Query.html#getMetaData(org.apache.cayenne.map.EntityResolver)">getMetaData</a></strong>(<a href="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a>&nbsp;resolver)</code>
<div class="block">Returns query runtime parameters.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/Query.html#getName()">getName</a></strong>()</code>
<div class="block">Returns a symbolic name of the query.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/Query.html#route(org.apache.cayenne.query.QueryRouter,%20org.apache.cayenne.map.EntityResolver,%20org.apache.cayenne.query.Query)">route</a></strong>(<a href="../../../../org/apache/cayenne/query/QueryRouter.html" title="interface in org.apache.cayenne.query">QueryRouter</a>&nbsp;router,
<a href="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a>&nbsp;resolver,
<a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a>&nbsp;substitutedQuery)</code>
<div class="block">A callback method invoked by Cayenne during the routing phase of the query
execution.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.cayenne.configuration.ConfigurationNode">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.cayenne.configuration.<a href="../../../../org/apache/cayenne/configuration/ConfigurationNode.html" title="interface in org.apache.cayenne.configuration">ConfigurationNode</a></h3>
<code><a href="../../../../org/apache/cayenne/configuration/ConfigurationNode.html#acceptVisitor(org.apache.cayenne.configuration.ConfigurationNodeVisitor)">acceptVisitor</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getMetaData(org.apache.cayenne.map.EntityResolver)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetaData</h4>
<pre><a href="../../../../org/apache/cayenne/query/QueryMetadata.html" title="interface in org.apache.cayenne.query">QueryMetadata</a>&nbsp;getMetaData(<a href="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a>&nbsp;resolver)</pre>
<div class="block">Returns query runtime parameters. The method is called at various stages of the
execution by Cayenne access stack to retrieve query parameters. EntityResolver
instance is passed to this method, meaning that the query doesn't need to store
direct references to Cayenne mapping objects and can resolve them at runtime.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.2</dd></dl>
</li>
</ul>
<a name="route(org.apache.cayenne.query.QueryRouter, org.apache.cayenne.map.EntityResolver, org.apache.cayenne.query.Query)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>route</h4>
<pre>void&nbsp;route(<a href="../../../../org/apache/cayenne/query/QueryRouter.html" title="interface in org.apache.cayenne.query">QueryRouter</a>&nbsp;router,
<a href="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a>&nbsp;resolver,
<a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a>&nbsp;substitutedQuery)</pre>
<div class="block">A callback method invoked by Cayenne during the routing phase of the query
execution. Mapping of DataNodes is provided by QueryRouter. Query should use a
<a href="../../../../org/apache/cayenne/query/QueryRouter.html#route(org.apache.cayenne.access.QueryEngine,%20org.apache.cayenne.query.Query,%20org.apache.cayenne.query.Query)"><code>QueryRouter.route(QueryEngine, Query, Query)</code></a> callback method to route
itself. Query can create one or more substitute queries or even provide its own
QueryEngine to execute itself.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.2</dd></dl>
</li>
</ul>
<a name="createSQLAction(org.apache.cayenne.query.SQLActionVisitor)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSQLAction</h4>
<pre><a href="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</a>&nbsp;createSQLAction(<a href="../../../../org/apache/cayenne/query/SQLActionVisitor.html" title="interface in org.apache.cayenne.query">SQLActionVisitor</a>&nbsp;visitor)</pre>
<div class="block">A callback method invoked by Cayenne during the final execution phase of the query
run. A concrete query implementation is given a chance to decide how it should be
handled. Implementors can pick an appropriate method of the SQLActionVisitor to
handle itself, create a custom SQLAction of its own, or substitute itself with
another query that should be used for SQLAction construction.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.2</dd></dl>
</li>
</ul>
<a name="getName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getName()</pre>
<div class="block">Returns a symbolic name of the query. The name is normally used as a key to find
queries stored in the DataMap.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.1</dd></dl>
</li>
</ul>
<a name="getDataMap()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getDataMap</h4>
<pre><a href="../../../../org/apache/cayenne/map/DataMap.html" title="class in org.apache.cayenne.map">DataMap</a>&nbsp;getDataMap()</pre>
<dl><dt><span class="strong">Since:</span></dt>
<dd>3.1</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Query.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/query/QualifiedQuery.html" title="class in org.apache.cayenne.query"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cayenne/query/QueryCacheStrategy.html" title="enum in org.apache.cayenne.query"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cayenne/query/Query.html" target="_top">Frames</a></li>
<li><a href="Query.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All 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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2001&#x2013;2014 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p>
</body>
</html>