Google Git
Sign in
apache / db-jdo-site / refs/heads/publish / . / api32 / apidocs / javax / jdo / query / Expression.html
blob: 9b2db82acb37fff63813a9bf9e222cb7da1499dd [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>Expression (JDO API 3.2)</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="Expression (JDO API 3.2)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":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/Expression.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/EnumExpression.html" title="interface in javax.jdo.query"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../javax/jdo/query/IfThenElseExpression.html" title="interface 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/Expression.html" target="_top">Frames</a></li>
<li><a href="Expression.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">javax.jdo.query</div>
<h2 title="Interface Expression" class="title">Interface Expression&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 being represented here</dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../javax/jdo/query/BooleanExpression.html" title="interface in javax.jdo.query">BooleanExpression</a>, <a href="../../../javax/jdo/query/ByteExpression.html" title="interface in javax.jdo.query">ByteExpression</a>, <a href="../../../javax/jdo/query/CharacterExpression.html" title="interface in javax.jdo.query">CharacterExpression</a>, <a href="../../../javax/jdo/query/CollectionExpression.html" title="interface in javax.jdo.query">CollectionExpression</a>&lt;T,E&gt;, <a href="../../../javax/jdo/query/ComparableExpression.html" title="interface in javax.jdo.query">ComparableExpression</a>&lt;T&gt;, <a href="../../../javax/jdo/query/DateExpression.html" title="interface in javax.jdo.query">DateExpression</a>, <a href="../../../javax/jdo/query/DateTimeExpression.html" title="interface in javax.jdo.query">DateTimeExpression</a>, <a href="../../../javax/jdo/query/EnumExpression.html" title="interface in javax.jdo.query">EnumExpression</a>&lt;T&gt;, <a href="../../../javax/jdo/query/IfThenElseExpression.html" title="interface in javax.jdo.query">IfThenElseExpression</a>&lt;T&gt;, <a href="../../../javax/jdo/query/ListExpression.html" title="interface in javax.jdo.query">ListExpression</a>&lt;T,E&gt;, <a href="../../../javax/jdo/query/LocalDateExpression.html" title="interface in javax.jdo.query">LocalDateExpression</a>, <a href="../../../javax/jdo/query/LocalDateTimeExpression.html" title="interface in javax.jdo.query">LocalDateTimeExpression</a>, <a href="../../../javax/jdo/query/LocalTimeExpression.html" title="interface in javax.jdo.query">LocalTimeExpression</a>, <a href="../../../javax/jdo/query/MapExpression.html" title="interface in javax.jdo.query">MapExpression</a>&lt;T,K,V&gt;, <a href="../../../javax/jdo/query/NumericExpression.html" title="interface in javax.jdo.query">NumericExpression</a>&lt;T&gt;, <a href="../../../javax/jdo/query/ObjectExpression.html" title="interface in javax.jdo.query">ObjectExpression</a>&lt;T&gt;, <a href="../../../javax/jdo/query/OptionalExpression.html" title="interface in javax.jdo.query">OptionalExpression</a>&lt;T&gt;, <a href="../../../javax/jdo/query/PersistableExpression.html" title="interface in javax.jdo.query">PersistableExpression</a>&lt;T&gt;, <a href="../../../javax/jdo/query/StringExpression.html" title="interface in javax.jdo.query">StringExpression</a>, <a href="../../../javax/jdo/query/TimeExpression.html" title="interface in javax.jdo.query">TimeExpression</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Expression&lt;T&gt;</span></pre>
<div class="block">Representation of an expression in a query.</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="../../../javax/jdo/query/Expression.html" title="interface in javax.jdo.query">Expression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/query/Expression.html#as-java.lang.String-">as</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;alias)</code>
<div class="block">Method to return an expression with the specified alias assigned to 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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/query/Expression.html#cast-java.lang.Class-">cast</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;cls)</code>
<div class="block">Return an expression where this expression is cast to the specified type.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../javax/jdo/query/NumericExpression.html" title="interface in javax.jdo.query">NumericExpression</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/query/Expression.html#count--">count</a></span>()</code>
<div class="block">Method to return a numeric expression representing the aggregated count of this expression.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../javax/jdo/query/NumericExpression.html" title="interface in javax.jdo.query">NumericExpression</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/query/Expression.html#countDistinct--">countDistinct</a></span>()</code>
<div class="block">Method to return a numeric expression representing the aggregated (distinct) count of this expression.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../javax/jdo/query/BooleanExpression.html" title="interface in javax.jdo.query">BooleanExpression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/query/Expression.html#eq-javax.jdo.query.Expression-">eq</a></span>(<a href="../../../javax/jdo/query/Expression.html" title="interface in javax.jdo.query">Expression</a>&nbsp;expr)</code>
<div class="block">Method returning whether this expression equals the other expression.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../javax/jdo/query/BooleanExpression.html" title="interface in javax.jdo.query">BooleanExpression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/query/Expression.html#eq-T-">eq</a></span>(<a href="../../../javax/jdo/query/Expression.html" title="type parameter in Expression">T</a>&nbsp;t)</code>
<div class="block">Method returning whether this expression equals the literal.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../javax/jdo/query/BooleanExpression.html" title="interface in javax.jdo.query">BooleanExpression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/query/Expression.html#instanceOf-java.lang.Class-">instanceOf</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;cls)</code>
<div class="block">Return an expression for whether this expression is an instanceof the supplied class.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../javax/jdo/query/BooleanExpression.html" title="interface in javax.jdo.query">BooleanExpression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/query/Expression.html#ne-javax.jdo.query.Expression-">ne</a></span>(<a href="../../../javax/jdo/query/Expression.html" title="interface in javax.jdo.query">Expression</a>&nbsp;expr)</code>
<div class="block">Method returning whether this expression doesn't equal the other expression.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../javax/jdo/query/BooleanExpression.html" title="interface in javax.jdo.query">BooleanExpression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/query/Expression.html#ne-T-">ne</a></span>(<a href="../../../javax/jdo/query/Expression.html" title="type parameter in Expression">T</a>&nbsp;t)</code>
<div class="block">Method returning whether this expression doesn't equal the literal.</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="eq-javax.jdo.query.Expression-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>eq</h4>
<pre><a href="../../../javax/jdo/query/BooleanExpression.html" title="interface in javax.jdo.query">BooleanExpression</a>&nbsp;eq(<a href="../../../javax/jdo/query/Expression.html" title="interface in javax.jdo.query">Expression</a>&nbsp;expr)</pre>
<div class="block">Method returning whether this expression equals the other expression.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>expr</code> - Other expression</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Whether they are equal</dd>
</dl>
</li>
</ul>
<a name="eq-java.lang.Object-">
<!-- -->
</a><a name="eq-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>eq</h4>
<pre><a href="../../../javax/jdo/query/BooleanExpression.html" title="interface in javax.jdo.query">BooleanExpression</a>&nbsp;eq(<a href="../../../javax/jdo/query/Expression.html" title="type parameter in Expression">T</a>&nbsp;t)</pre>
<div class="block">Method returning whether this expression equals the literal.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>t</code> - Literal</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Whether they are equal</dd>
</dl>
</li>
</ul>
<a name="ne-javax.jdo.query.Expression-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ne</h4>
<pre><a href="../../../javax/jdo/query/BooleanExpression.html" title="interface in javax.jdo.query">BooleanExpression</a>&nbsp;ne(<a href="../../../javax/jdo/query/Expression.html" title="interface in javax.jdo.query">Expression</a>&nbsp;expr)</pre>
<div class="block">Method returning whether this expression doesn't equal the other expression.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>expr</code> - Other expression</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Whether they are not equal</dd>
</dl>
</li>
</ul>
<a name="ne-java.lang.Object-">
<!-- -->
</a><a name="ne-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ne</h4>
<pre><a href="../../../javax/jdo/query/BooleanExpression.html" title="interface in javax.jdo.query">BooleanExpression</a>&nbsp;ne(<a href="../../../javax/jdo/query/Expression.html" title="type parameter in Expression">T</a>&nbsp;t)</pre>
<div class="block">Method returning whether this expression doesn't equal the literal.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>t</code> - literal</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Whether they are not equal</dd>
</dl>
</li>
</ul>
<a name="count--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>count</h4>
<pre><a href="../../../javax/jdo/query/NumericExpression.html" title="interface in javax.jdo.query">NumericExpression</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&gt;&nbsp;count()</pre>
<div class="block">Method to return a numeric expression representing the aggregated count of this expression.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Numeric expression for the count</dd>
</dl>
</li>
</ul>
<a name="countDistinct--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>countDistinct</h4>
<pre><a href="../../../javax/jdo/query/NumericExpression.html" title="interface in javax.jdo.query">NumericExpression</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&gt;&nbsp;countDistinct()</pre>
<div class="block">Method to return a numeric expression representing the aggregated (distinct) count of this expression.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Numeric expression for the distinct count</dd>
</dl>
</li>
</ul>
<a name="instanceOf-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>instanceOf</h4>
<pre><a href="../../../javax/jdo/query/BooleanExpression.html" title="interface in javax.jdo.query">BooleanExpression</a>&nbsp;instanceOf(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;cls)</pre>
<div class="block">Return an expression for whether this expression is an instanceof the supplied class.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cls</code> - Class to check against</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Whether it is an instanceof</dd>
</dl>
</li>
</ul>
<a name="cast-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cast</h4>
<pre><a href="../../../javax/jdo/query/Expression.html" title="interface in javax.jdo.query">Expression</a>&nbsp;cast(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;cls)</pre>
<div class="block">Return an expression where this expression is cast to the specified type.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cls</code> - Class to cast to</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The cast expression</dd>
</dl>
</li>
</ul>
<a name="as-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>as</h4>
<pre><a href="../../../javax/jdo/query/Expression.html" title="interface in javax.jdo.query">Expression</a>&nbsp;as(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;alias)</pre>
<div class="block">Method to return an expression with the specified alias assigned to this expression.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>alias</code> - the alias for this expression</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the expression with an alias</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/Expression.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/EnumExpression.html" title="interface in javax.jdo.query"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../javax/jdo/query/IfThenElseExpression.html" title="interface 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/Expression.html" target="_top">Frames</a></li>
<li><a href="Expression.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; 2005&#x2013;1970 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>