| <!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>SelectQuery (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="SelectQuery (cayenne-doc: Cayenne Documentation 4.0.2 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":9,"i15":9,"i16":9,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":9,"i37":9,"i38":9,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":42,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/SelectQuery.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/SelectById.html" title="class in org.apache.cayenne.query"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/cayenne/query/SortOrder.html" title="enum 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/SelectQuery.html" target="_top">Frames</a></li> |
| <li><a href="SelectQuery.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><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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="Class SelectQuery" class="title">Class SelectQuery<T></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../org/apache/cayenne/query/CacheableQuery.html" title="class in org.apache.cayenne.query">org.apache.cayenne.query.CacheableQuery</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">org.apache.cayenne.query.AbstractQuery</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.cayenne.query.SelectQuery<T></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><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>, <a href="../../../../org/apache/cayenne/query/ParameterizedQuery.html" title="interface in org.apache.cayenne.query">ParameterizedQuery</a>, <a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a>, <a href="../../../../org/apache/cayenne/query/Select.html" title="interface in org.apache.cayenne.query">Select</a><T>, <a href="../../../../org/apache/cayenne/util/XMLSerializable.html" title="interface in org.apache.cayenne.util">XMLSerializable</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/apache/cayenne/query/PrefetchSelectQuery.html" title="class in org.apache.cayenne.query">PrefetchSelectQuery</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">SelectQuery<T></span> |
| extends <a href="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</a> |
| implements <a href="../../../../org/apache/cayenne/query/ParameterizedQuery.html" title="interface in org.apache.cayenne.query">ParameterizedQuery</a>, <a href="../../../../org/apache/cayenne/util/XMLSerializable.html" title="interface in org.apache.cayenne.util">XMLSerializable</a>, <a href="../../../../org/apache/cayenne/query/Select.html" title="interface in org.apache.cayenne.query">Select</a><T></pre> |
| <div class="block">A query that selects persistent objects of a certain type or "raw data" (aka |
| DataRows). Supports expression qualifier, multiple orderings and a number of |
| other parameters that serve as runtime hints to Cayenne on how to optimize |
| the fetch and result processing.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../serialized-form.html#org.apache.cayenne.query.SelectQuery">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#canReturnScalarValue">canReturnScalarValue</a></span></code> |
| <div class="block">Flag that indicates whether this query can return single value or |
| it should always return some complex data (Object[] for now)</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/cayenne/exp/Property.html" title="class in org.apache.cayenne.exp">Property</a><?>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#columns">columns</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#distinct">distinct</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#DISTINCT_DEFAULT">DISTINCT_DEFAULT</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#DISTINCT_PROPERTY">DISTINCT_PROPERTY</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#havingQualifier">havingQualifier</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <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/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#orderings">orderings</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#qualifier">qualifier</a></span></code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.cayenne.query.AbstractQuery"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.cayenne.query.<a href="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</a></h3> |
| <code><a href="../../../../org/apache/cayenne/query/AbstractQuery.html#dataMap">dataMap</a>, <a href="../../../../org/apache/cayenne/query/AbstractQuery.html#name">name</a>, <a href="../../../../org/apache/cayenne/query/AbstractQuery.html#root">root</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.cayenne.query.CacheableQuery"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.cayenne.query.<a href="../../../../org/apache/cayenne/query/CacheableQuery.html" title="class in org.apache.cayenne.query">CacheableQuery</a></h3> |
| <code><a href="../../../../org/apache/cayenne/query/CacheableQuery.html#logger">logger</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery--">SelectQuery</a></span>()</code> |
| <div class="block">Creates an empty SelectQuery.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery-java.lang.Class-">SelectQuery</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><<a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="type parameter in SelectQuery">T</a>> rootClass)</code> |
| <div class="block">Creates a SelectQuery that selects all objects of a given persistent |
| class.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery-java.lang.Class-org.apache.cayenne.exp.Expression-">SelectQuery</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><<a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="type parameter in SelectQuery">T</a>> rootClass, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</code> |
| <div class="block">Creates a SelectQuery that selects objects of a given persistent class |
| that match supplied qualifier.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery-java.lang.Class-org.apache.cayenne.exp.Expression-java.util.List-">SelectQuery</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><<a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="type parameter in SelectQuery">T</a>> rootClass, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier, |
| <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><? extends <a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</code> |
| <div class="block">Creates a SelectQuery that selects objects of a given persistent class |
| that match supplied qualifier.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery-org.apache.cayenne.map.DbEntity-">SelectQuery</a></span>(<a href="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> root)</code> |
| <div class="block">Creates a SelectQuery for the specified DbEntity.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery-org.apache.cayenne.map.DbEntity-org.apache.cayenne.exp.Expression-">SelectQuery</a></span>(<a href="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> root, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</code> |
| <div class="block">Creates a SelectQuery for the specified DbEntity with the given |
| qualifier.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery-org.apache.cayenne.map.DbEntity-org.apache.cayenne.exp.Expression-java.util.List-">SelectQuery</a></span>(<a href="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> root, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier, |
| <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><? extends <a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</code> |
| <div class="block">Creates a SelectQuery for the specified DbEntity with the given qualifier |
| and orderings.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery-org.apache.cayenne.map.ObjEntity-">SelectQuery</a></span>(<a href="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a> root)</code> |
| <div class="block">Creates a SelectQuery with null qualifier, for the specifed ObjEntity</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery-org.apache.cayenne.map.ObjEntity-org.apache.cayenne.exp.Expression-">SelectQuery</a></span>(<a href="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a> root, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</code> |
| <div class="block">Creates a SelectQuery for the specified ObjEntity with the given |
| qualifier.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery-org.apache.cayenne.map.ObjEntity-org.apache.cayenne.exp.Expression-java.util.List-">SelectQuery</a></span>(<a href="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a> root, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier, |
| <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><? extends <a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</code> |
| <div class="block">Creates a SelectQuery for the specified ObjEntity with the given |
| qualifier and orderings.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery-java.lang.String-">SelectQuery</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> objEntityName)</code> |
| <div class="block">Creates SelectQuery with <code>objEntityName</code> parameter.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery-java.lang.String-org.apache.cayenne.exp.Expression-">SelectQuery</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> objEntityName, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</code> |
| <div class="block">Creates SelectQuery with <code>objEntityName</code> and |
| <code>qualifier</code> parameters.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery-java.lang.String-org.apache.cayenne.exp.Expression-java.util.List-">SelectQuery</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> objEntityName, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier, |
| <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><? extends <a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</code> |
| <div class="block">Creates a SelectQuery that selects objects of a given persistent class |
| that match supplied qualifier.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#addOrdering-org.apache.cayenne.query.Ordering-">addOrdering</a></span>(<a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a> ordering)</code> |
| <div class="block">Adds ordering specification to this query orderings.</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/SelectQuery.html#addOrdering-java.lang.String-org.apache.cayenne.query.SortOrder-">addOrdering</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sortPathSpec, |
| <a href="../../../../org/apache/cayenne/query/SortOrder.html" title="enum in org.apache.cayenne.query">SortOrder</a> order)</code> |
| <div class="block">Adds ordering specification to this query orderings.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#addOrderings-java.util.Collection-">addOrderings</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><? extends <a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</code> |
| <div class="block">Adds a list of orderings.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#addPrefetch-org.apache.cayenne.query.PrefetchTreeNode-">addPrefetch</a></span>(<a href="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a> prefetchElement)</code> |
| <div class="block">Adds a prefetch with specified relationship path to the query.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#addPrefetch-java.lang.String-">addPrefetch</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefetchPath)</code> |
| <div class="block">Adds a prefetch with specified relationship path to the query.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#aliasPathSplits-java.lang.String-java.lang.String...-">aliasPathSplits</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... aliases)</code> |
| <div class="block">Adds one or more aliases for the qualifier expression path.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#andHavingQualifier-org.apache.cayenne.exp.Expression-">andHavingQualifier</a></span>(<a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> e)</code> |
| <div class="block">Adds specified HAVING qualifier to the existing HAVING qualifier joining it using "AND".</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#andQualifier-org.apache.cayenne.exp.Expression-">andQualifier</a></span>(<a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> e)</code> |
| <div class="block">Adds specified qualifier to the existing qualifier joining it using |
| "AND".</div> |
| </td> |
| </tr> |
| <tr id="i8" 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/SelectQuery.html" title="type parameter in SelectQuery">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.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="i9" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#canReturnScalarValue--">canReturnScalarValue</a></span>()</code> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#clearOrderings--">clearOrderings</a></span>()</code> |
| <div class="block">Clears all configured orderings.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#clearPrefetches--">clearPrefetches</a></span>()</code> |
| <div class="block">Clears all stored prefetch paths.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><<a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="type parameter in SelectQuery">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#createQuery-java.util.Map-">createQuery</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> parameters)</code> |
| <div class="block">Creates and returns a new SelectQuery built using this query as a |
| prototype and substituting qualifier parameters with the values from the |
| map.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <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><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#createSQLAction-org.apache.cayenne.query.SQLActionVisitor-">createSQLAction</a></span>(<a href="../../../../org/apache/cayenne/query/SQLActionVisitor.html" title="interface in org.apache.cayenne.query">SQLActionVisitor</a> visitor)</code> |
| <div class="block">Calls "makeSelect" on the visitor.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><<a href="../../../../org/apache/cayenne/DataRow.html" title="class in org.apache.cayenne">DataRow</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#dataRowQuery-java.lang.Class-">dataRowQuery</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> rootClass)</code> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><<a href="../../../../org/apache/cayenne/DataRow.html" title="class in org.apache.cayenne">DataRow</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#dataRowQuery-java.lang.Class-org.apache.cayenne.exp.Expression-">dataRowQuery</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> rootClass, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</code> |
| <div class="block">Creates a SelectQuery that selects DataRows that correspond to a given |
| persistent class that match supplied qualifier.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><<a href="../../../../org/apache/cayenne/DataRow.html" title="class in org.apache.cayenne">DataRow</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#dataRowQuery-java.lang.Class-org.apache.cayenne.exp.Expression-java.util.List-">dataRowQuery</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> rootClass, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier, |
| <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/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</code> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#encodeAsXML-org.apache.cayenne.util.XMLEncoder-">encodeAsXML</a></span>(<a href="../../../../org/apache/cayenne/util/XMLEncoder.html" title="class in org.apache.cayenne.util">XMLEncoder</a> encoder)</code> |
| <div class="block">Prints itself as XML to the provided PrintWriter.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>protected org.apache.cayenne.query.BaseQueryMetadata</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#getBaseMetaData--">getBaseMetaData</a></span>()</code> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/cayenne/exp/Property.html" title="class in org.apache.cayenne.exp">Property</a><?>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#getColumns--">getColumns</a></span>()</code> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#getFetchLimit--">getFetchLimit</a></span>()</code> |
| <div class="block">Returns the fetchLimit.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#getFetchOffset--">getFetchOffset</a></span>()</code> |
| <div class="block">Returns the fetchOffset.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#getHavingQualifier--">getHavingQualifier</a></span>()</code> |
| <div class="block">Returns query HAVING qualifier.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <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><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#getMetaData-org.apache.cayenne.map.EntityResolver-">getMetaData</a></span>(<a href="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a> resolver)</code> |
| <div class="block">Returns default select parameters.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <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/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#getOrderings--">getOrderings</a></span>()</code> |
| <div class="block">Returns a list of orderings used by this query.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#getPageSize--">getPageSize</a></span>()</code> |
| <div class="block">Returns <code>pageSize</code> property.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#getPrefetchTree--">getPrefetchTree</a></span>()</code> </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#getQualifier--">getQualifier</a></span>()</code> |
| <div class="block">Returns query qualifier.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#getStatementFetchSize--">getStatementFetchSize</a></span>()</code> </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#initWithProperties-java.util.Map-">initWithProperties</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> properties)</code> |
| <div class="block">Initializes query parameters using a set of properties.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#isDistinct--">isDistinct</a></span>()</code> |
| <div class="block">Returns true if this query returns distinct rows.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#isFetchingDataRows--">isFetchingDataRows</a></span>()</code> |
| <div class="block">Returns <code>true</code> if this query should produce a list of data |
| rows as opposed to DataObjects, <code>false</code> for DataObjects.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.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/SelectQuery.html" title="type parameter in SelectQuery">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="i33" class="rowColor"> |
| <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/SelectQuery.html" title="type parameter in SelectQuery">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.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="i34" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#orHavingQualifier-org.apache.cayenne.exp.Expression-">orHavingQualifier</a></span>(<a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> e)</code> |
| <div class="block">Adds specified HAVING qualifier to the existing HAVING qualifier joining it using "OR".</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#orQualifier-org.apache.cayenne.exp.Expression-">orQualifier</a></span>(<a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> e)</code> |
| <div class="block">Adds specified qualifier to the existing qualifier joining it using "OR".</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>static <T> <a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#query-java.lang.Class-">query</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> rootClass)</code> |
| <div class="block">Creates a SelectQuery that selects objects of a given persistent class.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>static <T> <a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#query-java.lang.Class-org.apache.cayenne.exp.Expression-">query</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> rootClass, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</code> |
| <div class="block">Creates a SelectQuery that selects objects of a given persistent class |
| that match supplied qualifier.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code>static <T> <a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#query-java.lang.Class-org.apache.cayenne.exp.Expression-java.util.List-">query</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> rootClass, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier, |
| <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><? extends <a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</code> |
| <div class="block">Creates a SelectQuery that selects objects of a given persistent class |
| that match supplied qualifier.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><<a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="type parameter in SelectQuery">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#queryWithParameters-java.util.Map-">queryWithParameters</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> parameters)</code> |
| <div class="block">A shortcut for <a href="../../../../org/apache/cayenne/query/SelectQuery.html#queryWithParameters-java.util.Map-boolean-"><code>queryWithParameters(Map, boolean)</code></a>that prunes |
| parts of qualifier that have no parameter value set.</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><<a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="type parameter in SelectQuery">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#queryWithParameters-java.util.Map-boolean-">queryWithParameters</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> parameters, |
| boolean pruneMissing)</code> |
| <div class="block">Returns a query built using this query as a prototype, using a set of |
| parameters to build the qualifier.</div> |
| </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#removeOrdering-org.apache.cayenne.query.Ordering-">removeOrdering</a></span>(<a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a> ordering)</code> |
| <div class="block">Removes ordering.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#removePrefetch-java.lang.String-">removePrefetch</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefetchPath)</code> |
| <div class="block">Removes prefetch.</div> |
| </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#route-org.apache.cayenne.query.QueryRouter-org.apache.cayenne.map.EntityResolver-org.apache.cayenne.query.Query-">route</a></span>(<a href="../../../../org/apache/cayenne/query/QueryRouter.html" title="interface in org.apache.cayenne.query">QueryRouter</a> router, |
| <a href="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a> resolver, |
| <a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a> substitutedQuery)</code> |
| <div class="block">Routes itself and if there are any prefetches configured, creates |
| prefetch queries and routes them as well.</div> |
| </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <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/SelectQuery.html" title="type parameter in SelectQuery">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.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="i45" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="type parameter in SelectQuery">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.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="i46" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="type parameter in SelectQuery">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.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> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#setCanReturnScalarValue-boolean-">setCanReturnScalarValue</a></span>(boolean canReturnScalarValue)</code> |
| <div class="block">Flag that indicates whether this query can return single value or |
| it should always return some complex data (Object[] for now)</div> |
| </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#setColumns-java.util.Collection-">setColumns</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/cayenne/exp/Property.html" title="class in org.apache.cayenne.exp">Property</a><?>> columns)</code> </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#setColumns-org.apache.cayenne.exp.Property...-">setColumns</a></span>(<a href="../../../../org/apache/cayenne/exp/Property.html" title="class in org.apache.cayenne.exp">Property</a><?>... columns)</code> </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#setDistinct-boolean-">setDistinct</a></span>(boolean distinct)</code> |
| <div class="block">Sets <code>distinct</code> property that determines whether this query |
| returns distinct row.</div> |
| </td> |
| </tr> |
| <tr id="i51" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#setFetchingDataRows-boolean-">setFetchingDataRows</a></span>(boolean flag)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">since 4.0, use <a href="../../../../org/apache/cayenne/query/SelectQuery.html#dataRowQuery-java.lang.Class-org.apache.cayenne.exp.Expression-"><code>dataRowQuery(Class, Expression)</code></a> to |
| create DataRow query instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i52" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#setFetchLimit-int-">setFetchLimit</a></span>(int fetchLimit)</code> |
| <div class="block">Sets the fetchLimit.</div> |
| </td> |
| </tr> |
| <tr id="i53" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#setFetchOffset-int-">setFetchOffset</a></span>(int fetchOffset)</code> </td> |
| </tr> |
| <tr id="i54" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#setHavingQualifier-org.apache.cayenne.exp.Expression-">setHavingQualifier</a></span>(<a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</code> |
| <div class="block">Sets new query HAVING qualifier.</div> |
| </td> |
| </tr> |
| <tr id="i55" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#setPageSize-int-">setPageSize</a></span>(int pageSize)</code> |
| <div class="block">Sets <code>pageSize</code> property.</div> |
| </td> |
| </tr> |
| <tr id="i56" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#setPrefetchTree-org.apache.cayenne.query.PrefetchTreeNode-">setPrefetchTree</a></span>(<a href="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a> prefetchTree)</code> </td> |
| </tr> |
| <tr id="i57" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#setQualifier-org.apache.cayenne.exp.Expression-">setQualifier</a></span>(<a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</code> |
| <div class="block">Sets new query qualifier.</div> |
| </td> |
| </tr> |
| <tr id="i58" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#setStatementFetchSize-int-">setStatementFetchSize</a></span>(int size)</code> |
| <div class="block">Sets statement's fetch size (0 for default size)</div> |
| </td> |
| </tr> |
| <tr id="i59" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/SelectQuery.html#setSuppressDistinct-boolean-">setSuppressDistinct</a></span>(boolean suppressDistinct)</code> |
| <div class="block">Sets <code>distinct</code> property that determines whether this query |
| returns distinct row.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.cayenne.query.AbstractQuery"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.cayenne.query.<a href="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</a></h3> |
| <code><a href="../../../../org/apache/cayenne/query/AbstractQuery.html#getDataMap--">getDataMap</a>, <a href="../../../../org/apache/cayenne/query/AbstractQuery.html#getName--">getName</a>, <a href="../../../../org/apache/cayenne/query/AbstractQuery.html#getRoot--">getRoot</a>, <a href="../../../../org/apache/cayenne/query/AbstractQuery.html#setDataMap-org.apache.cayenne.map.DataMap-">setDataMap</a>, <a href="../../../../org/apache/cayenne/query/AbstractQuery.html#setName-java.lang.String-">setName</a>, <a href="../../../../org/apache/cayenne/query/AbstractQuery.html#setRoot-java.lang.Object-">setRoot</a>, <a href="../../../../org/apache/cayenne/query/AbstractQuery.html#toString--">toString</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.cayenne.query.CacheableQuery"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.cayenne.query.<a href="../../../../org/apache/cayenne/query/CacheableQuery.html" title="class in org.apache.cayenne.query">CacheableQuery</a></h3> |
| <code><a href="../../../../org/apache/cayenne/query/CacheableQuery.html#getCacheGroup--">getCacheGroup</a>, <a href="../../../../org/apache/cayenne/query/CacheableQuery.html#getCacheGroups--">getCacheGroups</a>, <a href="../../../../org/apache/cayenne/query/CacheableQuery.html#getCacheStrategy--">getCacheStrategy</a>, <a href="../../../../org/apache/cayenne/query/CacheableQuery.html#setCacheGroup-java.lang.String-">setCacheGroup</a>, <a href="../../../../org/apache/cayenne/query/CacheableQuery.html#setCacheGroups-java.lang.String...-">setCacheGroups</a>, <a href="../../../../org/apache/cayenne/query/CacheableQuery.html#setCacheStrategy-org.apache.cayenne.query.QueryCacheStrategy-">setCacheStrategy</a>, <a href="../../../../org/apache/cayenne/query/CacheableQuery.html#useLocalCache--">useLocalCache</a>, <a href="../../../../org/apache/cayenne/query/CacheableQuery.html#useLocalCache-java.lang.String...-">useLocalCache</a>, <a href="../../../../org/apache/cayenne/query/CacheableQuery.html#useLocalCache-java.lang.String-">useLocalCache</a>, <a href="../../../../org/apache/cayenne/query/CacheableQuery.html#useSharedCache--">useSharedCache</a>, <a href="../../../../org/apache/cayenne/query/CacheableQuery.html#useSharedCache-java.lang.String...-">useSharedCache</a>, <a href="../../../../org/apache/cayenne/query/CacheableQuery.html#useSharedCache-java.lang.String-">useSharedCache</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <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#getDataMap--">getDataMap</a>, <a href="../../../../org/apache/cayenne/query/Query.html#getName--">getName</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="DISTINCT_PROPERTY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DISTINCT_PROPERTY</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DISTINCT_PROPERTY</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.cayenne.query.SelectQuery.DISTINCT_PROPERTY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DISTINCT_DEFAULT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DISTINCT_DEFAULT</h4> |
| <pre>public static final boolean DISTINCT_DEFAULT</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.cayenne.query.SelectQuery.DISTINCT_DEFAULT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="qualifier"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>qualifier</h4> |
| <pre>protected <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier</pre> |
| </li> |
| </ul> |
| <a name="orderings"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>orderings</h4> |
| <pre>protected <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/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings</pre> |
| </li> |
| </ul> |
| <a name="distinct"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>distinct</h4> |
| <pre>protected boolean distinct</pre> |
| </li> |
| </ul> |
| <a name="columns"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>columns</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/cayenne/exp/Property.html" title="class in org.apache.cayenne.exp">Property</a><?>> columns</pre> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="havingQualifier"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>havingQualifier</h4> |
| <pre>protected <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> havingQualifier</pre> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="canReturnScalarValue"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>canReturnScalarValue</h4> |
| <pre>protected boolean canReturnScalarValue</pre> |
| <div class="block"><p>Flag that indicates whether this query can return single value or |
| it should always return some complex data (Object[] for now)</p> |
| <p>Default value is <b>true</b></p></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="SelectQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SelectQuery</h4> |
| <pre>public SelectQuery()</pre> |
| <div class="block">Creates an empty SelectQuery.</div> |
| </li> |
| </ul> |
| <a name="SelectQuery-org.apache.cayenne.map.ObjEntity-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SelectQuery</h4> |
| <pre>public SelectQuery(<a href="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a> root)</pre> |
| <div class="block">Creates a SelectQuery with null qualifier, for the specifed ObjEntity</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>root</code> - the ObjEntity this SelectQuery is for.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SelectQuery-org.apache.cayenne.map.ObjEntity-org.apache.cayenne.exp.Expression-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SelectQuery</h4> |
| <pre>public SelectQuery(<a href="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a> root, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</pre> |
| <div class="block">Creates a SelectQuery for the specified ObjEntity with the given |
| qualifier.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>root</code> - the ObjEntity this SelectQuery is for.</dd> |
| <dd><code>qualifier</code> - an Expression indicating which objects should be fetched</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SelectQuery-org.apache.cayenne.map.ObjEntity-org.apache.cayenne.exp.Expression-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SelectQuery</h4> |
| <pre>public SelectQuery(<a href="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a> root, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier, |
| <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><? extends <a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</pre> |
| <div class="block">Creates a SelectQuery for the specified ObjEntity with the given |
| qualifier and orderings.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>root</code> - the ObjEntity this SelectQuery is for.</dd> |
| <dd><code>qualifier</code> - an Expression indicating which objects should be fetched.</dd> |
| <dd><code>orderings</code> - defines how to order the results, may be null.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SelectQuery-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SelectQuery</h4> |
| <pre>public SelectQuery(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><<a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="type parameter in SelectQuery">T</a>> rootClass)</pre> |
| <div class="block">Creates a SelectQuery that selects all objects of a given persistent |
| class.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rootClass</code> - the Class of objects fetched by this query.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SelectQuery-java.lang.Class-org.apache.cayenne.exp.Expression-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SelectQuery</h4> |
| <pre>public SelectQuery(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><<a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="type parameter in SelectQuery">T</a>> rootClass, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</pre> |
| <div class="block">Creates a SelectQuery that selects objects of a given persistent class |
| that match supplied qualifier.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rootClass</code> - the Class of objects fetched by this query.</dd> |
| <dd><code>qualifier</code> - an Expression indicating which objects should be fetched.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SelectQuery-java.lang.Class-org.apache.cayenne.exp.Expression-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SelectQuery</h4> |
| <pre>public SelectQuery(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><<a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="type parameter in SelectQuery">T</a>> rootClass, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier, |
| <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><? extends <a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</pre> |
| <div class="block">Creates a SelectQuery that selects objects of a given persistent class |
| that match supplied qualifier.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rootClass</code> - the Class of objects fetched by this query.</dd> |
| <dd><code>qualifier</code> - an Expression indicating which objects should be fetched.</dd> |
| <dd><code>orderings</code> - defines how to order the results, may be null.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SelectQuery-org.apache.cayenne.map.DbEntity-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SelectQuery</h4> |
| <pre>public SelectQuery(<a href="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> root)</pre> |
| <div class="block">Creates a SelectQuery for the specified DbEntity.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>root</code> - the DbEntity this SelectQuery is for.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SelectQuery-org.apache.cayenne.map.DbEntity-org.apache.cayenne.exp.Expression-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SelectQuery</h4> |
| <pre>public SelectQuery(<a href="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> root, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</pre> |
| <div class="block">Creates a SelectQuery for the specified DbEntity with the given |
| qualifier.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>root</code> - the DbEntity this SelectQuery is for.</dd> |
| <dd><code>qualifier</code> - an Expression indicating which objects should be fetched.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SelectQuery-org.apache.cayenne.map.DbEntity-org.apache.cayenne.exp.Expression-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SelectQuery</h4> |
| <pre>public SelectQuery(<a href="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> root, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier, |
| <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><? extends <a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</pre> |
| <div class="block">Creates a SelectQuery for the specified DbEntity with the given qualifier |
| and orderings.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>root</code> - the DbEntity this SelectQuery is for.</dd> |
| <dd><code>qualifier</code> - an Expression indicating which objects should be fetched.</dd> |
| <dd><code>orderings</code> - defines how to order the results, may be null.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SelectQuery-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SelectQuery</h4> |
| <pre>public SelectQuery(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> objEntityName)</pre> |
| <div class="block">Creates SelectQuery with <code>objEntityName</code> parameter.</div> |
| </li> |
| </ul> |
| <a name="SelectQuery-java.lang.String-org.apache.cayenne.exp.Expression-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SelectQuery</h4> |
| <pre>public SelectQuery(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> objEntityName, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</pre> |
| <div class="block">Creates SelectQuery with <code>objEntityName</code> and |
| <code>qualifier</code> parameters.</div> |
| </li> |
| </ul> |
| <a name="SelectQuery-java.lang.String-org.apache.cayenne.exp.Expression-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SelectQuery</h4> |
| <pre>public SelectQuery(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> objEntityName, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier, |
| <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><? extends <a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</pre> |
| <div class="block">Creates a SelectQuery that selects objects of a given persistent class |
| that match supplied qualifier.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>objEntityName</code> - the name of the ObjEntity to fetch from.</dd> |
| <dd><code>qualifier</code> - an Expression indicating which objects should be fetched.</dd> |
| <dd><code>orderings</code> - defines how to order the results, may be null.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="query-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>query</h4> |
| <pre>public static <T> <a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><T> query(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> rootClass)</pre> |
| <div class="block">Creates a SelectQuery that selects objects of a given persistent class.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rootClass</code> - the Class of objects fetched by this query.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="query-java.lang.Class-org.apache.cayenne.exp.Expression-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>query</h4> |
| <pre>public static <T> <a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><T> query(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> rootClass, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</pre> |
| <div class="block">Creates a SelectQuery that selects objects of a given persistent class |
| that match supplied qualifier.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rootClass</code> - the Class of objects fetched by this query.</dd> |
| <dd><code>qualifier</code> - an Expression indicating which objects should be fetched.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="query-java.lang.Class-org.apache.cayenne.exp.Expression-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>query</h4> |
| <pre>public static <T> <a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><T> query(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> rootClass, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier, |
| <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><? extends <a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</pre> |
| <div class="block">Creates a SelectQuery that selects objects of a given persistent class |
| that match supplied qualifier.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rootClass</code> - the Class of objects fetched by this query.</dd> |
| <dd><code>qualifier</code> - an Expression indicating which objects should be fetched.</dd> |
| <dd><code>orderings</code> - defines how to order the results, may be null.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="dataRowQuery-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dataRowQuery</h4> |
| <pre>public static <a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><<a href="../../../../org/apache/cayenne/DataRow.html" title="class in org.apache.cayenne">DataRow</a>> dataRowQuery(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> rootClass)</pre> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="dataRowQuery-java.lang.Class-org.apache.cayenne.exp.Expression-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dataRowQuery</h4> |
| <pre>public static <a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><<a href="../../../../org/apache/cayenne/DataRow.html" title="class in org.apache.cayenne">DataRow</a>> dataRowQuery(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> rootClass, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</pre> |
| <div class="block">Creates a SelectQuery that selects DataRows that correspond to a given |
| persistent class that match supplied qualifier.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rootClass</code> - the Class of objects that correspond to DataRows entity.</dd> |
| <dd><code>qualifier</code> - an Expression indicating which objects should be fetched.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="dataRowQuery-java.lang.Class-org.apache.cayenne.exp.Expression-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dataRowQuery</h4> |
| <pre>public static <a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><<a href="../../../../org/apache/cayenne/DataRow.html" title="class in org.apache.cayenne">DataRow</a>> dataRowQuery(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> rootClass, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier, |
| <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/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</pre> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="select-org.apache.cayenne.ObjectContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>select</h4> |
| <pre>public <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/SelectQuery.html" title="type parameter in SelectQuery">T</a>> select(<a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/cayenne/query/Select.html#select-org.apache.cayenne.ObjectContext-">Select</a></code></span></div> |
| <div class="block">Selects objects using provided context. |
| <p> |
| Essentially the inversion of "ObjectContext.select(Select)".</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/query/Select.html#select-org.apache.cayenne.ObjectContext-">select</a></code> in interface <code><a href="../../../../org/apache/cayenne/query/Select.html" title="interface in org.apache.cayenne.query">Select</a><<a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="type parameter in SelectQuery">T</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="selectOne-org.apache.cayenne.ObjectContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>selectOne</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="type parameter in SelectQuery">T</a> selectOne(<a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/cayenne/query/Select.html#selectOne-org.apache.cayenne.ObjectContext-">Select</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/query/Select.html#selectOne-org.apache.cayenne.ObjectContext-">selectOne</a></code> in interface <code><a href="../../../../org/apache/cayenne/query/Select.html" title="interface in org.apache.cayenne.query">Select</a><<a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="type parameter in SelectQuery">T</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="selectFirst-org.apache.cayenne.ObjectContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>selectFirst</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="type parameter in SelectQuery">T</a> selectFirst(<a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/cayenne/query/Select.html#selectFirst-org.apache.cayenne.ObjectContext-">Select</a></code></span></div> |
| <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>Select.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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/query/Select.html#selectFirst-org.apache.cayenne.ObjectContext-">selectFirst</a></code> in interface <code><a href="../../../../org/apache/cayenne/query/Select.html" title="interface in org.apache.cayenne.query">Select</a><<a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="type parameter in SelectQuery">T</a>></code></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>public 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/SelectQuery.html" title="type parameter in SelectQuery">T</a>> callback)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/cayenne/query/Select.html#iterate-org.apache.cayenne.ObjectContext-org.apache.cayenne.ResultIteratorCallback-">Select</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/query/Select.html#iterate-org.apache.cayenne.ObjectContext-org.apache.cayenne.ResultIteratorCallback-">iterate</a></code> in interface <code><a href="../../../../org/apache/cayenne/query/Select.html" title="interface in org.apache.cayenne.query">Select</a><<a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="type parameter in SelectQuery">T</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="iterator-org.apache.cayenne.ObjectContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>iterator</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/ResultIterator.html" title="interface in org.apache.cayenne">ResultIterator</a><<a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="type parameter in SelectQuery">T</a>> iterator(<a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/cayenne/query/Select.html#iterator-org.apache.cayenne.ObjectContext-">Select</a></code></span></div> |
| <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>Select.iterate(ObjectContext, ResultIteratorCallback)</code></a> as an |
| alternative. |
| <p> |
| Essentially the inversion of "ObjectContext.iterator(Select)".</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/query/Select.html#iterator-org.apache.cayenne.ObjectContext-">iterator</a></code> in interface <code><a href="../../../../org/apache/cayenne/query/Select.html" title="interface in org.apache.cayenne.query">Select</a><<a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="type parameter in SelectQuery">T</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="batchIterator-org.apache.cayenne.ObjectContext-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>batchIterator</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/ResultBatchIterator.html" title="class in org.apache.cayenne">ResultBatchIterator</a><<a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="type parameter in SelectQuery">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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/cayenne/query/Select.html#batchIterator-org.apache.cayenne.ObjectContext-int-">Select</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/query/Select.html#batchIterator-org.apache.cayenne.ObjectContext-int-">batchIterator</a></code> in interface <code><a href="../../../../org/apache/cayenne/query/Select.html" title="interface in org.apache.cayenne.query">Select</a><<a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="type parameter in SelectQuery">T</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMetaData-org.apache.cayenne.map.EntityResolver-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMetaData</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/query/QueryMetadata.html" title="interface in org.apache.cayenne.query">QueryMetadata</a> getMetaData(<a href="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a> resolver)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/cayenne/query/AbstractQuery.html#getMetaData-org.apache.cayenne.map.EntityResolver-">AbstractQuery</a></code></span></div> |
| <div class="block">Returns default select parameters.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/query/Query.html#getMetaData-org.apache.cayenne.map.EntityResolver-">getMetaData</a></code> in interface <code><a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/query/AbstractQuery.html#getMetaData-org.apache.cayenne.map.EntityResolver-">getMetaData</a></code> in class <code><a href="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</a></code></dd> |
| <dt><span class="simpleTagLabel">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>public void route(<a href="../../../../org/apache/cayenne/query/QueryRouter.html" title="interface in org.apache.cayenne.query">QueryRouter</a> router, |
| <a href="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a> resolver, |
| <a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a> substitutedQuery)</pre> |
| <div class="block">Routes itself and if there are any prefetches configured, creates |
| prefetch queries and routes them as well.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><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> in interface <code><a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/query/AbstractQuery.html#route-org.apache.cayenne.query.QueryRouter-org.apache.cayenne.map.EntityResolver-org.apache.cayenne.query.Query-">route</a></code> in class <code><a href="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</a></code></dd> |
| <dt><span class="simpleTagLabel">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>public <a href="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</a> createSQLAction(<a href="../../../../org/apache/cayenne/query/SQLActionVisitor.html" title="interface in org.apache.cayenne.query">SQLActionVisitor</a> visitor)</pre> |
| <div class="block">Calls "makeSelect" on the visitor.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/query/Query.html#createSQLAction-org.apache.cayenne.query.SQLActionVisitor-">createSQLAction</a></code> in interface <code><a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/query/AbstractQuery.html#createSQLAction-org.apache.cayenne.query.SQLActionVisitor-">createSQLAction</a></code> in class <code><a href="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="initWithProperties-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initWithProperties</h4> |
| <pre>public void initWithProperties(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> properties)</pre> |
| <div class="block">Initializes query parameters using a set of properties.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="encodeAsXML-org.apache.cayenne.util.XMLEncoder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>encodeAsXML</h4> |
| <pre>public void encodeAsXML(<a href="../../../../org/apache/cayenne/util/XMLEncoder.html" title="class in org.apache.cayenne.util">XMLEncoder</a> encoder)</pre> |
| <div class="block">Prints itself as XML to the provided PrintWriter.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/util/XMLSerializable.html#encodeAsXML-org.apache.cayenne.util.XMLEncoder-">encodeAsXML</a></code> in interface <code><a href="../../../../org/apache/cayenne/util/XMLSerializable.html" title="interface in org.apache.cayenne.util">XMLSerializable</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="queryWithParameters-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>queryWithParameters</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><<a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="type parameter in SelectQuery">T</a>> queryWithParameters(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> parameters)</pre> |
| <div class="block">A shortcut for <a href="../../../../org/apache/cayenne/query/SelectQuery.html#queryWithParameters-java.util.Map-boolean-"><code>queryWithParameters(Map, boolean)</code></a>that prunes |
| parts of qualifier that have no parameter value set.</div> |
| </li> |
| </ul> |
| <a name="queryWithParameters-java.util.Map-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>queryWithParameters</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><<a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="type parameter in SelectQuery">T</a>> queryWithParameters(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> parameters, |
| boolean pruneMissing)</pre> |
| <div class="block">Returns a query built using this query as a prototype, using a set of |
| parameters to build the qualifier.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/cayenne/exp/Expression.html#expWithParameters-java.util.Map-boolean-"><code>parameter substitution.</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createQuery-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createQuery</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><<a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="type parameter in SelectQuery">T</a>> createQuery(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> parameters)</pre> |
| <div class="block">Creates and returns a new SelectQuery built using this query as a |
| prototype and substituting qualifier parameters with the values from the |
| map.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/query/ParameterizedQuery.html#createQuery-java.util.Map-">createQuery</a></code> in interface <code><a href="../../../../org/apache/cayenne/query/ParameterizedQuery.html" title="interface in org.apache.cayenne.query">ParameterizedQuery</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addOrdering-org.apache.cayenne.query.Ordering-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addOrdering</h4> |
| <pre>public void addOrdering(<a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a> ordering)</pre> |
| <div class="block">Adds ordering specification to this query orderings.</div> |
| </li> |
| </ul> |
| <a name="addOrderings-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addOrderings</h4> |
| <pre>public void addOrderings(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><? extends <a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</pre> |
| <div class="block">Adds a list of orderings.</div> |
| </li> |
| </ul> |
| <a name="addOrdering-java.lang.String-org.apache.cayenne.query.SortOrder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addOrdering</h4> |
| <pre>public void addOrdering(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sortPathSpec, |
| <a href="../../../../org/apache/cayenne/query/SortOrder.html" title="enum in org.apache.cayenne.query">SortOrder</a> order)</pre> |
| <div class="block">Adds ordering specification to this query orderings.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeOrdering-org.apache.cayenne.query.Ordering-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeOrdering</h4> |
| <pre>public void removeOrdering(<a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a> ordering)</pre> |
| <div class="block">Removes ordering.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOrderings--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOrderings</h4> |
| <pre>public <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/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> getOrderings()</pre> |
| <div class="block">Returns a list of orderings used by this query.</div> |
| </li> |
| </ul> |
| <a name="clearOrderings--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearOrderings</h4> |
| <pre>public void clearOrderings()</pre> |
| <div class="block">Clears all configured orderings.</div> |
| </li> |
| </ul> |
| <a name="isDistinct--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDistinct</h4> |
| <pre>public boolean isDistinct()</pre> |
| <div class="block">Returns true if this query returns distinct rows.</div> |
| </li> |
| </ul> |
| <a name="setDistinct-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDistinct</h4> |
| <pre>public void setDistinct(boolean distinct)</pre> |
| <div class="block">Sets <code>distinct</code> property that determines whether this query |
| returns distinct row.</div> |
| </li> |
| </ul> |
| <a name="setSuppressDistinct-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSuppressDistinct</h4> |
| <pre>public void setSuppressDistinct(boolean suppressDistinct)</pre> |
| <div class="block">Sets <code>distinct</code> property that determines whether this query |
| returns distinct row.</div> |
| </li> |
| </ul> |
| <a name="aliasPathSplits-java.lang.String-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>aliasPathSplits</h4> |
| <pre>public void aliasPathSplits(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... aliases)</pre> |
| <div class="block">Adds one or more aliases for the qualifier expression path. Aliases serve |
| to instruct Cayenne to generate separate sets of joins for overlapping |
| paths, that maybe needed for complex conditions. An example of an |
| <i>implicit</i> splits is this method: |
| <a href="../../../../org/apache/cayenne/exp/ExpressionFactory.html#matchAllExp-java.lang.String-java.lang.Object...-"><code>ExpressionFactory.matchAllExp(String, Object...)</code></a>.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPrefetchTree--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrefetchTree</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a> getPrefetchTree()</pre> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPrefetchTree-org.apache.cayenne.query.PrefetchTreeNode-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPrefetchTree</h4> |
| <pre>public void setPrefetchTree(<a href="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a> prefetchTree)</pre> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addPrefetch-org.apache.cayenne.query.PrefetchTreeNode-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addPrefetch</h4> |
| <pre>public void addPrefetch(<a href="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a> prefetchElement)</pre> |
| <div class="block">Adds a prefetch with specified relationship path to the query.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addPrefetch-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addPrefetch</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a> addPrefetch(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefetchPath)</pre> |
| <div class="block">Adds a prefetch with specified relationship path to the query.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2 signature changed to return created PrefetchTreeNode.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="clearPrefetches--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearPrefetches</h4> |
| <pre>public void clearPrefetches()</pre> |
| <div class="block">Clears all stored prefetch paths.</div> |
| </li> |
| </ul> |
| <a name="removePrefetch-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removePrefetch</h4> |
| <pre>public void removePrefetch(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefetchPath)</pre> |
| <div class="block">Removes prefetch.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isFetchingDataRows--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isFetchingDataRows</h4> |
| <pre>public boolean isFetchingDataRows()</pre> |
| <div class="block">Returns <code>true</code> if this query should produce a list of data |
| rows as opposed to DataObjects, <code>false</code> for DataObjects. This |
| is a hint to QueryEngine executing this query.</div> |
| </li> |
| </ul> |
| <a name="setFetchingDataRows-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFetchingDataRows</h4> |
| <pre>public void setFetchingDataRows(boolean flag)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 4.0, use <a href="../../../../org/apache/cayenne/query/SelectQuery.html#dataRowQuery-java.lang.Class-org.apache.cayenne.exp.Expression-"><code>dataRowQuery(Class, Expression)</code></a> to |
| create DataRow query instead.</span></div> |
| <div class="block">Sets query result type. If <code>flag</code> parameter is |
| <code>true</code>, then results will be in the form of data rows. |
| <p> |
| <i>Note that if the root of this query is a <a href="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map"><code>DbEntity</code></a>, this |
| setting has no effect, and data rows are always fetched. </i> |
| </p></div> |
| </li> |
| </ul> |
| <a name="getFetchOffset--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFetchOffset</h4> |
| <pre>public int getFetchOffset()</pre> |
| <div class="block">Returns the fetchOffset.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFetchLimit--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFetchLimit</h4> |
| <pre>public int getFetchLimit()</pre> |
| <div class="block">Returns the fetchLimit.</div> |
| </li> |
| </ul> |
| <a name="setFetchLimit-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFetchLimit</h4> |
| <pre>public void setFetchLimit(int fetchLimit)</pre> |
| <div class="block">Sets the fetchLimit.</div> |
| </li> |
| </ul> |
| <a name="setFetchOffset-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFetchOffset</h4> |
| <pre>public void setFetchOffset(int fetchOffset)</pre> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPageSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPageSize</h4> |
| <pre>public int getPageSize()</pre> |
| <div class="block">Returns <code>pageSize</code> property. See setPageSize for more details.</div> |
| </li> |
| </ul> |
| <a name="setPageSize-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPageSize</h4> |
| <pre>public void setPageSize(int pageSize)</pre> |
| <div class="block">Sets <code>pageSize</code> property. |
| |
| By setting a page size, the Collection returned by performing a query |
| will return <i>hollow</i> DataObjects. This is considerably faster and |
| uses a tiny fraction of the memory compared to a non-paged query when |
| large numbers of objects are returned in the result. When a hollow |
| DataObject is accessed all DataObjects on the same page will be faulted |
| into memory. There will be a small delay when faulting objects while the |
| data is fetched from the data source, but otherwise you do not need to do |
| anything special to access data in hollow objects. The first page is |
| always faulted into memory immediately.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pageSize</code> - The pageSize to set</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setStatementFetchSize-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStatementFetchSize</h4> |
| <pre>public void setStatementFetchSize(int size)</pre> |
| <div class="block">Sets statement's fetch size (0 for default size)</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStatementFetchSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStatementFetchSize</h4> |
| <pre>public int getStatementFetchSize()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>statement's fetch size</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setQualifier-org.apache.cayenne.exp.Expression-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setQualifier</h4> |
| <pre>public void setQualifier(<a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</pre> |
| <div class="block">Sets new query qualifier.</div> |
| </li> |
| </ul> |
| <a name="getQualifier--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQualifier</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> getQualifier()</pre> |
| <div class="block">Returns query qualifier.</div> |
| </li> |
| </ul> |
| <a name="andQualifier-org.apache.cayenne.exp.Expression-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>andQualifier</h4> |
| <pre>public void andQualifier(<a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> e)</pre> |
| <div class="block">Adds specified qualifier to the existing qualifier joining it using |
| "AND".</div> |
| </li> |
| </ul> |
| <a name="orQualifier-org.apache.cayenne.exp.Expression-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>orQualifier</h4> |
| <pre>public void orQualifier(<a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> e)</pre> |
| <div class="block">Adds specified qualifier to the existing qualifier joining it using "OR".</div> |
| </li> |
| </ul> |
| <a name="setColumns-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setColumns</h4> |
| <pre>public void setColumns(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/cayenne/exp/Property.html" title="class in org.apache.cayenne.exp">Property</a><?>> columns)</pre> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/cayenne/query/SelectQuery.html#setCanReturnScalarValue-boolean-"><code>setCanReturnScalarValue(boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setColumns-org.apache.cayenne.exp.Property...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setColumns</h4> |
| <pre>public void setColumns(<a href="../../../../org/apache/cayenne/exp/Property.html" title="class in org.apache.cayenne.exp">Property</a><?>... columns)</pre> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCanReturnScalarValue-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCanReturnScalarValue</h4> |
| <pre>public void setCanReturnScalarValue(boolean canReturnScalarValue)</pre> |
| <div class="block"><p>Flag that indicates whether this query can return single value or |
| it should always return some complex data (Object[] for now)</p> |
| <p>Default value is <b>true</b></p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>canReturnScalarValue</code> - can this query return single value</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/cayenne/query/SelectQuery.html#setColumns-java.util.Collection-"><code>setColumns(java.util.Collection<org.apache.cayenne.exp.Property<?>>)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="canReturnScalarValue--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>canReturnScalarValue</h4> |
| <pre>public boolean canReturnScalarValue()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>can this query return single value</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getColumns--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getColumns</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/cayenne/exp/Property.html" title="class in org.apache.cayenne.exp">Property</a><?>> getColumns()</pre> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setHavingQualifier-org.apache.cayenne.exp.Expression-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHavingQualifier</h4> |
| <pre>public void setHavingQualifier(<a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</pre> |
| <div class="block">Sets new query HAVING qualifier.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getHavingQualifier--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHavingQualifier</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> getHavingQualifier()</pre> |
| <div class="block">Returns query HAVING qualifier.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="andHavingQualifier-org.apache.cayenne.exp.Expression-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>andHavingQualifier</h4> |
| <pre>public void andHavingQualifier(<a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> e)</pre> |
| <div class="block">Adds specified HAVING qualifier to the existing HAVING qualifier joining it using "AND".</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="orHavingQualifier-org.apache.cayenne.exp.Expression-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>orHavingQualifier</h4> |
| <pre>public void orHavingQualifier(<a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> e)</pre> |
| <div class="block">Adds specified HAVING qualifier to the existing HAVING qualifier joining it using "OR".</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBaseMetaData--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getBaseMetaData</h4> |
| <pre>protected org.apache.cayenne.query.BaseQueryMetadata getBaseMetaData()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/query/CacheableQuery.html#getBaseMetaData--">getBaseMetaData</a></code> in class <code><a href="../../../../org/apache/cayenne/query/CacheableQuery.html" title="class in org.apache.cayenne.query">CacheableQuery</a></code></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/SelectQuery.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/SelectById.html" title="class in org.apache.cayenne.query"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/cayenne/query/SortOrder.html" title="enum 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/SelectQuery.html" target="_top">Frames</a></li> |
| <li><a href="SelectQuery.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><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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> |
