blob: 5fcc68a4857ece55fbfbbf02e43957732695d1da [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_252) on Thu Sep 03 11:54:29 CEST 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SelectItem (OpenJPA Parent POM 3.1.2 API)</title>
<meta name="date" content="2020-09-03">
<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="SelectItem (OpenJPA Parent POM 3.1.2 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":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/SelectItem.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/openjpa/persistence/query/RootPath.html" title="class in org.apache.openjpa.persistence.query"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/persistence/query/SizeExpression.html" title="class in org.apache.openjpa.persistence.query"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/persistence/query/SelectItem.html" target="_top">Frames</a></li>
<li><a href="SelectItem.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>Nested&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">org.apache.openjpa.persistence.query</div>
<h2 title="Interface SelectItem" class="title">Interface SelectItem</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../org/apache/openjpa/persistence/query/OrderByItem.html" title="interface in org.apache.openjpa.persistence.query">OrderByItem</a></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../org/apache/openjpa/persistence/query/Aggregate.html" title="interface in org.apache.openjpa.persistence.query">Aggregate</a>, <a href="../../../../../org/apache/openjpa/persistence/query/DomainObject.html" title="interface in org.apache.openjpa.persistence.query">DomainObject</a>, <a href="../../../../../org/apache/openjpa/persistence/query/Expression.html" title="interface in org.apache.openjpa.persistence.query">Expression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/PathExpression.html" title="interface in org.apache.openjpa.persistence.query">PathExpression</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/openjpa/persistence/query/AbsExpression.html" title="class in org.apache.openjpa.persistence.query">AbsExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/AbstractDomainObject.html" title="class in org.apache.openjpa.persistence.query">AbstractDomainObject</a>, <a href="../../../../../org/apache/openjpa/persistence/query/ArrayExpression.html" title="class in org.apache.openjpa.persistence.query">ArrayExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/AverageExpression.html" title="class in org.apache.openjpa.persistence.query">AverageExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/BinaryOperatorExpression.html" title="class in org.apache.openjpa.persistence.query">BinaryOperatorExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/ConcatExpression.html" title="class in org.apache.openjpa.persistence.query">ConcatExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/CountExpression.html" title="class in org.apache.openjpa.persistence.query">CountExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/CurrentTimeExpression.html" title="class in org.apache.openjpa.persistence.query">CurrentTimeExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/DistinctExpression.html" title="class in org.apache.openjpa.persistence.query">DistinctExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/DividedByExpression.html" title="class in org.apache.openjpa.persistence.query">DividedByExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/ElseExpression.html" title="class in org.apache.openjpa.persistence.query">ElseExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/EntryExpression.html" title="class in org.apache.openjpa.persistence.query">EntryExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/FetchPath.html" title="class in org.apache.openjpa.persistence.query">FetchPath</a>, <a href="../../../../../org/apache/openjpa/persistence/query/IndexExpression.html" title="class in org.apache.openjpa.persistence.query">IndexExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/JoinPath.html" title="class in org.apache.openjpa.persistence.query">JoinPath</a>, <a href="../../../../../org/apache/openjpa/persistence/query/KeyExpression.html" title="class in org.apache.openjpa.persistence.query">KeyExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/LengthExpression.html" title="class in org.apache.openjpa.persistence.query">LengthExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/LiteralExpression.html" title="class in org.apache.openjpa.persistence.query">LiteralExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/LocateExpression.html" title="class in org.apache.openjpa.persistence.query">LocateExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/LowerExpression.html" title="class in org.apache.openjpa.persistence.query">LowerExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/MaxExpression.html" title="class in org.apache.openjpa.persistence.query">MaxExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/MinExpression.html" title="class in org.apache.openjpa.persistence.query">MinExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/MinusExpression.html" title="class in org.apache.openjpa.persistence.query">MinusExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/NewInstance.html" title="class in org.apache.openjpa.persistence.query">NewInstance</a>, <a href="../../../../../org/apache/openjpa/persistence/query/OperatorPath.html" title="class in org.apache.openjpa.persistence.query">OperatorPath</a>, <a href="../../../../../org/apache/openjpa/persistence/query/ParameterExpression.html" title="class in org.apache.openjpa.persistence.query">ParameterExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/PlusExpression.html" title="class in org.apache.openjpa.persistence.query">PlusExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/QueryDefinitionImpl.html" title="class in org.apache.openjpa.persistence.query">QueryDefinitionImpl</a>, <a href="../../../../../org/apache/openjpa/persistence/query/RangeExpression.html" title="class in org.apache.openjpa.persistence.query">RangeExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/RootPath.html" title="class in org.apache.openjpa.persistence.query">RootPath</a>, <a href="../../../../../org/apache/openjpa/persistence/query/SizeExpression.html" title="class in org.apache.openjpa.persistence.query">SizeExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/SquareRootExpression.html" title="class in org.apache.openjpa.persistence.query">SquareRootExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/SubStringExpression.html" title="class in org.apache.openjpa.persistence.query">SubStringExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/SumExpression.html" title="class in org.apache.openjpa.persistence.query">SumExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/TimesExpression.html" title="class in org.apache.openjpa.persistence.query">TimesExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/TrimExpression.html" title="class in org.apache.openjpa.persistence.query">TrimExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/TypeExpression.html" title="class in org.apache.openjpa.persistence.query">TypeExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/UnaryMinusExpression.html" title="class in org.apache.openjpa.persistence.query">UnaryMinusExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/UpperExpression.html" title="class in org.apache.openjpa.persistence.query">UpperExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/ValueExpression.html" title="class in org.apache.openjpa.persistence.query">ValueExpression</a>, <a href="../../../../../org/apache/openjpa/persistence/query/VarArgsExpression.html" title="class in org.apache.openjpa.persistence.query">VarArgsExpression</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">SelectItem</span>
extends <a href="../../../../../org/apache/openjpa/persistence/query/OrderByItem.html" title="interface in org.apache.openjpa.persistence.query">OrderByItem</a></pre>
<div class="block">SelectItem instances are used in specifying the query's select list.
<p/>
The methods of this interface are used to define arguments that can be passed
to the orderBy method for use in ordering selected items of the query result.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="../../../../../org/apache/openjpa/persistence/query/OrderByItem.html" title="interface in org.apache.openjpa.persistence.query">OrderByItem</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/persistence/query/SelectItem.html#asc--">asc</a></span>()</code>
<div class="block">Return an OrderByItem referencing the SelectItem and specifying ascending
ordering.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/persistence/query/OrderByItem.html" title="interface in org.apache.openjpa.persistence.query">OrderByItem</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/persistence/query/SelectItem.html#desc--">desc</a></span>()</code>
<div class="block">Return an OrderByItem referencing the SelectItem and specifying
descending ordering.</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="asc--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asc</h4>
<pre><a href="../../../../../org/apache/openjpa/persistence/query/OrderByItem.html" title="interface in org.apache.openjpa.persistence.query">OrderByItem</a>&nbsp;asc()</pre>
<div class="block">Return an OrderByItem referencing the SelectItem and specifying ascending
ordering. The SelectItem must correspond to an orderable value.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>order-by item</dd>
</dl>
</li>
</ul>
<a name="desc--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>desc</h4>
<pre><a href="../../../../../org/apache/openjpa/persistence/query/OrderByItem.html" title="interface in org.apache.openjpa.persistence.query">OrderByItem</a>&nbsp;desc()</pre>
<div class="block">Return an OrderByItem referencing the SelectItem and specifying
descending ordering. The SelectItem must correspond to an orderable
value.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>order-by item</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/SelectItem.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/openjpa/persistence/query/RootPath.html" title="class in org.apache.openjpa.persistence.query"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/persistence/query/SizeExpression.html" title="class in org.apache.openjpa.persistence.query"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/persistence/query/SelectItem.html" target="_top">Frames</a></li>
<li><a href="SelectItem.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>Nested&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; 2006&#x2013;2020 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>