blob: 4fce688557c6280df9068155bfd22c66866e5ce0 [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 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>OrderExpression (JDO API 3.2.1)</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="OrderExpression (JDO API 3.2.1)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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/OrderExpression.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="../../../javax/jdo/query/OptionalExpression.html" title="interface in javax.jdo.query"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../javax/jdo/query/OrderExpression.OrderDirection.html" title="enum in javax.jdo.query"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/jdo/query/OrderExpression.html" target="_top">Frames</a></li>
<li><a href="OrderExpression.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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">javax.jdo.query</div>
<h2 title="Interface OrderExpression" class="title">Interface OrderExpression&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Java type of the expression being represented here</dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">OrderExpression&lt;T&gt;</span></pre>
<div class="block">Expression representing the ordering using an expression and a direction.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/query/OrderExpression.OrderDirection.html" title="enum in javax.jdo.query">OrderExpression.OrderDirection</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/query/OrderExpression.OrderNullsPosition.html" title="enum in javax.jdo.query">OrderExpression.OrderNullsPosition</a></span></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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../javax/jdo/query/OrderExpression.OrderDirection.html" title="enum in javax.jdo.query">OrderExpression.OrderDirection</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/query/OrderExpression.html#getDirection--">getDirection</a></span>()</code>
<div class="block">Accessor for the direction of the ordering with this expression.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../javax/jdo/query/Expression.html" title="interface in javax.jdo.query">Expression</a>&lt;<a href="../../../javax/jdo/query/OrderExpression.html" title="type parameter in OrderExpression">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/query/OrderExpression.html#getExpression--">getExpression</a></span>()</code>
<div class="block">Accessor for the expression being used for ordering.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../javax/jdo/query/OrderExpression.OrderNullsPosition.html" title="enum in javax.jdo.query">OrderExpression.OrderNullsPosition</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/query/OrderExpression.html#getNullsPosition--">getNullsPosition</a></span>()</code>
<div class="block">Accessor for the position of nulls with this expression.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../javax/jdo/query/OrderExpression.html" title="interface in javax.jdo.query">OrderExpression</a>&lt;<a href="../../../javax/jdo/query/OrderExpression.html" title="type parameter in OrderExpression">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/query/OrderExpression.html#nullsFirst--">nullsFirst</a></span>()</code>
<div class="block">Method to set nulls to be ordered BEFORE non-nulls.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../javax/jdo/query/OrderExpression.html" title="interface in javax.jdo.query">OrderExpression</a>&lt;<a href="../../../javax/jdo/query/OrderExpression.html" title="type parameter in OrderExpression">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/query/OrderExpression.html#nullsLast--">nullsLast</a></span>()</code>
<div class="block">Method to set nulls to be ordered AFTER non-nulls.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getDirection--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDirection</h4>
<pre><a href="../../../javax/jdo/query/OrderExpression.OrderDirection.html" title="enum in javax.jdo.query">OrderExpression.OrderDirection</a>&nbsp;getDirection()</pre>
<div class="block">Accessor for the direction of the ordering with this expression.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The direction</dd>
</dl>
</li>
</ul>
<a name="getExpression--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExpression</h4>
<pre><a href="../../../javax/jdo/query/Expression.html" title="interface in javax.jdo.query">Expression</a>&lt;<a href="../../../javax/jdo/query/OrderExpression.html" title="type parameter in OrderExpression">T</a>&gt;&nbsp;getExpression()</pre>
<div class="block">Accessor for the expression being used for ordering.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Ordering expression</dd>
</dl>
</li>
</ul>
<a name="getNullsPosition--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNullsPosition</h4>
<pre><a href="../../../javax/jdo/query/OrderExpression.OrderNullsPosition.html" title="enum in javax.jdo.query">OrderExpression.OrderNullsPosition</a>&nbsp;getNullsPosition()</pre>
<div class="block">Accessor for the position of nulls with this expression.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The nulls position (or null if not defined)</dd>
</dl>
</li>
</ul>
<a name="nullsFirst--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nullsFirst</h4>
<pre><a href="../../../javax/jdo/query/OrderExpression.html" title="interface in javax.jdo.query">OrderExpression</a>&lt;<a href="../../../javax/jdo/query/OrderExpression.html" title="type parameter in OrderExpression">T</a>&gt;&nbsp;nullsFirst()</pre>
<div class="block">Method to set nulls to be ordered BEFORE non-nulls.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The order expression</dd>
</dl>
</li>
</ul>
<a name="nullsLast--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>nullsLast</h4>
<pre><a href="../../../javax/jdo/query/OrderExpression.html" title="interface in javax.jdo.query">OrderExpression</a>&lt;<a href="../../../javax/jdo/query/OrderExpression.html" title="type parameter in OrderExpression">T</a>&gt;&nbsp;nullsLast()</pre>
<div class="block">Method to set nulls to be ordered AFTER non-nulls.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The order expression</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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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/OrderExpression.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="../../../javax/jdo/query/OptionalExpression.html" title="interface in javax.jdo.query"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../javax/jdo/query/OrderExpression.OrderDirection.html" title="enum in javax.jdo.query"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/jdo/query/OrderExpression.html" target="_top">Frames</a></li>
<li><a href="OrderExpression.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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; 2005&#x2013;2022 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>