| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.10) on Mon Dec 05 10:27:04 MSK 2022 --> |
| <title>SelectQuery (cayenne-doc: Cayenne Documentation 4.2.RC2 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-12-05"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SelectQuery (cayenne-doc: Cayenne Documentation 4.2.RC2 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":42,"i1":42,"i2":42,"i3":42,"i4":42,"i5":42,"i6":42,"i7":42,"i8":42,"i9":42,"i10":42,"i11":42,"i12":42,"i13":42,"i14":41,"i15":41,"i16":41,"i17":42,"i18":42,"i19":42,"i20":42,"i21":42,"i22":42,"i23":42,"i24":42,"i25":42,"i26":42,"i27":42,"i28":42,"i29":42,"i30":42,"i31":42,"i32":42,"i33":42,"i34":42,"i35":41,"i36":41,"i37":41,"i38":42,"i39":42,"i40":42,"i41":42,"i42":42,"i43":42,"i44":42,"i45":42,"i46":42,"i47":42,"i48":42,"i49":42,"i50":42,"i51":42,"i52":42,"i53":42,"i54":42,"i55":42,"i56":42,"i57":42,"i58":42}; |
| 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"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = false; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/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 class="aboutLanguage"><a href="http://cayenne.apache.org" target="top">Apache Cayenne</a></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><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 id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.cayenne.query</a></div> |
| <h2 title="Class SelectQuery" class="title">Class SelectQuery<T></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="CacheableQuery.html" title="class in org.apache.cayenne.query">org.apache.cayenne.query.CacheableQuery</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="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><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code>, <code><a href="ParameterizedQuery.html" title="interface in org.apache.cayenne.query">ParameterizedQuery</a></code>, <code><a href="Query.html" title="interface in org.apache.cayenne.query">Query</a></code>, <code><a href="Select.html" title="interface in org.apache.cayenne.query">Select</a><T></code></dd> |
| </dl> |
| <hr> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| public class <span class="typeNameLabel">SelectQuery<T></span> |
| extends <a href="AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</a> |
| implements <a href="ParameterizedQuery.html" title="interface in org.apache.cayenne.query">ParameterizedQuery</a>, <a href="Select.html" title="interface in org.apache.cayenne.query">Select</a><T></pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">since 4.2, use <a href="ObjectSelect.html" title="class in org.apache.cayenne.query"><code>ObjectSelect</code></a></div> |
| </div> |
| <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 =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#canReturnScalarValue">canReturnScalarValue</a></span></code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="../exp/property/Property.html" title="interface in org.apache.cayenne.exp.property">Property</a><?>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#columns">columns</a></span></code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#distinct">distinct</a></span></code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DISTINCT_DEFAULT">DISTINCT_DEFAULT</a></span></code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DISTINCT_PROPERTY">DISTINCT_PROPERTY</a></span></code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#havingQualifier">havingQualifier</a></span></code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#orderings">orderings</a></span></code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#qualifier">qualifier</a></span></code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.apache.cayenne.query.AbstractQuery"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.cayenne.query.<a href="AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</a></h3> |
| <code><a href="AbstractQuery.html#root">root</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.apache.cayenne.query.CacheableQuery"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.cayenne.query.<a href="CacheableQuery.html" title="class in org.apache.cayenne.query">CacheableQuery</a></h3> |
| <code><a href="CacheableQuery.html#logger">logger</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">SelectQuery</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Creates an empty SelectQuery.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.Class)">SelectQuery</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><<a href="SelectQuery.html" title="type parameter in SelectQuery">T</a>> rootClass)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Creates a SelectQuery that selects all objects of a given persistent |
| class.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.Class,org.apache.cayenne.exp.Expression)">SelectQuery</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><<a href="SelectQuery.html" title="type parameter in SelectQuery">T</a>> rootClass, |
| <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Creates a SelectQuery that selects objects of a given persistent class |
| that match supplied qualifier.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.Class,org.apache.cayenne.exp.Expression,java.util.List)">SelectQuery</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><<a href="SelectQuery.html" title="type parameter in SelectQuery">T</a>> rootClass, |
| <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><? extends <a href="Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Creates a SelectQuery that selects objects of a given persistent class |
| that match supplied qualifier.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String)">SelectQuery</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> objEntityName)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Creates SelectQuery with <code>objEntityName</code> parameter.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,org.apache.cayenne.exp.Expression)">SelectQuery</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> objEntityName, |
| <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Creates SelectQuery with <code>objEntityName</code> and |
| <code>qualifier</code> parameters.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,org.apache.cayenne.exp.Expression,java.util.List)">SelectQuery</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> objEntityName, |
| <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><? extends <a href="Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Creates a SelectQuery that selects objects of a given persistent class |
| that match supplied qualifier.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.cayenne.map.DbEntity)">SelectQuery</a></span>​(<a href="../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> root)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Creates a SelectQuery for the specified DbEntity.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.cayenne.map.DbEntity,org.apache.cayenne.exp.Expression)">SelectQuery</a></span>​(<a href="../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> root, |
| <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Creates a SelectQuery for the specified DbEntity with the given |
| qualifier.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.cayenne.map.DbEntity,org.apache.cayenne.exp.Expression,java.util.List)">SelectQuery</a></span>​(<a href="../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> root, |
| <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><? extends <a href="Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Creates a SelectQuery for the specified DbEntity with the given qualifier |
| and orderings.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.cayenne.map.ObjEntity)">SelectQuery</a></span>​(<a href="../map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a> root)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Creates a SelectQuery with null qualifier, for the specifed ObjEntity</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.cayenne.map.ObjEntity,org.apache.cayenne.exp.Expression)">SelectQuery</a></span>​(<a href="../map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a> root, |
| <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Creates a SelectQuery for the specified ObjEntity with the given |
| qualifier.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.cayenne.map.ObjEntity,org.apache.cayenne.exp.Expression,java.util.List)">SelectQuery</a></span>​(<a href="../map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a> root, |
| <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><? extends <a href="Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Creates a SelectQuery for the specified ObjEntity with the given |
| qualifier and orderings.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addOrdering(java.lang.String,org.apache.cayenne.query.SortOrder)">addOrdering</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sortPathSpec, |
| <a href="SortOrder.html" title="enum in org.apache.cayenne.query">SortOrder</a> order)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addOrdering(org.apache.cayenne.query.Ordering)">addOrdering</a></span>​(<a href="Ordering.html" title="class in org.apache.cayenne.query">Ordering</a> ordering)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addOrderings(java.util.Collection)">addOrderings</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><? extends <a href="Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Adds a list of orderings.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addPrefetch(java.lang.String)">addPrefetch</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> prefetchPath)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addPrefetch(org.apache.cayenne.query.PrefetchTreeNode)">addPrefetch</a></span>​(<a href="PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a> prefetchElement)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#aliasPathSplits(java.lang.String,java.lang.String...)">aliasPathSplits</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> path, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>... aliases)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#andHavingQualifier(org.apache.cayenne.exp.Expression)">andHavingQualifier</a></span>​(<a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> e)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#andQualifier(org.apache.cayenne.exp.Expression)">andQualifier</a></span>​(<a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> e)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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="../ResultBatchIterator.html" title="class in org.apache.cayenne">ResultBatchIterator</a><<a href="SelectQuery.html" title="type parameter in SelectQuery">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#batchIterator(org.apache.cayenne.ObjectContext,int)">batchIterator</a></span>​(<a href="../ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context, |
| int size)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#canReturnScalarValue()">canReturnScalarValue</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clearOrderings()">clearOrderings</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Clears all configured orderings.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clearPrefetches()">clearPrefetches</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Clears all stored prefetch paths.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><<a href="SelectQuery.html" title="type parameter in SelectQuery">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createQuery(java.util.Map)">createQuery</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​?> parameters)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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="SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createSQLAction(org.apache.cayenne.query.SQLActionVisitor)">createSQLAction</a></span>​(<a href="SQLActionVisitor.html" title="interface in org.apache.cayenne.query">SQLActionVisitor</a> visitor)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Calls "makeSelect" on the visitor.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>static <a href="SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><<a href="../DataRow.html" title="class in org.apache.cayenne">DataRow</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dataRowQuery(java.lang.Class)">dataRowQuery</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> rootClass)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>static <a href="SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><<a href="../DataRow.html" title="class in org.apache.cayenne">DataRow</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dataRowQuery(java.lang.Class,org.apache.cayenne.exp.Expression)">dataRowQuery</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> rootClass, |
| <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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="SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><<a href="../DataRow.html" title="class in org.apache.cayenne">DataRow</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dataRowQuery(java.lang.Class,org.apache.cayenne.exp.Expression,java.util.List)">dataRowQuery</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> rootClass, |
| <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>protected org.apache.cayenne.query.BaseQueryMetadata</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBaseMetaData()">getBaseMetaData</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="../exp/property/Property.html" title="interface in org.apache.cayenne.exp.property">Property</a><?>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getColumns()">getColumns</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFetchLimit()">getFetchLimit</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Returns the fetchLimit.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFetchOffset()">getFetchOffset</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Returns the fetchOffset.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHavingQualifier()">getHavingQualifier</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Returns query HAVING qualifier.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="QueryMetadata.html" title="interface in org.apache.cayenne.query">QueryMetadata</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMetaData(org.apache.cayenne.map.EntityResolver)">getMetaData</a></span>​(<a href="../map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a> resolver)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Returns default select parameters.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOrderings()">getOrderings</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Returns a list of orderings used by this query.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPageSize()">getPageSize</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Returns <code>pageSize</code> property.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPrefetchTree()">getPrefetchTree</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code><a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQualifier()">getQualifier</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Returns query qualifier.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStatementFetchSize()">getStatementFetchSize</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#initWithProperties(java.util.Map)">initWithProperties</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​?> properties)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Initializes query parameters using a set of properties.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isDistinct()">isDistinct</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Returns true if this query returns distinct rows.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isFetchingDataRows()">isFetchingDataRows</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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="i31" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#iterate(org.apache.cayenne.ObjectContext,org.apache.cayenne.ResultIteratorCallback)">iterate</a></span>​(<a href="../ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context, |
| <a href="../ResultIteratorCallback.html" title="interface in org.apache.cayenne">ResultIteratorCallback</a><<a href="SelectQuery.html" title="type parameter in SelectQuery">T</a>> callback)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Creates a ResultIterator based on the provided context and passes it to a |
| callback for processing.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code><a href="../ResultIterator.html" title="interface in org.apache.cayenne">ResultIterator</a><<a href="SelectQuery.html" title="type parameter in SelectQuery">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#iterator(org.apache.cayenne.ObjectContext)">iterator</a></span>​(<a href="../ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Creates a ResultIterator based on the provided context.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#orHavingQualifier(org.apache.cayenne.exp.Expression)">orHavingQualifier</a></span>​(<a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> e)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Adds specified HAVING qualifier to the existing HAVING qualifier joining it using "OR".</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#orQualifier(org.apache.cayenne.exp.Expression)">orQualifier</a></span>​(<a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> e)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Adds specified qualifier to the existing qualifier joining it using "OR".</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>static <T> <a href="SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><T></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#query(java.lang.Class)">query</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> rootClass)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Creates a SelectQuery that selects objects of a given persistent class.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>static <T> <a href="SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><T></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#query(java.lang.Class,org.apache.cayenne.exp.Expression)">query</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> rootClass, |
| <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Creates a SelectQuery that selects objects of a given persistent class |
| that match supplied qualifier.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>static <T> <a href="SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><T></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#query(java.lang.Class,org.apache.cayenne.exp.Expression,java.util.List)">query</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> rootClass, |
| <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><? extends <a href="Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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><a href="SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><<a href="SelectQuery.html" title="type parameter in SelectQuery">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#queryWithParameters(java.util.Map)">queryWithParameters</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​?> parameters)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">A shortcut for <a href="#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="i39" class="rowColor"> |
| <td class="colFirst"><code><a href="SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><<a href="SelectQuery.html" title="type parameter in SelectQuery">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#queryWithParameters(java.util.Map,boolean)">queryWithParameters</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​?> parameters, |
| boolean pruneMissing)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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="i40" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeOrdering(org.apache.cayenne.query.Ordering)">removeOrdering</a></span>​(<a href="Ordering.html" title="class in org.apache.cayenne.query">Ordering</a> ordering)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Removes ordering.</div> |
| </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removePrefetch(java.lang.String)">removePrefetch</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> prefetchPath)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Removes prefetch.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#route(org.apache.cayenne.query.QueryRouter,org.apache.cayenne.map.EntityResolver,org.apache.cayenne.query.Query)">route</a></span>​(<a href="QueryRouter.html" title="interface in org.apache.cayenne.query">QueryRouter</a> router, |
| <a href="../map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a> resolver, |
| <a href="Query.html" title="interface in org.apache.cayenne.query">Query</a> substitutedQuery)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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="i43" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="SelectQuery.html" title="type parameter in SelectQuery">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#select(org.apache.cayenne.ObjectContext)">select</a></span>​(<a href="../ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Selects objects using provided context.</div> |
| </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code><a href="SelectQuery.html" title="type parameter in SelectQuery">T</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#selectFirst(org.apache.cayenne.ObjectContext)">selectFirst</a></span>​(<a href="../ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Selects a single object using provided context.</div> |
| </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code><a href="SelectQuery.html" title="type parameter in SelectQuery">T</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#selectOne(org.apache.cayenne.ObjectContext)">selectOne</a></span>​(<a href="../ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Selects a single object using provided context.</div> |
| </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCanReturnScalarValue(boolean)">setCanReturnScalarValue</a></span>​(boolean canReturnScalarValue)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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="i47" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setColumns(java.util.Collection)">setColumns</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="../exp/property/Property.html" title="interface in org.apache.cayenne.exp.property">Property</a><?>> columns)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setColumns(org.apache.cayenne.exp.property.Property...)">setColumns</a></span>​(<a href="../exp/property/Property.html" title="interface in org.apache.cayenne.exp.property">Property</a><?>... columns)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDistinct(boolean)">setDistinct</a></span>​(boolean distinct)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Sets <code>distinct</code> property that determines whether this query |
| returns distinct row.</div> |
| </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setFetchingDataRows(boolean)">setFetchingDataRows</a></span>​(boolean flag)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">since 4.0, use <a href="#dataRowQuery(java.lang.Class,org.apache.cayenne.exp.Expression)"><code>dataRowQuery(Class, Expression)</code></a> to |
| create DataRow query instead.</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i51" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setFetchLimit(int)">setFetchLimit</a></span>​(int fetchLimit)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Sets the fetchLimit.</div> |
| </td> |
| </tr> |
| <tr id="i52" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setFetchOffset(int)">setFetchOffset</a></span>​(int fetchOffset)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr id="i53" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setHavingQualifier(org.apache.cayenne.exp.Expression)">setHavingQualifier</a></span>​(<a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Sets new query HAVING qualifier.</div> |
| </td> |
| </tr> |
| <tr id="i54" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPageSize(int)">setPageSize</a></span>​(int pageSize)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Sets <code>pageSize</code> property.</div> |
| </td> |
| </tr> |
| <tr id="i55" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPrefetchTree(org.apache.cayenne.query.PrefetchTreeNode)">setPrefetchTree</a></span>​(<a href="PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a> prefetchTree)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr id="i56" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setQualifier(org.apache.cayenne.exp.Expression)">setQualifier</a></span>​(<a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Sets new query qualifier.</div> |
| </td> |
| </tr> |
| <tr id="i57" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setStatementFetchSize(int)">setStatementFetchSize</a></span>​(int size)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Sets statement's fetch size (0 for default size)</div> |
| </td> |
| </tr> |
| <tr id="i58" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSuppressDistinct(boolean)">setSuppressDistinct</a></span>​(boolean suppressDistinct)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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 id="methods.inherited.from.class.org.apache.cayenne.query.AbstractQuery"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.cayenne.query.<a href="AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</a></h3> |
| <code><a href="AbstractQuery.html#getRoot()">getRoot</a>, <a href="AbstractQuery.html#setRoot(java.lang.Object)">setRoot</a>, <a href="AbstractQuery.html#toString()">toString</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.cayenne.query.CacheableQuery"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.cayenne.query.<a href="CacheableQuery.html" title="class in org.apache.cayenne.query">CacheableQuery</a></h3> |
| <code><a href="CacheableQuery.html#getCacheGroup()">getCacheGroup</a>, <a href="CacheableQuery.html#getCacheStrategy()">getCacheStrategy</a>, <a href="CacheableQuery.html#setCacheGroup(java.lang.String)">setCacheGroup</a>, <a href="CacheableQuery.html#setCacheStrategy(org.apache.cayenne.query.QueryCacheStrategy)">setCacheStrategy</a>, <a href="CacheableQuery.html#useLocalCache()">useLocalCache</a>, <a href="CacheableQuery.html#useLocalCache(java.lang.String)">useLocalCache</a>, <a href="CacheableQuery.html#useSharedCache()">useSharedCache</a>, <a href="CacheableQuery.html#useSharedCache(java.lang.String)">useSharedCache</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="DISTINCT_PROPERTY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DISTINCT_PROPERTY</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> DISTINCT_PROPERTY</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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 id="DISTINCT_DEFAULT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DISTINCT_DEFAULT</h4> |
| <pre>public static final boolean DISTINCT_DEFAULT</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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 id="qualifier"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>qualifier</h4> |
| <pre>protected <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </li> |
| </ul> |
| <a id="orderings"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>orderings</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </li> |
| </ul> |
| <a id="distinct"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>distinct</h4> |
| <pre>protected boolean distinct</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </li> |
| </ul> |
| <a id="columns"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>columns</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="../exp/property/Property.html" title="interface in org.apache.cayenne.exp.property">Property</a><?>> columns</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="havingQualifier"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>havingQualifier</h4> |
| <pre>protected <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> havingQualifier</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="canReturnScalarValue"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>canReturnScalarValue</h4> |
| <pre>protected boolean canReturnScalarValue</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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> |
| </section> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SelectQuery</h4> |
| <pre>public SelectQuery()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Creates an empty SelectQuery.</div> |
| </li> |
| </ul> |
| <a id="<init>(org.apache.cayenne.map.ObjEntity)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SelectQuery</h4> |
| <pre>public SelectQuery​(<a href="../map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a> root)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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 id="<init>(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="../map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a> root, |
| <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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 id="<init>(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="../map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a> root, |
| <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><? extends <a href="Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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 id="<init>(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SelectQuery</h4> |
| <pre>public SelectQuery​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><<a href="SelectQuery.html" title="type parameter in SelectQuery">T</a>> rootClass)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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 id="<init>(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/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><<a href="SelectQuery.html" title="type parameter in SelectQuery">T</a>> rootClass, |
| <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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 id="<init>(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/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><<a href="SelectQuery.html" title="type parameter in SelectQuery">T</a>> rootClass, |
| <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><? extends <a href="Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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 id="<init>(org.apache.cayenne.map.DbEntity)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SelectQuery</h4> |
| <pre>public SelectQuery​(<a href="../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> root)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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 id="<init>(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="../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> root, |
| <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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 id="<init>(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="../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> root, |
| <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><? extends <a href="Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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 id="<init>(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SelectQuery</h4> |
| <pre>public SelectQuery​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> objEntityName)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Creates SelectQuery with <code>objEntityName</code> parameter.</div> |
| </li> |
| </ul> |
| <a id="<init>(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/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> objEntityName, |
| <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Creates SelectQuery with <code>objEntityName</code> and |
| <code>qualifier</code> parameters.</div> |
| </li> |
| </ul> |
| <a id="<init>(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/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> objEntityName, |
| <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><? extends <a href="Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="query(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>query</h4> |
| <pre class="methodSignature">public static <T> <a href="SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><T> query​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> rootClass)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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 id="query(java.lang.Class,org.apache.cayenne.exp.Expression)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>query</h4> |
| <pre class="methodSignature">public static <T> <a href="SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><T> query​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> rootClass, |
| <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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 id="query(java.lang.Class,org.apache.cayenne.exp.Expression,java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>query</h4> |
| <pre class="methodSignature">public static <T> <a href="SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><T> query​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> rootClass, |
| <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><? extends <a href="Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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 id="dataRowQuery(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dataRowQuery</h4> |
| <pre class="methodSignature">public static <a href="SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><<a href="../DataRow.html" title="class in org.apache.cayenne">DataRow</a>> dataRowQuery​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> rootClass)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="dataRowQuery(java.lang.Class,org.apache.cayenne.exp.Expression)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dataRowQuery</h4> |
| <pre class="methodSignature">public static <a href="SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><<a href="../DataRow.html" title="class in org.apache.cayenne">DataRow</a>> dataRowQuery​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> rootClass, |
| <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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 id="dataRowQuery(java.lang.Class,org.apache.cayenne.exp.Expression,java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dataRowQuery</h4> |
| <pre class="methodSignature">public static <a href="SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><<a href="../DataRow.html" title="class in org.apache.cayenne">DataRow</a>> dataRowQuery​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> rootClass, |
| <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="select(org.apache.cayenne.ObjectContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>select</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="SelectQuery.html" title="type parameter in SelectQuery">T</a>> select​(<a href="../ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="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="Select.html#select(org.apache.cayenne.ObjectContext)">select</a></code> in interface <code><a href="Select.html" title="interface in org.apache.cayenne.query">Select</a><<a href="SelectQuery.html" title="type parameter in SelectQuery">T</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="selectOne(org.apache.cayenne.ObjectContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>selectOne</h4> |
| <pre class="methodSignature">public <a href="SelectQuery.html" title="type parameter in SelectQuery">T</a> selectOne​(<a href="../ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="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="../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="Select.html#selectOne(org.apache.cayenne.ObjectContext)">selectOne</a></code> in interface <code><a href="Select.html" title="interface in org.apache.cayenne.query">Select</a><<a href="SelectQuery.html" title="type parameter in SelectQuery">T</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="selectFirst(org.apache.cayenne.ObjectContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>selectFirst</h4> |
| <pre class="methodSignature">public <a href="SelectQuery.html" title="type parameter in SelectQuery">T</a> selectFirst​(<a href="../ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="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="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="Select.html#selectFirst(org.apache.cayenne.ObjectContext)">selectFirst</a></code> in interface <code><a href="Select.html" title="interface in org.apache.cayenne.query">Select</a><<a href="SelectQuery.html" title="type parameter in SelectQuery">T</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="iterate(org.apache.cayenne.ObjectContext,org.apache.cayenne.ResultIteratorCallback)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>iterate</h4> |
| <pre class="methodSignature">public void iterate​(<a href="../ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context, |
| <a href="../ResultIteratorCallback.html" title="interface in org.apache.cayenne">ResultIteratorCallback</a><<a href="SelectQuery.html" title="type parameter in SelectQuery">T</a>> callback)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="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="Select.html#iterate(org.apache.cayenne.ObjectContext,org.apache.cayenne.ResultIteratorCallback)">iterate</a></code> in interface <code><a href="Select.html" title="interface in org.apache.cayenne.query">Select</a><<a href="SelectQuery.html" title="type parameter in SelectQuery">T</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="iterator(org.apache.cayenne.ObjectContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>iterator</h4> |
| <pre class="methodSignature">public <a href="../ResultIterator.html" title="interface in org.apache.cayenne">ResultIterator</a><<a href="SelectQuery.html" title="type parameter in SelectQuery">T</a>> iterator​(<a href="../ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="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="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="Select.html#iterator(org.apache.cayenne.ObjectContext)">iterator</a></code> in interface <code><a href="Select.html" title="interface in org.apache.cayenne.query">Select</a><<a href="SelectQuery.html" title="type parameter in SelectQuery">T</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="batchIterator(org.apache.cayenne.ObjectContext,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>batchIterator</h4> |
| <pre class="methodSignature">public <a href="../ResultBatchIterator.html" title="class in org.apache.cayenne">ResultBatchIterator</a><<a href="SelectQuery.html" title="type parameter in SelectQuery">T</a>> batchIterator​(<a href="../ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context, |
| int size)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="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="Select.html#batchIterator(org.apache.cayenne.ObjectContext,int)">batchIterator</a></code> in interface <code><a href="Select.html" title="interface in org.apache.cayenne.query">Select</a><<a href="SelectQuery.html" title="type parameter in SelectQuery">T</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMetaData(org.apache.cayenne.map.EntityResolver)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMetaData</h4> |
| <pre class="methodSignature">public <a href="QueryMetadata.html" title="interface in org.apache.cayenne.query">QueryMetadata</a> getMetaData​(<a href="../map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a> resolver)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="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="Query.html#getMetaData(org.apache.cayenne.map.EntityResolver)">getMetaData</a></code> in interface <code><a href="Query.html" title="interface in org.apache.cayenne.query">Query</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="AbstractQuery.html#getMetaData(org.apache.cayenne.map.EntityResolver)">getMetaData</a></code> in class <code><a href="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 id="route(org.apache.cayenne.query.QueryRouter,org.apache.cayenne.map.EntityResolver,org.apache.cayenne.query.Query)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>route</h4> |
| <pre class="methodSignature">public void route​(<a href="QueryRouter.html" title="interface in org.apache.cayenne.query">QueryRouter</a> router, |
| <a href="../map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a> resolver, |
| <a href="Query.html" title="interface in org.apache.cayenne.query">Query</a> substitutedQuery)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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="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="Query.html" title="interface in org.apache.cayenne.query">Query</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="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="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 id="createSQLAction(org.apache.cayenne.query.SQLActionVisitor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createSQLAction</h4> |
| <pre class="methodSignature">public <a href="SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</a> createSQLAction​(<a href="SQLActionVisitor.html" title="interface in org.apache.cayenne.query">SQLActionVisitor</a> visitor)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Calls "makeSelect" on the visitor.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Query.html#createSQLAction(org.apache.cayenne.query.SQLActionVisitor)">createSQLAction</a></code> in interface <code><a href="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="AbstractQuery.html#createSQLAction(org.apache.cayenne.query.SQLActionVisitor)">createSQLAction</a></code> in class <code><a href="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 id="initWithProperties(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initWithProperties</h4> |
| <pre class="methodSignature">public void initWithProperties​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​?> properties)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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 id="queryWithParameters(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>queryWithParameters</h4> |
| <pre class="methodSignature">public <a href="SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><<a href="SelectQuery.html" title="type parameter in SelectQuery">T</a>> queryWithParameters​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​?> parameters)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">A shortcut for <a href="#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 id="queryWithParameters(java.util.Map,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>queryWithParameters</h4> |
| <pre class="methodSignature">public <a href="SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><<a href="SelectQuery.html" title="type parameter in SelectQuery">T</a>> queryWithParameters​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​?> parameters, |
| boolean pruneMissing)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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="../exp/Expression.html#params(java.util.Map,boolean)"><code>parameter substitution.</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createQuery(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createQuery</h4> |
| <pre class="methodSignature">public <a href="SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a><<a href="SelectQuery.html" title="type parameter in SelectQuery">T</a>> createQuery​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​?> parameters)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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="ParameterizedQuery.html#createQuery(java.util.Map)">createQuery</a></code> in interface <code><a href="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 id="addOrdering(org.apache.cayenne.query.Ordering)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addOrdering</h4> |
| <pre class="methodSignature">public void addOrdering​(<a href="Ordering.html" title="class in org.apache.cayenne.query">Ordering</a> ordering)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Adds ordering specification to this query orderings.</div> |
| </li> |
| </ul> |
| <a id="addOrderings(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addOrderings</h4> |
| <pre class="methodSignature">public void addOrderings​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><? extends <a href="Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Adds a list of orderings.</div> |
| </li> |
| </ul> |
| <a id="addOrdering(java.lang.String,org.apache.cayenne.query.SortOrder)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addOrdering</h4> |
| <pre class="methodSignature">public void addOrdering​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sortPathSpec, |
| <a href="SortOrder.html" title="enum in org.apache.cayenne.query">SortOrder</a> order)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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 id="removeOrdering(org.apache.cayenne.query.Ordering)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeOrdering</h4> |
| <pre class="methodSignature">public void removeOrdering​(<a href="Ordering.html" title="class in org.apache.cayenne.query">Ordering</a> ordering)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Removes ordering.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getOrderings()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOrderings</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> getOrderings()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Returns a list of orderings used by this query.</div> |
| </li> |
| </ul> |
| <a id="clearOrderings()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearOrderings</h4> |
| <pre class="methodSignature">public void clearOrderings()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Clears all configured orderings.</div> |
| </li> |
| </ul> |
| <a id="isDistinct()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDistinct</h4> |
| <pre class="methodSignature">public boolean isDistinct()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Returns true if this query returns distinct rows.</div> |
| </li> |
| </ul> |
| <a id="setDistinct(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDistinct</h4> |
| <pre class="methodSignature">public void setDistinct​(boolean distinct)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Sets <code>distinct</code> property that determines whether this query |
| returns distinct row.</div> |
| </li> |
| </ul> |
| <a id="setSuppressDistinct(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSuppressDistinct</h4> |
| <pre class="methodSignature">public void setSuppressDistinct​(boolean suppressDistinct)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Sets <code>distinct</code> property that determines whether this query |
| returns distinct row.</div> |
| </li> |
| </ul> |
| <a id="aliasPathSplits(java.lang.String,java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>aliasPathSplits</h4> |
| <pre class="methodSignature">public void aliasPathSplits​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> path, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>... aliases)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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="../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 id="getPrefetchTree()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrefetchTree</h4> |
| <pre class="methodSignature">public <a href="PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a> getPrefetchTree()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setPrefetchTree(org.apache.cayenne.query.PrefetchTreeNode)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPrefetchTree</h4> |
| <pre class="methodSignature">public void setPrefetchTree​(<a href="PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a> prefetchTree)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addPrefetch(org.apache.cayenne.query.PrefetchTreeNode)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addPrefetch</h4> |
| <pre class="methodSignature">public void addPrefetch​(<a href="PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a> prefetchElement)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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 id="addPrefetch(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addPrefetch</h4> |
| <pre class="methodSignature">public <a href="PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a> addPrefetch​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> prefetchPath)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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 id="clearPrefetches()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearPrefetches</h4> |
| <pre class="methodSignature">public void clearPrefetches()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Clears all stored prefetch paths.</div> |
| </li> |
| </ul> |
| <a id="removePrefetch(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removePrefetch</h4> |
| <pre class="methodSignature">public void removePrefetch​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> prefetchPath)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Removes prefetch.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isFetchingDataRows()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isFetchingDataRows</h4> |
| <pre class="methodSignature">public boolean isFetchingDataRows()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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 id="setFetchingDataRows(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFetchingDataRows</h4> |
| <pre class="methodSignature">public void setFetchingDataRows​(boolean flag)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">since 4.0, use <a href="#dataRowQuery(java.lang.Class,org.apache.cayenne.exp.Expression)"><code>dataRowQuery(Class, Expression)</code></a> to |
| create DataRow query instead.</div> |
| </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="../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 id="getFetchOffset()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFetchOffset</h4> |
| <pre class="methodSignature">public int getFetchOffset()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Returns the fetchOffset.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getFetchLimit()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFetchLimit</h4> |
| <pre class="methodSignature">public int getFetchLimit()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Returns the fetchLimit.</div> |
| </li> |
| </ul> |
| <a id="setFetchLimit(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFetchLimit</h4> |
| <pre class="methodSignature">public void setFetchLimit​(int fetchLimit)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Sets the fetchLimit.</div> |
| </li> |
| </ul> |
| <a id="setFetchOffset(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFetchOffset</h4> |
| <pre class="methodSignature">public void setFetchOffset​(int fetchOffset)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPageSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPageSize</h4> |
| <pre class="methodSignature">public int getPageSize()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Returns <code>pageSize</code> property. See setPageSize for more details.</div> |
| </li> |
| </ul> |
| <a id="setPageSize(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPageSize</h4> |
| <pre class="methodSignature">public void setPageSize​(int pageSize)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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 id="setStatementFetchSize(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStatementFetchSize</h4> |
| <pre class="methodSignature">public void setStatementFetchSize​(int size)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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 id="getStatementFetchSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStatementFetchSize</h4> |
| <pre class="methodSignature">public int getStatementFetchSize()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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 id="setQualifier(org.apache.cayenne.exp.Expression)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setQualifier</h4> |
| <pre class="methodSignature">public void setQualifier​(<a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Sets new query qualifier.</div> |
| </li> |
| </ul> |
| <a id="getQualifier()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQualifier</h4> |
| <pre class="methodSignature">public <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> getQualifier()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Returns query qualifier.</div> |
| </li> |
| </ul> |
| <a id="andQualifier(org.apache.cayenne.exp.Expression)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>andQualifier</h4> |
| <pre class="methodSignature">public void andQualifier​(<a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> e)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Adds specified qualifier to the existing qualifier joining it using |
| "AND".</div> |
| </li> |
| </ul> |
| <a id="orQualifier(org.apache.cayenne.exp.Expression)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>orQualifier</h4> |
| <pre class="methodSignature">public void orQualifier​(<a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> e)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Adds specified qualifier to the existing qualifier joining it using "OR".</div> |
| </li> |
| </ul> |
| <a id="setColumns(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setColumns</h4> |
| <pre class="methodSignature">public void setColumns​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="../exp/property/Property.html" title="interface in org.apache.cayenne.exp.property">Property</a><?>> columns)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#setCanReturnScalarValue(boolean)"><code>setCanReturnScalarValue(boolean)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setColumns(org.apache.cayenne.exp.property.Property...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setColumns</h4> |
| <pre class="methodSignature">public void setColumns​(<a href="../exp/property/Property.html" title="interface in org.apache.cayenne.exp.property">Property</a><?>... columns)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setCanReturnScalarValue(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCanReturnScalarValue</h4> |
| <pre class="methodSignature">public void setCanReturnScalarValue​(boolean canReturnScalarValue)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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="#setColumns(java.util.Collection)"><code>setColumns(java.util.Collection<org.apache.cayenne.exp.property.Property<?>>)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="canReturnScalarValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>canReturnScalarValue</h4> |
| <pre class="methodSignature">public boolean canReturnScalarValue()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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 id="getColumns()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getColumns</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="../exp/property/Property.html" title="interface in org.apache.cayenne.exp.property">Property</a><?>> getColumns()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setHavingQualifier(org.apache.cayenne.exp.Expression)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHavingQualifier</h4> |
| <pre class="methodSignature">public void setHavingQualifier​(<a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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 id="getHavingQualifier()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHavingQualifier</h4> |
| <pre class="methodSignature">public <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> getHavingQualifier()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Returns query HAVING qualifier.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="andHavingQualifier(org.apache.cayenne.exp.Expression)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>andHavingQualifier</h4> |
| <pre class="methodSignature">public void andHavingQualifier​(<a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> e)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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 id="orHavingQualifier(org.apache.cayenne.exp.Expression)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>orHavingQualifier</h4> |
| <pre class="methodSignature">public void orHavingQualifier​(<a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> e)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <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 id="getBaseMetaData()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getBaseMetaData</h4> |
| <pre class="methodSignature">protected org.apache.cayenne.query.BaseQueryMetadata getBaseMetaData()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="CacheableQuery.html#getBaseMetaData()">getBaseMetaData</a></code> in class <code><a href="CacheableQuery.html" title="class in org.apache.cayenne.query">CacheableQuery</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/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 class="aboutLanguage"><a href="http://cayenne.apache.org" target="top">Apache Cayenne</a></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2001–2022 <a href="https://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |