| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_67) on Sat Sep 20 17:22:59 FET 2014 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>SelectQuery (Cayenne Documentation 3.1 API)</title> |
| <meta name="date" content="2014-09-20"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SelectQuery (Cayenne Documentation 3.1 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/SelectQuery.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/cayenne/query/ScalarResultSegment.html" title="interface in org.apache.cayenne.query"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/cayenne/query/SortOrder.html" title="enum in org.apache.cayenne.query"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/cayenne/query/SelectQuery.html" target="_top">Frames</a></li> |
| <li><a href="SelectQuery.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.cayenne.query</div> |
| <h2 title="Class SelectQuery" class="title">Class SelectQuery</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">org.apache.cayenne.query.AbstractQuery</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../org/apache/cayenne/query/QualifiedQuery.html" title="class in org.apache.cayenne.query">org.apache.cayenne.query.QualifiedQuery</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.cayenne.query.SelectQuery</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../../org/apache/cayenne/configuration/ConfigurationNode.html" title="interface in org.apache.cayenne.configuration">ConfigurationNode</a>, <a href="../../../../org/apache/cayenne/query/ParameterizedQuery.html" title="interface in org.apache.cayenne.query">ParameterizedQuery</a>, <a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a>, <a href="../../../../org/apache/cayenne/util/XMLSerializable.html" title="interface in org.apache.cayenne.util">XMLSerializable</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/apache/cayenne/query/PrefetchSelectQuery.html" title="class in org.apache.cayenne.query">PrefetchSelectQuery</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">SelectQuery</span> |
| extends <a href="../../../../org/apache/cayenne/query/QualifiedQuery.html" title="class in org.apache.cayenne.query">QualifiedQuery</a> |
| implements <a href="../../../../org/apache/cayenne/query/ParameterizedQuery.html" title="interface in org.apache.cayenne.query">ParameterizedQuery</a>, <a href="../../../../org/apache/cayenne/util/XMLSerializable.html" title="interface in org.apache.cayenne.util">XMLSerializable</a></pre> |
| <div class="block">A query that selects persistent objects of a certain type or "raw data" (aka DataRows). |
| Supports expression qualifier, multiple orderings and a number of other parameters that |
| serve as runtime hints to Cayenne on how to optimize the fetch and result processing.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#org.apache.cayenne.query.SelectQuery">Serialized Form</a></dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#distinct">distinct</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#DISTINCT_DEFAULT">DISTINCT_DEFAULT</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#DISTINCT_PROPERTY">DISTINCT_PROPERTY</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#orderings">orderings</a></strong></code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields_inherited_from_class_org.apache.cayenne.query.QualifiedQuery"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.cayenne.query.<a href="../../../../org/apache/cayenne/query/QualifiedQuery.html" title="class in org.apache.cayenne.query">QualifiedQuery</a></h3> |
| <code><a href="../../../../org/apache/cayenne/query/QualifiedQuery.html#qualifier">qualifier</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields_inherited_from_class_org.apache.cayenne.query.AbstractQuery"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.cayenne.query.<a href="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</a></h3> |
| <code><a href="../../../../org/apache/cayenne/query/AbstractQuery.html#dataMap">dataMap</a>, <a href="../../../../org/apache/cayenne/query/AbstractQuery.html#name">name</a>, <a href="../../../../org/apache/cayenne/query/AbstractQuery.html#root">root</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery()">SelectQuery</a></strong>()</code> |
| <div class="block">Creates an empty SelectQuery.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery(java.lang.Class)">SelectQuery</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> rootClass)</code> |
| <div class="block">Creates a SelectQuery that selects all objects of a given persistent class.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery(java.lang.Class,%20org.apache.cayenne.exp.Expression)">SelectQuery</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> rootClass, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</code> |
| <div class="block">Creates a SelectQuery that selects objects of a given persistent class that match |
| supplied qualifier.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery(java.lang.Class,%20org.apache.cayenne.exp.Expression,%20java.util.List)">SelectQuery</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> rootClass, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</code> |
| <div class="block">Creates a SelectQuery that selects objects of a given persistent class that match |
| supplied qualifier.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery(org.apache.cayenne.map.DbEntity)">SelectQuery</a></strong>(<a href="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> root)</code> |
| <div class="block">Creates a SelectQuery for the specified DbEntity.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery(org.apache.cayenne.map.DbEntity,%20org.apache.cayenne.exp.Expression)">SelectQuery</a></strong>(<a href="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> root, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</code> |
| <div class="block">Creates a SelectQuery for the specified DbEntity with the given qualifier.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery(org.apache.cayenne.map.DbEntity,%20org.apache.cayenne.exp.Expression,%20java.util.List)">SelectQuery</a></strong>(<a href="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> root, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</code> |
| <div class="block">Creates a SelectQuery for the specified DbEntity with the given qualifier and orderings.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery(org.apache.cayenne.map.ObjEntity)">SelectQuery</a></strong>(<a href="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a> root)</code> |
| <div class="block">Creates a SelectQuery with null qualifier, for the specifed ObjEntity</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery(org.apache.cayenne.map.ObjEntity,%20org.apache.cayenne.exp.Expression)">SelectQuery</a></strong>(<a href="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a> root, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</code> |
| <div class="block">Creates a SelectQuery for the specified ObjEntity with the given qualifier.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery(org.apache.cayenne.map.ObjEntity,%20org.apache.cayenne.exp.Expression,%20java.util.List)">SelectQuery</a></strong>(<a href="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a> root, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</code> |
| <div class="block">Creates a SelectQuery for the specified ObjEntity with the given |
| qualifier and orderings.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery(java.lang.String)">SelectQuery</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> objEntityName)</code> |
| <div class="block">Creates SelectQuery with <code>objEntityName</code> parameter.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery(java.lang.String,%20org.apache.cayenne.exp.Expression)">SelectQuery</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> objEntityName, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</code> |
| <div class="block">Creates SelectQuery with <code>objEntityName</code> and <code>qualifier</code> |
| parameters.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery(java.lang.String,%20org.apache.cayenne.exp.Expression,%20java.util.List)">SelectQuery</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> objEntityName, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</code> |
| <div class="block">Creates a SelectQuery that selects objects of a given persistent class that match |
| supplied qualifier.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#addOrdering(org.apache.cayenne.query.Ordering)">addOrdering</a></strong>(<a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a> ordering)</code> |
| <div class="block">Adds ordering specification to this query orderings.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#addOrdering(java.lang.String,%20org.apache.cayenne.query.SortOrder)">addOrdering</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sortPathSpec, |
| <a href="../../../../org/apache/cayenne/query/SortOrder.html" title="enum in org.apache.cayenne.query">SortOrder</a> order)</code> |
| <div class="block">Adds ordering specification to this query orderings.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#addOrderings(java.util.List)">addOrderings</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</code> |
| <div class="block">Adds a list of orderings.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#addPrefetch(java.lang.String)">addPrefetch</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefetchPath)</code> |
| <div class="block">Adds a prefetch with specified relationship path to the query.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#aliasPathSplits(java.lang.String,%20java.lang.String...)">aliasPathSplits</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... aliases)</code> |
| <div class="block">Adds one or more aliases for the qualifier expression path.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#clearOrderings()">clearOrderings</a></strong>()</code> |
| <div class="block">Clears all configured orderings.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#clearPrefetches()">clearPrefetches</a></strong>()</code> |
| <div class="block">Clears all stored prefetch paths.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#createQuery(java.util.Map)">createQuery</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> parameters)</code> |
| <div class="block">Creates and returns a new SelectQuery built using this query as a prototype and |
| substituting qualifier parameters with the values from the map.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#createSQLAction(org.apache.cayenne.query.SQLActionVisitor)">createSQLAction</a></strong>(<a href="../../../../org/apache/cayenne/query/SQLActionVisitor.html" title="interface in org.apache.cayenne.query">SQLActionVisitor</a> visitor)</code> |
| <div class="block">Calls "makeSelect" on the visitor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#encodeAsXML(org.apache.cayenne.util.XMLEncoder)">encodeAsXML</a></strong>(<a href="../../../../org/apache/cayenne/util/XMLEncoder.html" title="class in org.apache.cayenne.util">XMLEncoder</a> encoder)</code> |
| <div class="block">Prints itself as XML to the provided PrintWriter.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#getCacheGroups()">getCacheGroups</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/QueryCacheStrategy.html" title="enum in org.apache.cayenne.query">QueryCacheStrategy</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#getCacheStrategy()">getCacheStrategy</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#getFetchLimit()">getFetchLimit</a></strong>()</code> |
| <div class="block">Returns the fetchLimit.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#getFetchOffset()">getFetchOffset</a></strong>()</code> |
| <div class="block">Returns the fetchOffset.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/QueryMetadata.html" title="interface in org.apache.cayenne.query">QueryMetadata</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#getMetaData(org.apache.cayenne.map.EntityResolver)">getMetaData</a></strong>(<a href="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a> resolver)</code> |
| <div class="block">Returns default select parameters.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#getOrderings()">getOrderings</a></strong>()</code> |
| <div class="block">Returns a list of orderings used by this query.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#getPageSize()">getPageSize</a></strong>()</code> |
| <div class="block">Returns <code>pageSize</code> property.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#getPrefetchTree()">getPrefetchTree</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#getStatementFetchSize()">getStatementFetchSize</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#initWithProperties(java.util.Map)">initWithProperties</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> properties)</code> |
| <div class="block">Initializes query parameters using a set of properties.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#isDistinct()">isDistinct</a></strong>()</code> |
| <div class="block">Returns true if this query returns distinct rows.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#isFetchingDataRows()">isFetchingDataRows</a></strong>()</code> |
| <div class="block">Returns <code>true</code> if this query should produce a list of data rows as |
| opposed to DataObjects, <code>false</code> for DataObjects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#queryWithParameters(java.util.Map)">queryWithParameters</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> parameters)</code> |
| <div class="block">A shortcut for <a href="../../../../org/apache/cayenne/query/SelectQuery.html#queryWithParameters(java.util.Map,%20boolean)"><code>queryWithParameters(Map, boolean)</code></a>that prunes parts of |
| qualifier that have no parameter value set.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#queryWithParameters(java.util.Map,%20boolean)">queryWithParameters</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> parameters, |
| boolean pruneMissing)</code> |
| <div class="block">Returns a query built using this query as a prototype, using a set of parameters to |
| build the qualifier.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#removeOrdering(org.apache.cayenne.query.Ordering)">removeOrdering</a></strong>(<a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a> ordering)</code> |
| <div class="block">Removes ordering.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#removePrefetch(java.lang.String)">removePrefetch</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefetchPath)</code> |
| <div class="block">Removes prefetch.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#route(org.apache.cayenne.query.QueryRouter,%20org.apache.cayenne.map.EntityResolver,%20org.apache.cayenne.query.Query)">route</a></strong>(<a href="../../../../org/apache/cayenne/query/QueryRouter.html" title="interface in org.apache.cayenne.query">QueryRouter</a> router, |
| <a href="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a> resolver, |
| <a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a> substitutedQuery)</code> |
| <div class="block">Routes itself and if there are any prefetches configured, creates prefetch queries |
| and routes them as well.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#setCacheGroups(java.lang.String...)">setCacheGroups</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... cacheGroups)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#setCacheStrategy(org.apache.cayenne.query.QueryCacheStrategy)">setCacheStrategy</a></strong>(<a href="../../../../org/apache/cayenne/query/QueryCacheStrategy.html" title="enum in org.apache.cayenne.query">QueryCacheStrategy</a> strategy)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#setDistinct(boolean)">setDistinct</a></strong>(boolean distinct)</code> |
| <div class="block">Sets <code>distinct</code> property that determines whether this query returns |
| distinct row.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#setFetchingDataRows(boolean)">setFetchingDataRows</a></strong>(boolean flag)</code> |
| <div class="block">Sets query result type.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#setFetchLimit(int)">setFetchLimit</a></strong>(int fetchLimit)</code> |
| <div class="block">Sets the fetchLimit.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#setFetchOffset(int)">setFetchOffset</a></strong>(int fetchOffset)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#setPageSize(int)">setPageSize</a></strong>(int pageSize)</code> |
| <div class="block">Sets <code>pageSize</code> property.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#setPrefetchTree(org.apache.cayenne.query.PrefetchTreeNode)">setPrefetchTree</a></strong>(<a href="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a> prefetchTree)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/SelectQuery.html#setStatementFetchSize(int)">setStatementFetchSize</a></strong>(int size)</code> |
| <div class="block">Sets statement's fetch size (0 for default size)</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.cayenne.query.QualifiedQuery"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.cayenne.query.<a href="../../../../org/apache/cayenne/query/QualifiedQuery.html" title="class in org.apache.cayenne.query">QualifiedQuery</a></h3> |
| <code><a href="../../../../org/apache/cayenne/query/QualifiedQuery.html#andQualifier(org.apache.cayenne.exp.Expression)">andQualifier</a>, <a href="../../../../org/apache/cayenne/query/QualifiedQuery.html#getQualifier()">getQualifier</a>, <a href="../../../../org/apache/cayenne/query/QualifiedQuery.html#orQualifier(org.apache.cayenne.exp.Expression)">orQualifier</a>, <a href="../../../../org/apache/cayenne/query/QualifiedQuery.html#setQualifier(org.apache.cayenne.exp.Expression)">setQualifier</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.cayenne.query.AbstractQuery"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.cayenne.query.<a href="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</a></h3> |
| <code><a href="../../../../org/apache/cayenne/query/AbstractQuery.html#acceptVisitor(org.apache.cayenne.configuration.ConfigurationNodeVisitor)">acceptVisitor</a>, <a href="../../../../org/apache/cayenne/query/AbstractQuery.html#getDataMap()">getDataMap</a>, <a href="../../../../org/apache/cayenne/query/AbstractQuery.html#getName()">getName</a>, <a href="../../../../org/apache/cayenne/query/AbstractQuery.html#getRoot()">getRoot</a>, <a href="../../../../org/apache/cayenne/query/AbstractQuery.html#setDataMap(org.apache.cayenne.map.DataMap)">setDataMap</a>, <a href="../../../../org/apache/cayenne/query/AbstractQuery.html#setName(java.lang.String)">setName</a>, <a href="../../../../org/apache/cayenne/query/AbstractQuery.html#setRoot(java.lang.Object)">setRoot</a>, <a href="../../../../org/apache/cayenne/query/AbstractQuery.html#toString()">toString</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.cayenne.query.Query"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.cayenne.query.<a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a></h3> |
| <code><a href="../../../../org/apache/cayenne/query/Query.html#getDataMap()">getDataMap</a>, <a href="../../../../org/apache/cayenne/query/Query.html#getName()">getName</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.cayenne.configuration.ConfigurationNode"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.cayenne.configuration.<a href="../../../../org/apache/cayenne/configuration/ConfigurationNode.html" title="interface in org.apache.cayenne.configuration">ConfigurationNode</a></h3> |
| <code><a href="../../../../org/apache/cayenne/configuration/ConfigurationNode.html#acceptVisitor(org.apache.cayenne.configuration.ConfigurationNodeVisitor)">acceptVisitor</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="DISTINCT_PROPERTY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DISTINCT_PROPERTY</h4> |
| <pre>public static final <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DISTINCT_PROPERTY</pre> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cayenne.query.SelectQuery.DISTINCT_PROPERTY">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="DISTINCT_DEFAULT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DISTINCT_DEFAULT</h4> |
| <pre>public static final boolean DISTINCT_DEFAULT</pre> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cayenne.query.SelectQuery.DISTINCT_DEFAULT">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="orderings"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>orderings</h4> |
| <pre>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings</pre> |
| </li> |
| </ul> |
| <a name="distinct"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>distinct</h4> |
| <pre>protected boolean distinct</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="SelectQuery()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SelectQuery</h4> |
| <pre>public SelectQuery()</pre> |
| <div class="block">Creates an empty SelectQuery.</div> |
| </li> |
| </ul> |
| <a name="SelectQuery(org.apache.cayenne.map.ObjEntity)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SelectQuery</h4> |
| <pre>public SelectQuery(<a href="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a> root)</pre> |
| <div class="block">Creates a SelectQuery with null qualifier, for the specifed ObjEntity</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>root</code> - the ObjEntity this SelectQuery is for.</dd></dl> |
| </li> |
| </ul> |
| <a name="SelectQuery(org.apache.cayenne.map.ObjEntity, org.apache.cayenne.exp.Expression)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SelectQuery</h4> |
| <pre>public SelectQuery(<a href="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a> root, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</pre> |
| <div class="block">Creates a SelectQuery for the specified ObjEntity with the given qualifier.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>root</code> - the ObjEntity this SelectQuery is for.</dd><dd><code>qualifier</code> - an Expression indicating which objects should be fetched</dd></dl> |
| </li> |
| </ul> |
| <a name="SelectQuery(org.apache.cayenne.map.ObjEntity, org.apache.cayenne.exp.Expression, java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SelectQuery</h4> |
| <pre>public SelectQuery(<a href="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a> root, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</pre> |
| <div class="block">Creates a SelectQuery for the specified ObjEntity with the given |
| qualifier and orderings.</div> |
| <dl><dt><span class="strong">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="strong">Since:</span></dt> |
| <dd>3.1</dd></dl> |
| </li> |
| </ul> |
| <a name="SelectQuery(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SelectQuery</h4> |
| <pre>public SelectQuery(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> rootClass)</pre> |
| <div class="block">Creates a SelectQuery that selects all objects of a given persistent class.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>rootClass</code> - the Class of objects fetched by this query.</dd></dl> |
| </li> |
| </ul> |
| <a name="SelectQuery(java.lang.Class, org.apache.cayenne.exp.Expression)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SelectQuery</h4> |
| <pre>public SelectQuery(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> rootClass, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</pre> |
| <div class="block">Creates a SelectQuery that selects objects of a given persistent class that match |
| supplied qualifier.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>rootClass</code> - the Class of objects fetched by this query.</dd><dd><code>qualifier</code> - an Expression indicating which objects should be fetched.</dd></dl> |
| </li> |
| </ul> |
| <a name="SelectQuery(java.lang.Class, org.apache.cayenne.exp.Expression, java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SelectQuery</h4> |
| <pre>public SelectQuery(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> rootClass, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</pre> |
| <div class="block">Creates a SelectQuery that selects objects of a given persistent class that match |
| supplied qualifier.</div> |
| <dl><dt><span class="strong">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="strong">Since:</span></dt> |
| <dd>3.1</dd></dl> |
| </li> |
| </ul> |
| <a name="SelectQuery(org.apache.cayenne.map.DbEntity)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SelectQuery</h4> |
| <pre>public SelectQuery(<a href="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> root)</pre> |
| <div class="block">Creates a SelectQuery for the specified DbEntity.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>root</code> - the DbEntity this SelectQuery is for.</dd><dt><span class="strong">Since:</span></dt> |
| <dd>1.1</dd></dl> |
| </li> |
| </ul> |
| <a name="SelectQuery(org.apache.cayenne.map.DbEntity, org.apache.cayenne.exp.Expression)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SelectQuery</h4> |
| <pre>public SelectQuery(<a href="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> root, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</pre> |
| <div class="block">Creates a SelectQuery for the specified DbEntity with the given qualifier.</div> |
| <dl><dt><span class="strong">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="strong">Since:</span></dt> |
| <dd>1.1</dd></dl> |
| </li> |
| </ul> |
| <a name="SelectQuery(org.apache.cayenne.map.DbEntity, org.apache.cayenne.exp.Expression, java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SelectQuery</h4> |
| <pre>public SelectQuery(<a href="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> root, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</pre> |
| <div class="block">Creates a SelectQuery for the specified DbEntity with the given qualifier and orderings.</div> |
| <dl><dt><span class="strong">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="strong">Since:</span></dt> |
| <dd>3.1</dd></dl> |
| </li> |
| </ul> |
| <a name="SelectQuery(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SelectQuery</h4> |
| <pre>public SelectQuery(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> objEntityName)</pre> |
| <div class="block">Creates SelectQuery with <code>objEntityName</code> parameter.</div> |
| </li> |
| </ul> |
| <a name="SelectQuery(java.lang.String, org.apache.cayenne.exp.Expression)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SelectQuery</h4> |
| <pre>public SelectQuery(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> objEntityName, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</pre> |
| <div class="block">Creates SelectQuery with <code>objEntityName</code> and <code>qualifier</code> |
| parameters.</div> |
| </li> |
| </ul> |
| <a name="SelectQuery(java.lang.String, org.apache.cayenne.exp.Expression, java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SelectQuery</h4> |
| <pre>public SelectQuery(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> objEntityName, |
| <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</pre> |
| <div class="block">Creates a SelectQuery that selects objects of a given persistent class that match |
| supplied qualifier.</div> |
| <dl><dt><span class="strong">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="strong">Since:</span></dt> |
| <dd>3.1</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getMetaData(org.apache.cayenne.map.EntityResolver)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMetaData</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/query/QueryMetadata.html" title="interface in org.apache.cayenne.query">QueryMetadata</a> getMetaData(<a href="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a> resolver)</pre> |
| <div class="block"><strong>Description copied from class: <code><a href="../../../../org/apache/cayenne/query/AbstractQuery.html#getMetaData(org.apache.cayenne.map.EntityResolver)">AbstractQuery</a></code></strong></div> |
| <div class="block">Returns default select parameters.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/query/Query.html#getMetaData(org.apache.cayenne.map.EntityResolver)">getMetaData</a></code> in interface <code><a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a></code></dd> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/query/AbstractQuery.html#getMetaData(org.apache.cayenne.map.EntityResolver)">getMetaData</a></code> in class <code><a href="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</a></code></dd> |
| <dt><span class="strong">Since:</span></dt> |
| <dd>1.2</dd></dl> |
| </li> |
| </ul> |
| <a name="route(org.apache.cayenne.query.QueryRouter, org.apache.cayenne.map.EntityResolver, org.apache.cayenne.query.Query)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>route</h4> |
| <pre>public void route(<a href="../../../../org/apache/cayenne/query/QueryRouter.html" title="interface in org.apache.cayenne.query">QueryRouter</a> router, |
| <a href="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a> resolver, |
| <a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a> substitutedQuery)</pre> |
| <div class="block">Routes itself and if there are any prefetches configured, creates prefetch queries |
| and routes them as well.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/query/Query.html#route(org.apache.cayenne.query.QueryRouter,%20org.apache.cayenne.map.EntityResolver,%20org.apache.cayenne.query.Query)">route</a></code> in interface <code><a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a></code></dd> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/query/AbstractQuery.html#route(org.apache.cayenne.query.QueryRouter,%20org.apache.cayenne.map.EntityResolver,%20org.apache.cayenne.query.Query)">route</a></code> in class <code><a href="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</a></code></dd> |
| <dt><span class="strong">Since:</span></dt> |
| <dd>1.2</dd></dl> |
| </li> |
| </ul> |
| <a name="createSQLAction(org.apache.cayenne.query.SQLActionVisitor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createSQLAction</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</a> createSQLAction(<a href="../../../../org/apache/cayenne/query/SQLActionVisitor.html" title="interface in org.apache.cayenne.query">SQLActionVisitor</a> visitor)</pre> |
| <div class="block">Calls "makeSelect" on the visitor.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/query/Query.html#createSQLAction(org.apache.cayenne.query.SQLActionVisitor)">createSQLAction</a></code> in interface <code><a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a></code></dd> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/query/AbstractQuery.html#createSQLAction(org.apache.cayenne.query.SQLActionVisitor)">createSQLAction</a></code> in class <code><a href="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</a></code></dd> |
| <dt><span class="strong">Since:</span></dt> |
| <dd>1.2</dd></dl> |
| </li> |
| </ul> |
| <a name="initWithProperties(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initWithProperties</h4> |
| <pre>public void initWithProperties(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> properties)</pre> |
| <div class="block">Initializes query parameters using a set of properties.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.1</dd></dl> |
| </li> |
| </ul> |
| <a name="encodeAsXML(org.apache.cayenne.util.XMLEncoder)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>encodeAsXML</h4> |
| <pre>public void encodeAsXML(<a href="../../../../org/apache/cayenne/util/XMLEncoder.html" title="class in org.apache.cayenne.util">XMLEncoder</a> encoder)</pre> |
| <div class="block">Prints itself as XML to the provided PrintWriter.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/util/XMLSerializable.html#encodeAsXML(org.apache.cayenne.util.XMLEncoder)">encodeAsXML</a></code> in interface <code><a href="../../../../org/apache/cayenne/util/XMLSerializable.html" title="interface in org.apache.cayenne.util">XMLSerializable</a></code></dd> |
| <dt><span class="strong">Since:</span></dt> |
| <dd>1.1</dd></dl> |
| </li> |
| </ul> |
| <a name="queryWithParameters(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>queryWithParameters</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a> queryWithParameters(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> parameters)</pre> |
| <div class="block">A shortcut for <a href="../../../../org/apache/cayenne/query/SelectQuery.html#queryWithParameters(java.util.Map,%20boolean)"><code>queryWithParameters(Map, boolean)</code></a>that prunes parts of |
| qualifier that have no parameter value set.</div> |
| </li> |
| </ul> |
| <a name="queryWithParameters(java.util.Map, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>queryWithParameters</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</a> queryWithParameters(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> parameters, |
| boolean pruneMissing)</pre> |
| <div class="block">Returns a query built using this query as a prototype, using a set of parameters to |
| build the qualifier.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/cayenne/exp/Expression.html#expWithParameters(java.util.Map,%20boolean)"><code>parameter substitution.</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="createQuery(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createQuery</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a> createQuery(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,?> parameters)</pre> |
| <div class="block">Creates and returns a new SelectQuery built using this query as a prototype and |
| substituting qualifier parameters with the values from the map.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/query/ParameterizedQuery.html#createQuery(java.util.Map)">createQuery</a></code> in interface <code><a href="../../../../org/apache/cayenne/query/ParameterizedQuery.html" title="interface in org.apache.cayenne.query">ParameterizedQuery</a></code></dd> |
| <dt><span class="strong">Since:</span></dt> |
| <dd>1.1</dd></dl> |
| </li> |
| </ul> |
| <a name="addOrdering(org.apache.cayenne.query.Ordering)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addOrdering</h4> |
| <pre>public void addOrdering(<a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a> ordering)</pre> |
| <div class="block">Adds ordering specification to this query orderings.</div> |
| </li> |
| </ul> |
| <a name="addOrderings(java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addOrderings</h4> |
| <pre>public void addOrderings(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> orderings)</pre> |
| <div class="block">Adds a list of orderings.</div> |
| </li> |
| </ul> |
| <a name="addOrdering(java.lang.String, org.apache.cayenne.query.SortOrder)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addOrdering</h4> |
| <pre>public void addOrdering(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sortPathSpec, |
| <a href="../../../../org/apache/cayenne/query/SortOrder.html" title="enum in org.apache.cayenne.query">SortOrder</a> order)</pre> |
| <div class="block">Adds ordering specification to this query orderings.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| <a name="removeOrdering(org.apache.cayenne.query.Ordering)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeOrdering</h4> |
| <pre>public void removeOrdering(<a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a> ordering)</pre> |
| <div class="block">Removes ordering.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.1</dd></dl> |
| </li> |
| </ul> |
| <a name="getOrderings()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOrderings</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>> getOrderings()</pre> |
| <div class="block">Returns a list of orderings used by this query.</div> |
| </li> |
| </ul> |
| <a name="clearOrderings()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearOrderings</h4> |
| <pre>public void clearOrderings()</pre> |
| <div class="block">Clears all configured orderings.</div> |
| </li> |
| </ul> |
| <a name="isDistinct()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDistinct</h4> |
| <pre>public boolean isDistinct()</pre> |
| <div class="block">Returns true if this query returns distinct rows.</div> |
| </li> |
| </ul> |
| <a name="setDistinct(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDistinct</h4> |
| <pre>public void setDistinct(boolean distinct)</pre> |
| <div class="block">Sets <code>distinct</code> property that determines whether this query returns |
| distinct row.</div> |
| </li> |
| </ul> |
| <a name="aliasPathSplits(java.lang.String, java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>aliasPathSplits</h4> |
| <pre>public void aliasPathSplits(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... aliases)</pre> |
| <div class="block">Adds one or more aliases for the qualifier expression path. Aliases serve to |
| instruct Cayenne to generate separate sets of joins for overlapping paths, that |
| maybe needed for complex conditions. An example of an <i>implicit</i> splits is this |
| method: <a href="../../../../org/apache/cayenne/exp/ExpressionFactory.html#matchAllExp(java.lang.String,%20java.lang.Object...)"><code>ExpressionFactory.matchAllExp(String, Object...)</code></a>.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getPrefetchTree()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrefetchTree</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a> getPrefetchTree()</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.2</dd></dl> |
| </li> |
| </ul> |
| <a name="setPrefetchTree(org.apache.cayenne.query.PrefetchTreeNode)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPrefetchTree</h4> |
| <pre>public void setPrefetchTree(<a href="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a> prefetchTree)</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.2</dd></dl> |
| </li> |
| </ul> |
| <a name="addPrefetch(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addPrefetch</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a> addPrefetch(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefetchPath)</pre> |
| <div class="block">Adds a prefetch with specified relationship path to the query.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.2 signature changed to return created PrefetchTreeNode.</dd></dl> |
| </li> |
| </ul> |
| <a name="clearPrefetches()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearPrefetches</h4> |
| <pre>public void clearPrefetches()</pre> |
| <div class="block">Clears all stored prefetch paths.</div> |
| </li> |
| </ul> |
| <a name="removePrefetch(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removePrefetch</h4> |
| <pre>public void removePrefetch(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> prefetchPath)</pre> |
| <div class="block">Removes prefetch.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.1</dd></dl> |
| </li> |
| </ul> |
| <a name="isFetchingDataRows()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isFetchingDataRows</h4> |
| <pre>public boolean isFetchingDataRows()</pre> |
| <div class="block">Returns <code>true</code> if this query should produce a list of data rows as |
| opposed to DataObjects, <code>false</code> for DataObjects. This is a hint to |
| QueryEngine executing this query.</div> |
| </li> |
| </ul> |
| <a name="setFetchingDataRows(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFetchingDataRows</h4> |
| <pre>public void setFetchingDataRows(boolean flag)</pre> |
| <div class="block">Sets query result type. If <code>flag</code> parameter is <code>true</code>, then |
| results will be in the form of data rows. |
| <p> |
| <i>Note that if the root of this query is a <a href="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map"><code>DbEntity</code></a>, this setting has no |
| effect, and data rows are always fetched. </i> |
| </p></div> |
| </li> |
| </ul> |
| <a name="getCacheStrategy()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCacheStrategy</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/query/QueryCacheStrategy.html" title="enum in org.apache.cayenne.query">QueryCacheStrategy</a> getCacheStrategy()</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| <a name="setCacheStrategy(org.apache.cayenne.query.QueryCacheStrategy)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCacheStrategy</h4> |
| <pre>public void setCacheStrategy(<a href="../../../../org/apache/cayenne/query/QueryCacheStrategy.html" title="enum in org.apache.cayenne.query">QueryCacheStrategy</a> strategy)</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getCacheGroups()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCacheGroups</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getCacheGroups()</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| <a name="setCacheGroups(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCacheGroups</h4> |
| <pre>public void setCacheGroups(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... cacheGroups)</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getFetchOffset()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFetchOffset</h4> |
| <pre>public int getFetchOffset()</pre> |
| <div class="block">Returns the fetchOffset.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getFetchLimit()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFetchLimit</h4> |
| <pre>public int getFetchLimit()</pre> |
| <div class="block">Returns the fetchLimit.</div> |
| </li> |
| </ul> |
| <a name="setFetchLimit(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFetchLimit</h4> |
| <pre>public void setFetchLimit(int fetchLimit)</pre> |
| <div class="block">Sets the fetchLimit.</div> |
| </li> |
| </ul> |
| <a name="setFetchOffset(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFetchOffset</h4> |
| <pre>public void setFetchOffset(int fetchOffset)</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getPageSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPageSize</h4> |
| <pre>public int getPageSize()</pre> |
| <div class="block">Returns <code>pageSize</code> property. See setPageSize for more details.</div> |
| </li> |
| </ul> |
| <a name="setPageSize(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPageSize</h4> |
| <pre>public void setPageSize(int pageSize)</pre> |
| <div class="block">Sets <code>pageSize</code> property. |
| |
| By setting a page size, the Collection returned by performing a query will return |
| <i>hollow</i> DataObjects. This is considerably faster and uses a tiny fraction of the memory |
| compared to a non-paged query when large numbers of objects are returned in the result. |
| When a hollow DataObject is accessed all DataObjects on the same page will be faulted into |
| memory. There will be a small delay when faulting objects while the data is fetched |
| from the data source, but otherwise you do not need to do anything special to access data |
| in hollow objects. The first page is always faulted into memory immediately.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>pageSize</code> - The pageSize to set</dd></dl> |
| </li> |
| </ul> |
| <a name="setStatementFetchSize(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStatementFetchSize</h4> |
| <pre>public void setStatementFetchSize(int size)</pre> |
| <div class="block">Sets statement's fetch size (0 for default size)</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getStatementFetchSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getStatementFetchSize</h4> |
| <pre>public int getStatementFetchSize()</pre> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>statement's fetch size</dd><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/SelectQuery.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/cayenne/query/ScalarResultSegment.html" title="interface in org.apache.cayenne.query"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/cayenne/query/SortOrder.html" title="enum in org.apache.cayenne.query"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/cayenne/query/SelectQuery.html" target="_top">Frames</a></li> |
| <li><a href="SelectQuery.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2001–2014 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
