Google Git
Sign in
apache / cayenne-website / 0af753b3ec346c0432aa26fe6065228badfd46ed / . / docs / 3.1 / api / org / apache / cayenne / query / Ordering.html
blob: e90681e7af3beb6b074c9b0c61301f83c1ee59c4 [file] [log] [blame]
<!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>Ordering (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="Ordering (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/Ordering.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/ObjectIdQuery.html" title="class in org.apache.cayenne.query"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cayenne/query/ParameterizedQuery.html" title="interface 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/Ordering.html" target="_top">Frames</a></li>
<li><a href="Ordering.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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 Ordering" class="title">Class Ordering</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>org.apache.cayenne.query.Ordering</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="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;<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>&gt;, <a href="../../../../org/apache/cayenne/util/XMLSerializable.html" title="interface in org.apache.cayenne.util">XMLSerializable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">Ordering</span>
extends <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>
implements <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;<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>&gt;, <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/util/XMLSerializable.html" title="interface in org.apache.cayenne.util">XMLSerializable</a></pre>
<div class="block">Defines object sorting criteria, used either for in-memory sorting of object lists or
as a specification for building <em>ORDER BY</em> clause of a SelectQuery query. Note
that in case of in-memory sorting, Ordering can be used with any JavaBeans, not just
DataObjects.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#org.apache.cayenne.query.Ordering">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">&nbsp;</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/Ordering.html#nullSortedFirst">nullSortedFirst</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/Ordering.html#pathExceptionSuppressed">pathExceptionSuppressed</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/cayenne/query/SortOrder.html" title="enum in org.apache.cayenne.query">SortOrder</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/Ordering.html#sortOrder">sortOrder</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/Ordering.html#sortSpec">sortSpec</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <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/Ordering.html#sortSpecString">sortSpecString</a></strong></code>&nbsp;</td>
</tr>
</table>
</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">&nbsp;</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/Ordering.html#Ordering()">Ordering</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/cayenne/query/Ordering.html#Ordering(java.lang.String,%20org.apache.cayenne.query.SortOrder)">Ordering</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>&nbsp;sortPathSpec,
<a href="../../../../org/apache/cayenne/query/SortOrder.html" title="enum in org.apache.cayenne.query">SortOrder</a>&nbsp;sortOrder)</code>&nbsp;</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">&nbsp;</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>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/Ordering.html#compare(java.lang.Object,%20java.lang.Object)">compare</a></strong>(<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>&nbsp;o1,
<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>&nbsp;o2)</code>
<div class="block">Comparable interface implementation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/Ordering.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>&nbsp;encoder)</code>
<div class="block">Encodes itself as a query ordering.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/SortOrder.html" title="enum in org.apache.cayenne.query">SortOrder</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/Ordering.html#getSortOrder()">getSortOrder</a></strong>()</code>
<div class="block">Returns sort order for this ordering</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/Ordering.html#getSortSpec()">getSortSpec</a></strong>()</code>
<div class="block">Returns the expression defining a ordering Java Bean property.</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/Ordering.html#getSortSpecString()">getSortSpecString</a></strong>()</code>
<div class="block">Returns sortSpec string representation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/Ordering.html#isAscending()">isAscending</a></strong>()</code>
<div class="block">Returns true if sorting is done in ascending order.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/Ordering.html#isCaseInsensitive()">isCaseInsensitive</a></strong>()</code>
<div class="block">Returns true if the sorting is case insensitive</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/Ordering.html#isCaseSensitive()">isCaseSensitive</a></strong>()</code>
<div class="block">Returns true if the sorting is case sensitive.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/Ordering.html#isDescending()">isDescending</a></strong>()</code>
<div class="block">Returns true if the sorting is done in descending order.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/Ordering.html#isNullSortedFirst()">isNullSortedFirst</a></strong>()</code>
<div class="block">Get sort order for nulls.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/Ordering.html#isPathExceptionSuppressed()">isPathExceptionSuppressed</a></strong>()</code>
<div class="block">Is a path with a null in the middle is ignored.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/Ordering.html#orderList(java.util.List)">orderList</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>&lt;?&gt;&nbsp;objects)</code>
<div class="block">Orders the given list of objects according to the ordering that this object
specifies.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/Ordering.html#orderList(java.util.List,%20java.util.List)">orderList</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>&lt;?&gt;&nbsp;objects,
<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>&lt;<a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>&gt;&nbsp;orderings)</code>
<div class="block">Orders a given list of objects, using a List of Orderings applied according the
default iteration order of the Orderings list.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/Ordering.html#setAscending()">setAscending</a></strong>()</code>
<div class="block">If the sort order is DESCENDING or DESCENDING_INSENSITIVE, sets the sort order to
ASCENDING or ASCENDING_INSENSITIVE, respectively.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/Ordering.html#setCaseInsensitive()">setCaseInsensitive</a></strong>()</code>
<div class="block">If the sort order is ASCENDING or DESCENDING, sets the sort order to
ASCENDING_INSENSITIVE or DESCENDING_INSENSITIVE, respectively.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/Ordering.html#setCaseSensitive()">setCaseSensitive</a></strong>()</code>
<div class="block">If the sort order is ASCENDING_INSENSITIVE or DESCENDING_INSENSITIVE, sets the sort
order to ASCENDING or DESCENDING, respectively.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/Ordering.html#setDescending()">setDescending</a></strong>()</code>
<div class="block">If the sort order is ASCENDING or ASCENDING_INSENSITIVE, sets the sort order to
DESCENDING or DESCENDING_INSENSITIVE, respectively.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/Ordering.html#setNullSortedFirst(boolean)">setNullSortedFirst</a></strong>(boolean&nbsp;nullSortedFirst)</code>
<div class="block">Sets sort order for whether nulls are at the top or bottom of the resulting list.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/Ordering.html#setPathExceptionSupressed(boolean)">setPathExceptionSupressed</a></strong>(boolean&nbsp;pathExceptionSuppressed)</code>
<div class="block">Sets whether a path with a null in the middle is ignored.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/Ordering.html#setSortOrder(org.apache.cayenne.query.SortOrder)">setSortOrder</a></strong>(<a href="../../../../org/apache/cayenne/query/SortOrder.html" title="enum in org.apache.cayenne.query">SortOrder</a>&nbsp;order)</code>
<div class="block">Sets the sort order for this ordering.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/Ordering.html#setSortSpec(org.apache.cayenne.exp.Expression)">setSortSpec</a></strong>(<a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a>&nbsp;sortSpec)</code>
<div class="block">Sets the expression defining a ordering Java Bean property.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/query/Ordering.html#setSortSpecString(java.lang.String)">setSortSpecString</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>&nbsp;sortSpecString)</code>
<div class="block">Sets sortSpec to be an expression represented by string argument.</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/Ordering.html#toString()">toString</a></strong>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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_java.util.Comparator">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.util.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a></h3>
<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Comparator.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.util">equals</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="sortSpecString">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sortSpecString</h4>
<pre>protected&nbsp;<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> sortSpecString</pre>
</li>
</ul>
<a name="sortSpec">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sortSpec</h4>
<pre>protected transient&nbsp;<a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> sortSpec</pre>
</li>
</ul>
<a name="sortOrder">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sortOrder</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/cayenne/query/SortOrder.html" title="enum in org.apache.cayenne.query">SortOrder</a> sortOrder</pre>
</li>
</ul>
<a name="pathExceptionSuppressed">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pathExceptionSuppressed</h4>
<pre>protected&nbsp;boolean pathExceptionSuppressed</pre>
</li>
</ul>
<a name="nullSortedFirst">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>nullSortedFirst</h4>
<pre>protected&nbsp;boolean nullSortedFirst</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Ordering()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Ordering</h4>
<pre>public&nbsp;Ordering()</pre>
</li>
</ul>
<a name="Ordering(java.lang.String, org.apache.cayenne.query.SortOrder)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Ordering</h4>
<pre>public&nbsp;Ordering(<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>&nbsp;sortPathSpec,
<a href="../../../../org/apache/cayenne/query/SortOrder.html" title="enum in org.apache.cayenne.query">SortOrder</a>&nbsp;sortOrder)</pre>
<dl><dt><span class="strong">Since:</span></dt>
<dd>3.0</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="orderList(java.util.List, java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>orderList</h4>
<pre>public static&nbsp;void&nbsp;orderList(<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>&lt;?&gt;&nbsp;objects,
<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>&lt;<a href="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>&gt;&nbsp;orderings)</pre>
<div class="block">Orders a given list of objects, using a List of Orderings applied according the
default iteration order of the Orderings list. I.e. each Ordering with lower index
is more significant than any other Ordering with higher index. List being ordered
is modified in place.</div>
</li>
</ul>
<a name="setSortSpecString(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSortSpecString</h4>
<pre>public&nbsp;void&nbsp;setSortSpecString(<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>&nbsp;sortSpecString)</pre>
<div class="block">Sets sortSpec to be an expression represented by string argument.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.1</dd></dl>
</li>
</ul>
<a name="setNullSortedFirst(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNullSortedFirst</h4>
<pre>public&nbsp;void&nbsp;setNullSortedFirst(boolean&nbsp;nullSortedFirst)</pre>
<div class="block">Sets sort order for whether nulls are at the top or bottom of the resulting list.
Default is true.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>nullSortedFirst</code> - true sorts nulls to the top of the list, false sorts nulls
to the bottom</dd></dl>
</li>
</ul>
<a name="isNullSortedFirst()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isNullSortedFirst</h4>
<pre>public&nbsp;boolean&nbsp;isNullSortedFirst()</pre>
<div class="block">Get sort order for nulls.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if nulls are sorted to the top of the list, false if sorted to the
bottom</dd></dl>
</li>
</ul>
<a name="setPathExceptionSupressed(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPathExceptionSupressed</h4>
<pre>public&nbsp;void&nbsp;setPathExceptionSupressed(boolean&nbsp;pathExceptionSuppressed)</pre>
<div class="block">Sets whether a path with a null in the middle is ignored. For example, a sort from
<code>painting</code> on <code>artist.name</code> would by default throw an
exception if the artist was null. If set to true, then this is treated just like a
null value. Default is false.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pathExceptionSuppressed</code> - true to suppress exceptions and sort as null</dd></dl>
</li>
</ul>
<a name="isPathExceptionSuppressed()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPathExceptionSuppressed</h4>
<pre>public&nbsp;boolean&nbsp;isPathExceptionSuppressed()</pre>
<div class="block">Is a path with a null in the middle is ignored.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true is exception is suppressed and sorted as null</dd></dl>
</li>
</ul>
<a name="getSortSpecString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSortSpecString</h4>
<pre>public&nbsp;<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>&nbsp;getSortSpecString()</pre>
<div class="block">Returns sortSpec string representation.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.1</dd></dl>
</li>
</ul>
<a name="setSortOrder(org.apache.cayenne.query.SortOrder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSortOrder</h4>
<pre>public&nbsp;void&nbsp;setSortOrder(<a href="../../../../org/apache/cayenne/query/SortOrder.html" title="enum in org.apache.cayenne.query">SortOrder</a>&nbsp;order)</pre>
<div class="block">Sets the sort order for this ordering.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>3.0</dd></dl>
</li>
</ul>
<a name="isAscending()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAscending</h4>
<pre>public&nbsp;boolean&nbsp;isAscending()</pre>
<div class="block">Returns true if sorting is done in ascending order.</div>
</li>
</ul>
<a name="isDescending()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDescending</h4>
<pre>public&nbsp;boolean&nbsp;isDescending()</pre>
<div class="block">Returns true if the sorting is done in descending order.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>3.0</dd></dl>
</li>
</ul>
<a name="setAscending()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAscending</h4>
<pre>public&nbsp;void&nbsp;setAscending()</pre>
<div class="block">If the sort order is DESCENDING or DESCENDING_INSENSITIVE, sets the sort order to
ASCENDING or ASCENDING_INSENSITIVE, respectively.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>3.0</dd></dl>
</li>
</ul>
<a name="setDescending()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDescending</h4>
<pre>public&nbsp;void&nbsp;setDescending()</pre>
<div class="block">If the sort order is ASCENDING or ASCENDING_INSENSITIVE, sets the sort order to
DESCENDING or DESCENDING_INSENSITIVE, respectively.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>3.0</dd></dl>
</li>
</ul>
<a name="isCaseInsensitive()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCaseInsensitive</h4>
<pre>public&nbsp;boolean&nbsp;isCaseInsensitive()</pre>
<div class="block">Returns true if the sorting is case insensitive</div>
</li>
</ul>
<a name="isCaseSensitive()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCaseSensitive</h4>
<pre>public&nbsp;boolean&nbsp;isCaseSensitive()</pre>
<div class="block">Returns true if the sorting is case sensitive.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>3.0</dd></dl>
</li>
</ul>
<a name="setCaseInsensitive()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCaseInsensitive</h4>
<pre>public&nbsp;void&nbsp;setCaseInsensitive()</pre>
<div class="block">If the sort order is ASCENDING or DESCENDING, sets the sort order to
ASCENDING_INSENSITIVE or DESCENDING_INSENSITIVE, respectively.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>3.0</dd></dl>
</li>
</ul>
<a name="setCaseSensitive()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCaseSensitive</h4>
<pre>public&nbsp;void&nbsp;setCaseSensitive()</pre>
<div class="block">If the sort order is ASCENDING_INSENSITIVE or DESCENDING_INSENSITIVE, sets the sort
order to ASCENDING or DESCENDING, respectively.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>3.0</dd></dl>
</li>
</ul>
<a name="getSortSpec()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSortSpec</h4>
<pre>public&nbsp;<a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a>&nbsp;getSortSpec()</pre>
<div class="block">Returns the expression defining a ordering Java Bean property.</div>
</li>
</ul>
<a name="setSortSpec(org.apache.cayenne.exp.Expression)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSortSpec</h4>
<pre>public&nbsp;void&nbsp;setSortSpec(<a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a>&nbsp;sortSpec)</pre>
<div class="block">Sets the expression defining a ordering Java Bean property.</div>
</li>
</ul>
<a name="orderList(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>orderList</h4>
<pre>public&nbsp;void&nbsp;orderList(<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>&lt;?&gt;&nbsp;objects)</pre>
<div class="block">Orders the given list of objects according to the ordering that this object
specifies. List is modified in-place.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>objects</code> - a List of objects to be sorted</dd></dl>
</li>
</ul>
<a name="compare(java.lang.Object, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compare</h4>
<pre>public&nbsp;int&nbsp;compare(<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>&nbsp;o1,
<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>&nbsp;o2)</pre>
<div class="block">Comparable interface implementation. Can compare two Java Beans based on the stored
expression.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Comparator.html?is-external=true#compare(T,%20T)" title="class or interface in java.util">compare</a></code>&nbsp;in interface&nbsp;<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;<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>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="encodeAsXML(org.apache.cayenne.util.XMLEncoder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeAsXML</h4>
<pre>public&nbsp;void&nbsp;encodeAsXML(<a href="../../../../org/apache/cayenne/util/XMLEncoder.html" title="class in org.apache.cayenne.util">XMLEncoder</a>&nbsp;encoder)</pre>
<div class="block">Encodes itself as a query ordering.</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>&nbsp;in interface&nbsp;<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="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<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>&nbsp;toString()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><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></code></dd>
</dl>
</li>
</ul>
<a name="getSortOrder()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getSortOrder</h4>
<pre>public&nbsp;<a href="../../../../org/apache/cayenne/query/SortOrder.html" title="enum in org.apache.cayenne.query">SortOrder</a>&nbsp;getSortOrder()</pre>
<div class="block">Returns sort order for this ordering</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>3.1</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/Ordering.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/ObjectIdQuery.html" title="class in org.apache.cayenne.query"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cayenne/query/ParameterizedQuery.html" title="interface 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/Ordering.html" target="_top">Frames</a></li>
<li><a href="Ordering.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2001&#x2013;2014 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p>
</body>
</html>