| <!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:14 MSK 2019 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Select (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="Select (cayenne-doc: Cayenne Documentation 4.0.2 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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"; |
| </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><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Select.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/ScalarResultSegment.html" title="interface in org.apache.cayenne.query"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/cayenne/query/SelectById.html" title="class in org.apache.cayenne.query"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/cayenne/query/Select.html" target="_top">Frames</a></li> |
| <li><a href="Select.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: </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 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 Select" class="title">Interface Select<T></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/query/Query.html" title="interface in org.apache.cayenne.query">Query</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/cayenne/query/ColumnSelect.html" title="class in org.apache.cayenne.query">ColumnSelect</a>, <a href="../../../../org/apache/cayenne/query/FluentSelect.html" title="class in org.apache.cayenne.query">FluentSelect</a>, <a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a>, <a href="../../../../org/apache/cayenne/query/ObjectSelect.html" title="class in org.apache.cayenne.query">ObjectSelect</a>, <a href="../../../../org/apache/cayenne/query/PrefetchSelectQuery.html" title="class in org.apache.cayenne.query">PrefetchSelectQuery</a>, <a href="../../../../org/apache/cayenne/query/SelectById.html" title="class in org.apache.cayenne.query">SelectById</a>, <a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a>, <a href="../../../../org/apache/cayenne/query/SQLSelect.html" title="class in org.apache.cayenne.query">SQLSelect</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Select<T></span> |
| extends <a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a></pre> |
| <div class="block">A common interface for grouping together different kinds of queries that |
| return results.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <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="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/ResultBatchIterator.html" title="class in org.apache.cayenne">ResultBatchIterator</a><<a href="../../../../org/apache/cayenne/query/Select.html" title="type parameter in Select">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/Select.html#batchIterator-org.apache.cayenne.ObjectContext-int-">batchIterator</a></span>(<a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context, |
| int size)</code> |
| <div class="block">Creates a ResultBatchIterator based on the provided context and batch |
| size.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/Select.html#iterate-org.apache.cayenne.ObjectContext-org.apache.cayenne.ResultIteratorCallback-">iterate</a></span>(<a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context, |
| <a href="../../../../org/apache/cayenne/ResultIteratorCallback.html" title="interface in org.apache.cayenne">ResultIteratorCallback</a><<a href="../../../../org/apache/cayenne/query/Select.html" title="type parameter in Select">T</a>> callback)</code> |
| <div class="block">Creates a ResultIterator based on the provided context and passes it to a |
| callback for processing.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/ResultIterator.html" title="interface in org.apache.cayenne">ResultIterator</a><<a href="../../../../org/apache/cayenne/query/Select.html" title="type parameter in Select">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/Select.html#iterator-org.apache.cayenne.ObjectContext-">iterator</a></span>(<a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context)</code> |
| <div class="block">Creates a ResultIterator based on the provided context.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/cayenne/query/Select.html" title="type parameter in Select">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/Select.html#select-org.apache.cayenne.ObjectContext-">select</a></span>(<a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context)</code> |
| <div class="block">Selects objects using provided context.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/Select.html" title="type parameter in Select">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/Select.html#selectFirst-org.apache.cayenne.ObjectContext-">selectFirst</a></span>(<a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context)</code> |
| <div class="block">Selects a single object using provided context.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/Select.html" title="type parameter in Select">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/Select.html#selectOne-org.apache.cayenne.ObjectContext-">selectOne</a></span>(<a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context)</code> |
| <div class="block">Selects a single object using provided context.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.cayenne.query.Query"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.cayenne.query.<a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a></h3> |
| <code><a href="../../../../org/apache/cayenne/query/Query.html#createSQLAction-org.apache.cayenne.query.SQLActionVisitor-">createSQLAction</a>, <a href="../../../../org/apache/cayenne/query/Query.html#getDataMap--">getDataMap</a>, <a href="../../../../org/apache/cayenne/query/Query.html#getMetaData-org.apache.cayenne.map.EntityResolver-">getMetaData</a>, <a href="../../../../org/apache/cayenne/query/Query.html#getName--">getName</a>, <a href="../../../../org/apache/cayenne/query/Query.html#route-org.apache.cayenne.query.QueryRouter-org.apache.cayenne.map.EntityResolver-org.apache.cayenne.query.Query-">route</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="select-org.apache.cayenne.ObjectContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>select</h4> |
| <pre><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/cayenne/query/Select.html" title="type parameter in Select">T</a>> select(<a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context)</pre> |
| <div class="block">Selects objects using provided context. |
| <p> |
| Essentially the inversion of "ObjectContext.select(Select)".</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="selectOne-org.apache.cayenne.ObjectContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>selectOne</h4> |
| <pre><a href="../../../../org/apache/cayenne/query/Select.html" title="type parameter in Select">T</a> selectOne(<a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context)</pre> |
| <div class="block">Selects a single object using provided context. The query is expected to |
| match zero or one object. It returns null if no objects were matched. If |
| query matched more than one object, |
| <a href="../../../../org/apache/cayenne/CayenneRuntimeException.html" title="class in org.apache.cayenne"><code>CayenneRuntimeException</code></a> is thrown. |
| <p> |
| Essentially the inversion of "ObjectContext.selectOne(Select)".</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="selectFirst-org.apache.cayenne.ObjectContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>selectFirst</h4> |
| <pre><a href="../../../../org/apache/cayenne/query/Select.html" title="type parameter in Select">T</a> selectFirst(<a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context)</pre> |
| <div class="block">Selects a single object using provided context. The query itself can |
| match any number of objects, but will return only the first one. It |
| returns null if no objects were matched. |
| <p> |
| If it matched more than one object, the first object from the list is |
| returned. This makes 'selectFirst' different from |
| <a href="../../../../org/apache/cayenne/query/Select.html#selectOne-org.apache.cayenne.ObjectContext-"><code>selectOne(ObjectContext)</code></a>, which would throw in this situation. |
| 'selectFirst' is useful e.g. when the query is ordered and we only want |
| to see the first object (e.g. "most recent news article"), etc. |
| <p> |
| Selecting the first object via "Select.selectFirst(ObjectContext)" is |
| more comprehensible than selecting via |
| "ObjectContext.selectFirst(Select)", because implementations of "Select" |
| set fetch size limit to one.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="iterate-org.apache.cayenne.ObjectContext-org.apache.cayenne.ResultIteratorCallback-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>iterate</h4> |
| <pre>void iterate(<a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context, |
| <a href="../../../../org/apache/cayenne/ResultIteratorCallback.html" title="interface in org.apache.cayenne">ResultIteratorCallback</a><<a href="../../../../org/apache/cayenne/query/Select.html" title="type parameter in Select">T</a>> callback)</pre> |
| <div class="block">Creates a ResultIterator based on the provided context and passes it to a |
| callback for processing. The caller does not need to worry about closing |
| the iterator. This method takes care of it. |
| <p> |
| Essentially the inversion of |
| "ObjectContext.iterate(Select, ResultIteratorCallback)".</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="iterator-org.apache.cayenne.ObjectContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>iterator</h4> |
| <pre><a href="../../../../org/apache/cayenne/ResultIterator.html" title="interface in org.apache.cayenne">ResultIterator</a><<a href="../../../../org/apache/cayenne/query/Select.html" title="type parameter in Select">T</a>> iterator(<a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context)</pre> |
| <div class="block">Creates a ResultIterator based on the provided context. It is usually |
| backed by an open result set and is useful for processing of large data |
| sets, preserving a constant memory footprint. The caller must wrap |
| iteration in try/finally (or try-with-resources for Java 1.7 and higher) |
| and close the ResultIterator explicitly. Or use |
| <a href="../../../../org/apache/cayenne/query/Select.html#iterate-org.apache.cayenne.ObjectContext-org.apache.cayenne.ResultIteratorCallback-"><code>iterate(ObjectContext, ResultIteratorCallback)</code></a> as an |
| alternative. |
| <p> |
| Essentially the inversion of "ObjectContext.iterator(Select)".</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="batchIterator-org.apache.cayenne.ObjectContext-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>batchIterator</h4> |
| <pre><a href="../../../../org/apache/cayenne/ResultBatchIterator.html" title="class in org.apache.cayenne">ResultBatchIterator</a><<a href="../../../../org/apache/cayenne/query/Select.html" title="type parameter in Select">T</a>> batchIterator(<a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context, |
| int size)</pre> |
| <div class="block">Creates a ResultBatchIterator based on the provided context and batch |
| size. It is usually backed by an open result set and is useful for |
| processing of large data sets, preserving a constant memory footprint. |
| The caller must wrap iteration in try/finally (or try-with-resources for |
| Java 1.7 and higher) and close the ResultBatchIterator explicitly.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</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> |
| <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><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Select.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/ScalarResultSegment.html" title="interface in org.apache.cayenne.query"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/cayenne/query/SelectById.html" title="class in org.apache.cayenne.query"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/cayenne/query/Select.html" target="_top">Frames</a></li> |
| <li><a href="Select.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: </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 name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2001–2019 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
