PageRenderTime 42ms CodeModel.GetById 18ms RepoModel.GetById 1ms app.codeStats 0ms

/projects/cayenne-3.0.1/docs/doc/src/main/resources/doc/Documentation/Cayenne Guide/Queries/SelectQuery/Using Orderings/index.html

https://gitlab.com/essere.lab.public/qualitas.class-corpus
HTML | 142 lines | 106 code | 18 blank | 18 comment | 0 complexity | 7181b183363d685b441b17ab7f38fc08 MD5 | raw file
    

  1. <!--
    2. 

  2.    Licensed to the Apache Software Foundation (ASF) under one
    3. 

  3.    or more contributor license agreements.  See the NOTICE file
    4. 

  4.    distributed with this work for additional information
    5. 

  5.    regarding copyright ownership.  The ASF licenses this file
    6. 

  6.    to you under the Apache License, Version 2.0 (the
    7. 

  7.    "License"); you may not use this file except in compliance
    8. 

  8.    with the License.  You may obtain a copy of the License at
    9. 

  9.  
    10. 

  10.      http://www.apache.org/licenses/LICENSE-2.0
    11. 

  11.  
    12. 

  12.    Unless required by applicable law or agreed to in writing,
    13. 

  13.    software distributed under the License is distributed on an
    14. 

  14.    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    15. 

  15.    KIND, either express or implied.  See the License for the
    16. 

  16.    specific language governing permissions and limitations
    17. 

  17.    under the License.
    18. 

  18. -->
    19. 

  19. <html>
    20. 

  20.   <head>
    21. 

  21.     <title>Apache Cayenne Documentation - Using Orderings</title>
    22. 

  22.     <style type="text/css">@import "../../../../../style.css";</style>
    23. 

  23.   </head>
    24. 

  24. <body>
    25. 

  25.   <div class="header">
    26. 

  26.     <div style="float: left;"><a href="http://cayenne.apache.org/"><img src="../../../../../images/logo.gif" align="absmiddle" border="0"></a></div>
    27. 

  27.     <span class="logoSpaceLink"><a href="../../../../../index.html">Cayenne User Documentation</a></span><br />
    28. 

  28.     <span class="pagetitle">Using Orderings</span>
    29. 

  29.   </div>
    30. 

  30. <div id="cayenne_toc">
    31. 

  31. <ul>
    32. 

  32. <li><a href="../../../../../Documentation/Cayenne Guide/Introduction/index.html">Introduction</a></li>
    33. 

  33. <li><a href="../../../../../Documentation/Cayenne Guide/Installation/index.html">Installation</a></li>
    34. 

  34. <li><a href="../../../../../Documentation/Cayenne Guide/Tutorial/index.html">Tutorial</a></li>
    35. 

  35. <li><a href="../../../../../Documentation/Cayenne Guide/Design/index.html">Design</a></li>
    36. 

  36. <li><a href="../../../../../Documentation/Cayenne Guide/DataContext/index.html">DataContext</a></li>
    37. 

  37. <li><a href="../../../../../Documentation/Cayenne Guide/Queries/index.html">Queries</a><ul>
    38. 

  38. <li><a href="../../../../../Documentation/Cayenne Guide/Queries/SelectQuery/index.html">SelectQuery</a><ul>
    39. 

  39. <li><a href="../../../../../Documentation/Cayenne Guide/Queries/SelectQuery/Parameterized Queries/index.html">Parameterized Queries</a></li>
    40. 

  40. <li><a href="../../../../../Documentation/Cayenne Guide/Queries/SelectQuery/Qualifier Expressions/index.html">Qualifier Expressions</a></li>
    41. 

  41. <li><a href="../../../../../Documentation/Cayenne Guide/Queries/SelectQuery/Using Orderings/index.html">Using Orderings</a><ul>
    42. 

  42. </ul>
    43. 

  43. </li>
    44. 

  44. <li><a href="../../../../../Documentation/Cayenne Guide/Queries/SelectQuery/SelectQuery Customization/index.html">SelectQuery Customization</a></li>
    45. 

  45. </ul>
    46. 

  46. </li>
    47. 

  47. <li><a href="../../../../../Documentation/Cayenne Guide/Queries/SQLTemplate Query/index.html">SQLTemplate Query</a></li>
    48. 

  48. <li><a href="../../../../../Documentation/Cayenne Guide/Queries/EJBQLQuery/index.html">EJBQLQuery</a></li>
    49. 

  49. <li><a href="../../../../../Documentation/Cayenne Guide/Queries/NamedQuery/index.html">NamedQuery</a></li>
    50. 

  50. <li><a href="../../../../../Documentation/Cayenne Guide/Queries/ObjectIdQuery/index.html">ObjectIdQuery</a></li>
    51. 

  51. <li><a href="../../../../../Documentation/Cayenne Guide/Queries/QueryChain/index.html">QueryChain</a></li>
    52. 

  52. <li><a href="../../../../../Documentation/Cayenne Guide/Queries/RelationshipQuery/index.html">RelationshipQuery</a></li>
    53. 

  53. <li><a href="../../../../../Documentation/Cayenne Guide/Queries/Queries Stored in DataMap/index.html">Queries Stored in DataMap</a></li>
    54. 

  54. <li><a href="../../../../../Documentation/Cayenne Guide/Queries/Caching Query Results/index.html">Caching Query Results</a></li>
    55. 

  55. <li><a href="../../../../../Documentation/Cayenne Guide/Queries/Customizing Queries/index.html">Customizing Queries</a></li>
    56. 

  56. </ul>
    57. 

  57. </li>
    58. 

  58. <li><a href="../../../../../Documentation/Cayenne Guide/DataObjects/index.html">DataObjects</a></li>
    59. 

  59. <li><a href="../../../../../Documentation/Cayenne Guide/Stored Procedures/index.html">Stored Procedures</a></li>
    60. 

  60. <li><a href="../../../../../Documentation/Cayenne Guide/Expressions/index.html">Expressions</a></li>
    61. 

  61. <li><a href="../../../../../Documentation/Cayenne Guide/Lifecycle Callbacks/index.html">Lifecycle Callbacks</a></li>
    62. 

  62. <li><a href="../../../../../Documentation/Cayenne Guide/Performance Tuning/index.html">Performance Tuning</a></li>
    63. 

  63. <li><a href="../../../../../Documentation/Cayenne Guide/Caching and Fresh Data/index.html">Caching and Fresh Data</a></li>
    64. 

  64. <li><a href="../../../../../Documentation/Cayenne Guide/Deployment/index.html">Deployment</a></li>
    65. 

  65. <li><a href="../../../../../Documentation/Cayenne Guide/Ant Tasks/index.html">Ant Tasks</a></li>
    66. 

  66. <li><a href="../../../../../Documentation/Cayenne Guide/Maven2 Plugins/index.html">Maven2 Plugins</a></li>
    67. 

  67. <li><a href="../../../../../Documentation/Cayenne Guide/Customization/index.html">Customization</a></li>
    68. 

  68. </ul>
    69. 

  69. </div>
    70. 

  70. <div id="ConfluenceContent"><p>To sort SelectQuery results, Orderings are used. Orderings use path expressions discussed in the previous section to identify the attributes that must be used in sorting.  Orderings also use a SortOrder to identify how the ordering should be performed.</p>
    71. 

  71. 

  72. <p>There are 4 SortOrder options:</p>
    73. 

  73. 

  74. <ul>
    75. 

  75. 	<li>ASCENDING (ascending order, case &#8211; or database &#8211; sensitive)</li>
    76. 

  76. 	<li>ASCENDING_INSENSITIVE (ascending order, case-insensitive)</li>
    77. 

  77. 	<li>DESCENDING (descending order, case &#8211; or database &#8211; sensitive)</li>
    78. 

  78. 	<li>DESCENDING_INSENSITIVE (descending order, case-insensitive)</li>
    79. 

  79. </ul>
    80. 

  80. 

  81. 

  82. <p>To order results by artist name, the following code can be used:</p>
    83. 

  83. 

  84. <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
    85. 

  85. <pre class="code-java"><span class="code-keyword">import</span> org.apache.cayenne.query.SelectQuery;
    86. 

  86. <span class="code-keyword">import</span> org.apache.cayenne.query.SortOrder;
    87. 

  87. ...
    88. 

  88. SelectQuery query = <span class="code-keyword">new</span> SelectQuery(<span class="code-quote">"Artist"</span>);
    89. 

  89. 

  90. <span class="code-comment">// add ordering by Artist name:
    91. 

  91. </span>query.addOrdering(<span class="code-quote">"artistName"</span>, SortOrder.ASCENDING);
    92. 

  92. </pre>
    93. 

  93. </div></div>
    94. 

  94. 

  95. <div class='panelMacro'><table class='infoMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="../../../../../images/emoticons/information.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b>Legacy Information</b><br />In Cayenne versions prior to 3.0, the addOrdering() call in the above example would appear as <tt>query.addOrdering("artistName", true)</tt>. A boolean parameter of true meant to order ascending (false descending).</td></tr></table></div>
    96. 

  96. 

  97. <p>Orderings also support in-memory sorting of lists of Java Beans (all DataObjects are normally Java Beans, since they has set/get method pairs for all the properties). For instance to sort with a single ordering, the following code might be used:</p>
    98. 

  98. 

  99. <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
    100. 

  100. <pre class="code-java"><span class="code-keyword">import</span> org.apache.cayenne.query.Ordering;
    101. 

  101. <span class="code-keyword">import</span> org.apache.cayenne.query.SortOrder;
    102. 

  102. ...
    103. 

  103. <span class="code-comment">// assume <span class="code-keyword">this</span> is a properly initialized list of Artists
    104. 

  104. </span>List list = ...; 
    105. 

  105. 

  106. <span class="code-comment">// creates asending ordering by Artist name
    107. 

  107. </span>Ordering ordering = <span class="code-keyword">new</span> Ordering(<span class="code-quote">"artistName"</span>, SortOrder.ASCENDING);
    108. 

  108. 

  109. <span class="code-comment">// orders a list
    110. 

  110. </span>ordering.orderList(list);
    111. 

  111. </pre>
    112. 

  112. </div></div>
    113. 

  113. 

  114. <div class='panelMacro'><table class='infoMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="../../../../../images/emoticons/information.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td><b>Legacy Information</b><br />In Cayenne versions prior to 3.0, the Ordering() constructor in the above example would appear as: <tt>new Ordering("artistName", true)</tt>. A boolean parameter of true meant to order ascending (false descending).</td></tr></table></div>
    115. 

  115. 

  116. <p>If there is a need to sort on more than one object property, multiple Orderings can be passed as a List to a static method <tt>orderList(List, List)</tt>. The cost of adding new Orderings decreases, as the list of objects ends up being sorted by the first Ordering, then, if any two objects are equal for first Ordering, by the second, and so on.</p>
    117. 

  117. 

  118. <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
    119. 

  119. <pre class="code-java"><span class="code-keyword">import</span> org.apache.cayenne.query.Ordering;
    120. 

  120. <span class="code-keyword">import</span> org.apache.cayenne.query.SortOrder;
    121. 

  121. ...
    122. 

  122. <span class="code-comment">// assume <span class="code-keyword">this</span> is a properly initialized list of Paintings
    123. 

  123. </span>List list = ...; 
    124. 

  124. 

  125. List orderings = <span class="code-keyword">new</span> ArrayList();
    126. 

  126. orderings.add(<span class="code-keyword">new</span> Ordering(<span class="code-quote">"paintingTitle"</span>, SortOrder.ASCENDING));
    127. 

  127. orderings.add(<span class="code-keyword">new</span> Ordering(<span class="code-quote">"estimatedPrice"</span>, SortOrder.DESCENDING));
    128. 

  128. 

  129. <span class="code-comment">// orders a list aplying multiple orderings
    130. 

  130. </span>Ordering.orderList(list, orderings);
    131. 

  131. </pre>
    132. 

  132. </div></div></div>
    133. 

  133. </div>
    134. 

  134.   <div class="clearer">.</div>
    135. 

  135.   <div style="height: 12px; background-image: url('../../../../../images/border_bottom.gif'); background-repeat: repeat-x;"></div>
    136. 

  136. 

  137.   <div class="smalltext copyright">
    138. 

  138.     Copyright &copy;2001-2010 Apache Software Foundation
    139. 

  139.   </div>
    140. 

  140. 

  141. </body>
    142. 

  142. </html>
    143. 

  143.