| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.2) on Mon Mar 18 14:01:21 MSK 2019 --> |
| <title>Query (cayenne-doc: Cayenne Documentation 4.1.B1 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2019-03-18"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Query (cayenne-doc: Cayenne Documentation 4.1.B1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.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 class="aboutLanguage"><a href="http://cayenne.apache.org" target="top">Apache Cayenne</a></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.cayenne.query</a></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><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="ParameterizedQuery.html" title="interface in org.apache.cayenne.query">ParameterizedQuery</a></code>, <code><a href="Select.html" title="interface in org.apache.cayenne.query">Select</a><T></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="AbstractMappedQuery.html" title="class in org.apache.cayenne.query">AbstractMappedQuery</a></code>, <code><a href="AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</a></code>, <code><a href="BatchQuery.html" title="class in org.apache.cayenne.query">BatchQuery</a></code>, <code><a href="CacheableQuery.html" title="class in org.apache.cayenne.query">CacheableQuery</a></code>, <code><a href="ColumnSelect.html" title="class in org.apache.cayenne.query">ColumnSelect</a></code>, <code><a href="DeleteBatchQuery.html" title="class in org.apache.cayenne.query">DeleteBatchQuery</a></code>, <code><a href="EJBQLQuery.html" title="class in org.apache.cayenne.query">EJBQLQuery</a></code>, <code><a href="FluentSelect.html" title="class in org.apache.cayenne.query">FluentSelect</a></code>, <code><a href="IndirectQuery.html" title="class in org.apache.cayenne.query">IndirectQuery</a></code>, <code><a href="InsertBatchQuery.html" title="class in org.apache.cayenne.query">InsertBatchQuery</a></code>, <code><a href="MappedExec.html" title="class in org.apache.cayenne.query">MappedExec</a></code>, <code><a href="MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a></code>, <code><a href="ObjectIdQuery.html" title="class in org.apache.cayenne.query">ObjectIdQuery</a></code>, <code><a href="ObjectSelect.html" title="class in org.apache.cayenne.query">ObjectSelect</a></code>, <code><a href="PrefetchSelectQuery.html" title="class in org.apache.cayenne.query">PrefetchSelectQuery</a></code>, <code><a href="ProcedureCall.html" title="class in org.apache.cayenne.query">ProcedureCall</a></code>, <code><a href="ProcedureQuery.html" title="class in org.apache.cayenne.query">ProcedureQuery</a></code>, <code><a href="QueryChain.html" title="class in org.apache.cayenne.query">QueryChain</a></code>, <code><a href="RefreshQuery.html" title="class in org.apache.cayenne.query">RefreshQuery</a></code>, <code><a href="RelationshipQuery.html" title="class in org.apache.cayenne.query">RelationshipQuery</a></code>, <code><a href="SelectById.html" title="class in org.apache.cayenne.query">SelectById</a></code>, <code><a href="SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a></code>, <code><a href="SQLExec.html" title="class in org.apache.cayenne.query">SQLExec</a></code>, <code><a href="SQLSelect.html" title="class in org.apache.cayenne.query">SQLSelect</a></code>, <code><a href="SQLTemplate.html" title="class in org.apache.cayenne.query">SQLTemplate</a></code>, <code><a href="UpdateBatchQuery.html" title="class in org.apache.cayenne.query">UpdateBatchQuery</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">Query</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</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 =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createSQLAction(org.apache.cayenne.query.SQLActionVisitor)">createSQLAction</a></span>​(<a href="SQLActionVisitor.html" title="interface in org.apache.cayenne.query">SQLActionVisitor</a> visitor)</code></th> |
| <td class="colLast"> |
| <div class="block">A callback method invoked by Cayenne during the final execution phase of the query |
| run.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="QueryMetadata.html" title="interface in org.apache.cayenne.query">QueryMetadata</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMetaData(org.apache.cayenne.map.EntityResolver)">getMetaData</a></span>​(<a href="../map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a> resolver)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns query runtime parameters.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#route(org.apache.cayenne.query.QueryRouter,org.apache.cayenne.map.EntityResolver,org.apache.cayenne.query.Query)">route</a></span>​(<a href="QueryRouter.html" title="interface in org.apache.cayenne.query">QueryRouter</a> router, |
| <a href="../map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a> resolver, |
| <a href="Query.html" title="interface in org.apache.cayenne.query">Query</a> substitutedQuery)</code></th> |
| <td class="colLast"> |
| <div class="block">A callback method invoked by Cayenne during the routing phase of the query |
| execution.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getMetaData(org.apache.cayenne.map.EntityResolver)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMetaData</h4> |
| <pre class="methodSignature"><a href="QueryMetadata.html" title="interface in org.apache.cayenne.query">QueryMetadata</a> getMetaData​(<a href="../map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a> 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="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="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 class="methodSignature">void route​(<a href="QueryRouter.html" title="interface in org.apache.cayenne.query">QueryRouter</a> router, |
| <a href="../map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a> resolver, |
| <a href="Query.html" title="interface in org.apache.cayenne.query">Query</a> 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="QueryRouter.html#route(org.apache.cayenne.access.QueryEngine,org.apache.cayenne.query.Query,org.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="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createSQLAction(org.apache.cayenne.query.SQLActionVisitor)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>createSQLAction</h4> |
| <pre class="methodSignature"><a href="SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</a> createSQLAction​(<a href="SQLActionVisitor.html" title="interface in org.apache.cayenne.query">SQLActionVisitor</a> 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="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.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 class="aboutLanguage"><a href="http://cayenne.apache.org" target="top">Apache Cayenne</a></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2001–2019 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |