Google Git
Sign in
apache / cayenne-website / 626d8c1d90628349118d991467d8b423be9e228e / . / src / main / site / static / docs / 4.2 / api / org / apache / cayenne / query / Ordering.html
blob: 3959260c8aac45e69956e2f05a407b5b6b50ab12 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.10) on Mon Dec 05 10:27:04 MSK 2022 -->
<title>Ordering (cayenne-doc: Cayenne Documentation 4.2.RC2 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-12-05">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Ordering (cayenne-doc: Cayenne Documentation 4.2.RC2 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":9,"i15":10,"i16":9,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = false;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/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 class="aboutLanguage"><a href="http://cayenne.apache.org" target="top">Apache Cayenne</a></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&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 id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.cayenne.query</a></div>
<h2 title="Class Ordering" class="title">Class Ordering</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>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><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;</code>, <code><a href="../util/XMLSerializable.html" title="interface in org.apache.cayenne.util">XMLSerializable</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">Ordering</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>
implements <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a>, <a href="../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="seeLabel">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 =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#nullSortedFirst">nullSortedFirst</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#pathExceptionSuppressed">pathExceptionSuppressed</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="SortOrder.html" title="enum in org.apache.cayenne.query">SortOrder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sortOrder">sortOrder</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sortSpec">sortSpec</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sortSpecString">sortSpecString</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">Ordering</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String)">Ordering</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;sortPathSpec)</code></th>
<td class="colLast">
<div class="block">Create an ordering instance with a provided path and ascending sorting
strategy.</div>
</td>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,org.apache.cayenne.query.SortOrder)">Ordering</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;sortPathSpec,
<a href="SortOrder.html" title="enum in org.apache.cayenne.query">SortOrder</a>&nbsp;sortOrder)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.cayenne.exp.Expression)">Ordering</a></span>&#8203;(<a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a>&nbsp;sortSpec)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.cayenne.exp.Expression,org.apache.cayenne.query.SortOrder)">Ordering</a></span>&#8203;(<a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a>&nbsp;sortSpec,
<a href="SortOrder.html" title="enum in org.apache.cayenne.query">SortOrder</a>&nbsp;sortOrder)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#compare(java.lang.Object,java.lang.Object)">compare</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;o1,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;o2)</code></th>
<td class="colLast">
<div class="block">Comparable interface implementation.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#encodeAsXML(org.apache.cayenne.util.XMLEncoder,org.apache.cayenne.configuration.ConfigurationNodeVisitor)">encodeAsXML</a></span>&#8203;(<a href="../util/XMLEncoder.html" title="class in org.apache.cayenne.util">XMLEncoder</a>&nbsp;encoder,
<a href="../configuration/ConfigurationNodeVisitor.html" title="interface in org.apache.cayenne.configuration">ConfigurationNodeVisitor</a>&nbsp;delegate)</code></th>
<td class="colLast">
<div class="block">Encodes itself as a query ordering.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;object)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="SortOrder.html" title="enum in org.apache.cayenne.query">SortOrder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSortOrder()">getSortOrder</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns sort order for this ordering</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSortSpec()">getSortSpec</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the expression defining a ordering Java Bean property.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSortSpecString()">getSortSpecString</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns sortSpec string representation.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAscending()">isAscending</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns true if sorting is done in ascending order.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isCaseInsensitive()">isCaseInsensitive</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns true if the sorting is case insensitive</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isCaseSensitive()">isCaseSensitive</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns true if the sorting is case sensitive.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isDescending()">isDescending</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns true if the sorting is done in descending order.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isNullSortedFirst()">isNullSortedFirst</a></span>()</code></th>
<td class="colLast">
<div class="block">Get sort order for nulls.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isPathExceptionSuppressed()">isPathExceptionSuppressed</a></span>()</code></th>
<td class="colLast">
<div class="block">Is a path with a null in the middle is ignored.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>&lt;E&gt;&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;E&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#orderedList(java.util.Collection)">orderedList</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;E&gt;&nbsp;objects)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>static &lt;E&gt;&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;E&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#orderedList(java.util.Collection,java.util.List)">orderedList</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;E&gt;&nbsp;objects,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;? extends <a href="Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>&gt;&nbsp;orderings)</code></th>
<td class="colLast">
<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 id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#orderList(java.util.List)">orderList</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;?&gt;&nbsp;objects)</code></th>
<td class="colLast">
<div class="block">Orders the given list of objects according to the ordering that this
object specifies.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#orderList(java.util.List,java.util.List)">orderList</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;?&gt;&nbsp;objects,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;? extends <a href="Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>&gt;&nbsp;orderings)</code></th>
<td class="colLast">
<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 id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAscending()">setAscending</a></span>()</code></th>
<td class="colLast">
<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 id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCaseInsensitive()">setCaseInsensitive</a></span>()</code></th>
<td class="colLast">
<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 id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCaseSensitive()">setCaseSensitive</a></span>()</code></th>
<td class="colLast">
<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 id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDescending()">setDescending</a></span>()</code></th>
<td class="colLast">
<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 id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setNullSortedFirst(boolean)">setNullSortedFirst</a></span>&#8203;(boolean&nbsp;nullSortedFirst)</code></th>
<td class="colLast">
<div class="block">Sets sort order for whether nulls are at the top or bottom of the
resulting list.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPathExceptionSupressed(boolean)">setPathExceptionSupressed</a></span>&#8203;(boolean&nbsp;pathExceptionSuppressed)</code></th>
<td class="colLast">
<div class="block">Sets whether a path with a null in the middle is ignored.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSortOrder(org.apache.cayenne.query.SortOrder)">setSortOrder</a></span>&#8203;(<a href="SortOrder.html" title="enum in org.apache.cayenne.query">SortOrder</a>&nbsp;order)</code></th>
<td class="colLast">
<div class="block">Sets the sort order for this ordering.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSortSpec(org.apache.cayenne.exp.Expression)">setSortSpec</a></span>&#8203;(<a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a>&nbsp;sortSpec)</code></th>
<td class="colLast">
<div class="block">Sets the expression defining a ordering Java Bean property.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSortSpecString(java.lang.String)">setSortSpecString</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;sortSpecString)</code></th>
<td class="colLast">
<div class="block">Sets sortSpec to be an expression represented by string argument.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code><a href="Orderings.html" title="class in org.apache.cayenne.query">Orderings</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#then(java.util.List)">then</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>&gt;&nbsp;nextOrderings)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code><a href="Orderings.html" title="class in org.apache.cayenne.query">Orderings</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#then(org.apache.cayenne.query.Ordering)">then</a></span>&#8203;(<a href="Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>&nbsp;nextOrdering)</code></th>
<td class="colLast">
<div class="block">Returns Orderings with this Ordering followed by the provided
next Ordering.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code><a href="Orderings.html" title="class in org.apache.cayenne.query">Orderings</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#then(org.apache.cayenne.query.Orderings)">then</a></span>&#8203;(<a href="Orderings.html" title="class in org.apache.cayenne.query">Orderings</a>&nbsp;nextOrderings)</code></th>
<td class="colLast">
<div class="block">Returns Orderings with this Ordering followed by the provided
list of next Orderings.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.util.Comparator">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.util.<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true#reversed()" title="class or interface in java.util" class="externalLink">reversed</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true#thenComparing(java.util.Comparator)" title="class or interface in java.util" class="externalLink">thenComparing</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true#thenComparing(java.util.function.Function)" title="class or interface in java.util" class="externalLink">thenComparing</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true#thenComparing(java.util.function.Function,java.util.Comparator)" title="class or interface in java.util" class="externalLink">thenComparing</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true#thenComparingDouble(java.util.function.ToDoubleFunction)" title="class or interface in java.util" class="externalLink">thenComparingDouble</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true#thenComparingInt(java.util.function.ToIntFunction)" title="class or interface in java.util" class="externalLink">thenComparingInt</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true#thenComparingLong(java.util.function.ToLongFunction)" title="class or interface in java.util" class="externalLink">thenComparingLong</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="sortSpecString">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sortSpecString</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sortSpecString</pre>
</li>
</ul>
<a id="sortSpec">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sortSpec</h4>
<pre>protected transient&nbsp;<a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> sortSpec</pre>
</li>
</ul>
<a id="sortOrder">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sortOrder</h4>
<pre>protected&nbsp;<a href="SortOrder.html" title="enum in org.apache.cayenne.query">SortOrder</a> sortOrder</pre>
</li>
</ul>
<a id="pathExceptionSuppressed">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pathExceptionSuppressed</h4>
<pre>protected&nbsp;boolean pathExceptionSuppressed</pre>
</li>
</ul>
<a id="nullSortedFirst">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>nullSortedFirst</h4>
<pre>protected&nbsp;boolean nullSortedFirst</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Ordering</h4>
<pre>public&nbsp;Ordering()</pre>
</li>
</ul>
<a id="&lt;init&gt;(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Ordering</h4>
<pre>public&nbsp;Ordering&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;sortPathSpec)</pre>
<div class="block">Create an ordering instance with a provided path and ascending sorting
strategy.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(java.lang.String,org.apache.cayenne.query.SortOrder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Ordering</h4>
<pre>public&nbsp;Ordering&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;sortPathSpec,
<a href="SortOrder.html" title="enum in org.apache.cayenne.query">SortOrder</a>&nbsp;sortOrder)</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(org.apache.cayenne.exp.Expression)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Ordering</h4>
<pre>public&nbsp;Ordering&#8203;(<a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a>&nbsp;sortSpec)</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(org.apache.cayenne.exp.Expression,org.apache.cayenne.query.SortOrder)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Ordering</h4>
<pre>public&nbsp;Ordering&#8203;(<a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a>&nbsp;sortSpec,
<a href="SortOrder.html" title="enum in org.apache.cayenne.query">SortOrder</a>&nbsp;sortOrder)</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="orderList(java.util.List,java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>orderList</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;orderList&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;?&gt;&nbsp;objects,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;? extends <a href="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>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>objects</code> - elements to sort</dd>
<dd><code>orderings</code> - list of Orderings to be applied</dd>
</dl>
</li>
</ul>
<a id="orderedList(java.util.Collection,java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>orderedList</h4>
<pre class="methodSignature">public static&nbsp;&lt;E&gt;&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;E&gt;&nbsp;orderedList&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;E&gt;&nbsp;objects,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;? extends <a href="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.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>objects</code> - elements to sort</dd>
<dd><code>orderings</code> - list of Orderings to be applied</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>new List with ordered elements</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
<a id="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;equals&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;object)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.util" class="externalLink">equals</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd>
</dl>
</li>
</ul>
<a id="hashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd>
</dl>
</li>
</ul>
<a id="setSortSpecString(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSortSpecString</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setSortSpecString&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;sortSpecString)</pre>
<div class="block">Sets sortSpec to be an expression represented by string argument.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a id="setNullSortedFirst(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNullSortedFirst</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setNullSortedFirst&#8203;(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.
Affects only in-memory sorting.</div>
<dl>
<dt><span class="paramLabel">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 id="isNullSortedFirst()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isNullSortedFirst</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isNullSortedFirst()</pre>
<div class="block">Get sort order for nulls.</div>
<dl>
<dt><span class="returnLabel">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 id="setPathExceptionSupressed(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPathExceptionSupressed</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setPathExceptionSupressed&#8203;(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="paramLabel">Parameters:</span></dt>
<dd><code>pathExceptionSuppressed</code> - true to suppress exceptions and sort as null</dd>
</dl>
</li>
</ul>
<a id="isPathExceptionSuppressed()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPathExceptionSuppressed</h4>
<pre class="methodSignature">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="returnLabel">Returns:</span></dt>
<dd>true is exception is suppressed and sorted as null</dd>
</dl>
</li>
</ul>
<a id="getSortSpecString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSortSpecString</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;getSortSpecString()</pre>
<div class="block">Returns sortSpec string representation.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a id="setSortOrder(org.apache.cayenne.query.SortOrder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSortOrder</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setSortOrder&#8203;(<a href="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="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a id="isAscending()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAscending</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isAscending()</pre>
<div class="block">Returns true if sorting is done in ascending order.</div>
</li>
</ul>
<a id="isDescending()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDescending</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isDescending()</pre>
<div class="block">Returns true if the sorting is done in descending order.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a id="setAscending()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAscending</h4>
<pre class="methodSignature">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="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a id="setDescending()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDescending</h4>
<pre class="methodSignature">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="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a id="isCaseInsensitive()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCaseInsensitive</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isCaseInsensitive()</pre>
<div class="block">Returns true if the sorting is case insensitive</div>
</li>
</ul>
<a id="isCaseSensitive()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCaseSensitive</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isCaseSensitive()</pre>
<div class="block">Returns true if the sorting is case sensitive.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a id="setCaseInsensitive()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCaseInsensitive</h4>
<pre class="methodSignature">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="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a id="setCaseSensitive()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCaseSensitive</h4>
<pre class="methodSignature">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="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a id="getSortSpec()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSortSpec</h4>
<pre class="methodSignature">public&nbsp;<a href="../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 id="setSortSpec(org.apache.cayenne.exp.Expression)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSortSpec</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setSortSpec&#8203;(<a href="../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 id="orderList(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>orderList</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;orderList&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&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="paramLabel">Parameters:</span></dt>
<dd><code>objects</code> - a List of objects to be sorted</dd>
</dl>
</li>
</ul>
<a id="orderedList(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>orderedList</h4>
<pre class="methodSignature">public&nbsp;&lt;E&gt;&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;E&gt;&nbsp;orderedList&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;E&gt;&nbsp;objects)</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
<a id="compare(java.lang.Object,java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compare</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;compare&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;o1,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;o2)</pre>
<div class="block">Comparable interface implementation. Can compare two Java Beans based on
the stored expression.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true#compare(T,T)" title="class or interface in java.util" class="externalLink">compare</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a id="encodeAsXML(org.apache.cayenne.util.XMLEncoder,org.apache.cayenne.configuration.ConfigurationNodeVisitor)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeAsXML</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;encodeAsXML&#8203;(<a href="../util/XMLEncoder.html" title="class in org.apache.cayenne.util">XMLEncoder</a>&nbsp;encoder,
<a href="../configuration/ConfigurationNodeVisitor.html" title="interface in org.apache.cayenne.configuration">ConfigurationNodeVisitor</a>&nbsp;delegate)</pre>
<div class="block">Encodes itself as a query ordering.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../util/XMLSerializable.html#encodeAsXML(org.apache.cayenne.util.XMLEncoder,org.apache.cayenne.configuration.ConfigurationNodeVisitor)">encodeAsXML</a></code>&nbsp;in interface&nbsp;<code><a href="../util/XMLSerializable.html" title="interface in org.apache.cayenne.util">XMLSerializable</a></code></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd>
</dl>
</li>
</ul>
<a id="getSortOrder()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSortOrder</h4>
<pre class="methodSignature">public&nbsp;<a href="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="simpleTagLabel">Since:</span></dt>
<dd>3.1</dd>
</dl>
</li>
</ul>
<a id="then(org.apache.cayenne.query.Ordering)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>then</h4>
<pre class="methodSignature">public&nbsp;<a href="Orderings.html" title="class in org.apache.cayenne.query">Orderings</a>&nbsp;then&#8203;(<a href="Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>&nbsp;nextOrdering)</pre>
<div class="block">Returns Orderings with this Ordering followed by the provided
next Ordering.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nextOrdering</code> - the next Ordering to chain to this</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new Orderings with both Ordering</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.1</dd>
</dl>
</li>
</ul>
<a id="then(org.apache.cayenne.query.Orderings)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>then</h4>
<pre class="methodSignature">public&nbsp;<a href="Orderings.html" title="class in org.apache.cayenne.query">Orderings</a>&nbsp;then&#8203;(<a href="Orderings.html" title="class in org.apache.cayenne.query">Orderings</a>&nbsp;nextOrderings)</pre>
<div class="block">Returns Orderings with this Ordering followed by the provided
list of next Orderings.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nextOrderings</code> - the next Orderings to chain to this</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array of sort orderings</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.1</dd>
</dl>
</li>
</ul>
<a id="then(java.util.List)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>then</h4>
<pre class="methodSignature">public&nbsp;<a href="Orderings.html" title="class in org.apache.cayenne.query">Orderings</a>&nbsp;then&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="Ordering.html" title="class in org.apache.cayenne.query">Ordering</a>&gt;&nbsp;nextOrderings)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nextOrderings</code> - the next Orderings to chain to this</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array of sort orderings</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.1</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="Orderings.html#then(org.apache.cayenne.query.Orderings)"><code>Orderings.then(Orderings)</code></a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/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 class="aboutLanguage"><a href="http://cayenne.apache.org" target="top">Apache Cayenne</a></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2001&#x2013;2022 <a href="https://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p>
</footer>
</body>
</html>