blob: d0134a3878d80958b29efcaf4aae110bad5be6bd [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>
<title>AbstractQuery</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="AbstractQuery";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":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="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>Prev&nbsp;Class</li>
<li><a href="../../../javax/persistence/criteria/CollectionJoin.html" title="interface in javax.persistence.criteria"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/persistence/criteria/AbstractQuery.html" target="_top">Frames</a></li>
<li><a href="AbstractQuery.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.persistence.criteria</div>
<h2 title="Interface AbstractQuery" class="title">Interface AbstractQuery&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> - the type of the result</dd>
</dl>
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../javax/persistence/criteria/CommonAbstractCriteria.html" title="interface in javax.persistence.criteria">CommonAbstractCriteria</a></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../javax/persistence/criteria/CriteriaQuery.html" title="interface in javax.persistence.criteria">CriteriaQuery</a>&lt;T&gt;, <a href="../../../javax/persistence/criteria/Subquery.html" title="interface in javax.persistence.criteria">Subquery</a>&lt;T&gt;</dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">AbstractQuery&lt;T&gt;</span>
extends <a href="../../../javax/persistence/criteria/CommonAbstractCriteria.html" title="interface in javax.persistence.criteria">CommonAbstractCriteria</a></pre>
<div class="block">The <code>AbstractQuery</code> interface defines functionality that is common
to both top-level queries and subqueries.
It is not intended to be used directly in query construction.
<p> All queries must have:
a set of root entities (which may in turn own joins).
<p> All queries may have:
a conjunction of restrictions.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Java Persistence 2.0</dd>
</dl>
</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/persistence/criteria/AbstractQuery.html" title="interface in javax.persistence.criteria">AbstractQuery</a>&lt;<a href="../../../javax/persistence/criteria/AbstractQuery.html" title="type parameter in AbstractQuery">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/persistence/criteria/AbstractQuery.html#distinct-boolean-">distinct</a></span>(boolean&nbsp;distinct)</code>
<div class="block">Specify whether duplicate query results will be eliminated.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>&lt;X&gt;&nbsp;<a href="../../../javax/persistence/criteria/Root.html" title="interface in javax.persistence.criteria">Root</a>&lt;X&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/persistence/criteria/AbstractQuery.html#from-java.lang.Class-">from</a></span>(java.lang.Class&lt;X&gt;&nbsp;entityClass)</code>
<div class="block">Create and add a query root corresponding to the given entity,
forming a cartesian product with any existing roots.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>&lt;X&gt;&nbsp;<a href="../../../javax/persistence/criteria/Root.html" title="interface in javax.persistence.criteria">Root</a>&lt;X&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/persistence/criteria/AbstractQuery.html#from-javax.persistence.metamodel.EntityType-">from</a></span>(<a href="../../../javax/persistence/metamodel/EntityType.html" title="interface in javax.persistence.metamodel">EntityType</a>&lt;X&gt;&nbsp;entity)</code>
<div class="block">Create and add a query root corresponding to the given entity,
forming a cartesian product with any existing roots.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../javax/persistence/criteria/Expression.html" title="interface in javax.persistence.criteria">Expression</a>&lt;?&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/persistence/criteria/AbstractQuery.html#getGroupList--">getGroupList</a></span>()</code>
<div class="block">Return a list of the grouping expressions.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../javax/persistence/criteria/Predicate.html" title="interface in javax.persistence.criteria">Predicate</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/persistence/criteria/AbstractQuery.html#getGroupRestriction--">getGroupRestriction</a></span>()</code>
<div class="block">Return the predicate that corresponds to the restriction(s)
over the grouping items, or null if no restrictions have
been specified.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.Class&lt;<a href="../../../javax/persistence/criteria/AbstractQuery.html" title="type parameter in AbstractQuery">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/persistence/criteria/AbstractQuery.html#getResultType--">getResultType</a></span>()</code>
<div class="block">Return the result type of the query or subquery.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.util.Set&lt;<a href="../../../javax/persistence/criteria/Root.html" title="interface in javax.persistence.criteria">Root</a>&lt;?&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/persistence/criteria/AbstractQuery.html#getRoots--">getRoots</a></span>()</code>
<div class="block">Return the query roots.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../javax/persistence/criteria/Selection.html" title="interface in javax.persistence.criteria">Selection</a>&lt;<a href="../../../javax/persistence/criteria/AbstractQuery.html" title="type parameter in AbstractQuery">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/persistence/criteria/AbstractQuery.html#getSelection--">getSelection</a></span>()</code>
<div class="block">Return the selection of the query, or null if no selection
has been set.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../javax/persistence/criteria/AbstractQuery.html" title="interface in javax.persistence.criteria">AbstractQuery</a>&lt;<a href="../../../javax/persistence/criteria/AbstractQuery.html" title="type parameter in AbstractQuery">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/persistence/criteria/AbstractQuery.html#groupBy-javax.persistence.criteria.Expression...-">groupBy</a></span>(<a href="../../../javax/persistence/criteria/Expression.html" title="interface in javax.persistence.criteria">Expression</a>&lt;?&gt;...&nbsp;grouping)</code>
<div class="block">Specify the expressions that are used to form groups over
the query results.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../javax/persistence/criteria/AbstractQuery.html" title="interface in javax.persistence.criteria">AbstractQuery</a>&lt;<a href="../../../javax/persistence/criteria/AbstractQuery.html" title="type parameter in AbstractQuery">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/persistence/criteria/AbstractQuery.html#groupBy-java.util.List-">groupBy</a></span>(java.util.List&lt;<a href="../../../javax/persistence/criteria/Expression.html" title="interface in javax.persistence.criteria">Expression</a>&lt;?&gt;&gt;&nbsp;grouping)</code>
<div class="block">Specify the expressions that are used to form groups over
the query results.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../javax/persistence/criteria/AbstractQuery.html" title="interface in javax.persistence.criteria">AbstractQuery</a>&lt;<a href="../../../javax/persistence/criteria/AbstractQuery.html" title="type parameter in AbstractQuery">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/persistence/criteria/AbstractQuery.html#having-javax.persistence.criteria.Expression-">having</a></span>(<a href="../../../javax/persistence/criteria/Expression.html" title="interface in javax.persistence.criteria">Expression</a>&lt;java.lang.Boolean&gt;&nbsp;restriction)</code>
<div class="block">Specify a restriction over the groups of the query.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../javax/persistence/criteria/AbstractQuery.html" title="interface in javax.persistence.criteria">AbstractQuery</a>&lt;<a href="../../../javax/persistence/criteria/AbstractQuery.html" title="type parameter in AbstractQuery">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/persistence/criteria/AbstractQuery.html#having-javax.persistence.criteria.Predicate...-">having</a></span>(<a href="../../../javax/persistence/criteria/Predicate.html" title="interface in javax.persistence.criteria">Predicate</a>...&nbsp;restrictions)</code>
<div class="block">Specify restrictions over the groups of the query
according the conjunction of the specified restriction
predicates.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/persistence/criteria/AbstractQuery.html#isDistinct--">isDistinct</a></span>()</code>
<div class="block">Return whether duplicate query results must be eliminated or
retained.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../javax/persistence/criteria/AbstractQuery.html" title="interface in javax.persistence.criteria">AbstractQuery</a>&lt;<a href="../../../javax/persistence/criteria/AbstractQuery.html" title="type parameter in AbstractQuery">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/persistence/criteria/AbstractQuery.html#where-javax.persistence.criteria.Expression-">where</a></span>(<a href="../../../javax/persistence/criteria/Expression.html" title="interface in javax.persistence.criteria">Expression</a>&lt;java.lang.Boolean&gt;&nbsp;restriction)</code>
<div class="block">Modify the query to restrict the query results according
to the specified boolean expression.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../../javax/persistence/criteria/AbstractQuery.html" title="interface in javax.persistence.criteria">AbstractQuery</a>&lt;<a href="../../../javax/persistence/criteria/AbstractQuery.html" title="type parameter in AbstractQuery">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/persistence/criteria/AbstractQuery.html#where-javax.persistence.criteria.Predicate...-">where</a></span>(<a href="../../../javax/persistence/criteria/Predicate.html" title="interface in javax.persistence.criteria">Predicate</a>...&nbsp;restrictions)</code>
<div class="block">Modify the query to restrict the query results according
to the conjunction of the specified restriction predicates.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.javax.persistence.criteria.CommonAbstractCriteria">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;javax.persistence.criteria.<a href="../../../javax/persistence/criteria/CommonAbstractCriteria.html" title="interface in javax.persistence.criteria">CommonAbstractCriteria</a></h3>
<code><a href="../../../javax/persistence/criteria/CommonAbstractCriteria.html#getRestriction--">getRestriction</a>, <a href="../../../javax/persistence/criteria/CommonAbstractCriteria.html#subquery-java.lang.Class-">subquery</a></code></li>
</ul>
</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="from-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>from</h4>
<pre>&lt;X&gt;&nbsp;<a href="../../../javax/persistence/criteria/Root.html" title="interface in javax.persistence.criteria">Root</a>&lt;X&gt;&nbsp;from(java.lang.Class&lt;X&gt;&nbsp;entityClass)</pre>
<div class="block">Create and add a query root corresponding to the given entity,
forming a cartesian product with any existing roots.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entityClass</code> - the entity class</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>query root corresponding to the given entity</dd>
</dl>
</li>
</ul>
<a name="from-javax.persistence.metamodel.EntityType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>from</h4>
<pre>&lt;X&gt;&nbsp;<a href="../../../javax/persistence/criteria/Root.html" title="interface in javax.persistence.criteria">Root</a>&lt;X&gt;&nbsp;from(<a href="../../../javax/persistence/metamodel/EntityType.html" title="interface in javax.persistence.metamodel">EntityType</a>&lt;X&gt;&nbsp;entity)</pre>
<div class="block">Create and add a query root corresponding to the given entity,
forming a cartesian product with any existing roots.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entity</code> - metamodel entity representing the entity
of type X</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>query root corresponding to the given entity</dd>
</dl>
</li>
</ul>
<a name="where-javax.persistence.criteria.Expression-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>where</h4>
<pre><a href="../../../javax/persistence/criteria/AbstractQuery.html" title="interface in javax.persistence.criteria">AbstractQuery</a>&lt;<a href="../../../javax/persistence/criteria/AbstractQuery.html" title="type parameter in AbstractQuery">T</a>&gt;&nbsp;where(<a href="../../../javax/persistence/criteria/Expression.html" title="interface in javax.persistence.criteria">Expression</a>&lt;java.lang.Boolean&gt;&nbsp;restriction)</pre>
<div class="block">Modify the query to restrict the query results according
to the specified boolean expression.
Replaces the previously added restriction(s), if any.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>restriction</code> - a simple or compound boolean expression</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the modified query</dd>
</dl>
</li>
</ul>
<a name="where-javax.persistence.criteria.Predicate...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>where</h4>
<pre><a href="../../../javax/persistence/criteria/AbstractQuery.html" title="interface in javax.persistence.criteria">AbstractQuery</a>&lt;<a href="../../../javax/persistence/criteria/AbstractQuery.html" title="type parameter in AbstractQuery">T</a>&gt;&nbsp;where(<a href="../../../javax/persistence/criteria/Predicate.html" title="interface in javax.persistence.criteria">Predicate</a>...&nbsp;restrictions)</pre>
<div class="block">Modify the query to restrict the query results according
to the conjunction of the specified restriction predicates.
Replaces the previously added restriction(s), if any.
If no restrictions are specified, any previously added
restrictions are simply removed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>restrictions</code> - zero or more restriction predicates</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the modified query</dd>
</dl>
</li>
</ul>
<a name="groupBy-javax.persistence.criteria.Expression...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>groupBy</h4>
<pre><a href="../../../javax/persistence/criteria/AbstractQuery.html" title="interface in javax.persistence.criteria">AbstractQuery</a>&lt;<a href="../../../javax/persistence/criteria/AbstractQuery.html" title="type parameter in AbstractQuery">T</a>&gt;&nbsp;groupBy(<a href="../../../javax/persistence/criteria/Expression.html" title="interface in javax.persistence.criteria">Expression</a>&lt;?&gt;...&nbsp;grouping)</pre>
<div class="block">Specify the expressions that are used to form groups over
the query results.
Replaces the previous specified grouping expressions, if any.
If no grouping expressions are specified, any previously
added grouping expressions are simply removed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>grouping</code> - zero or more grouping expressions</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the modified query</dd>
</dl>
</li>
</ul>
<a name="groupBy-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>groupBy</h4>
<pre><a href="../../../javax/persistence/criteria/AbstractQuery.html" title="interface in javax.persistence.criteria">AbstractQuery</a>&lt;<a href="../../../javax/persistence/criteria/AbstractQuery.html" title="type parameter in AbstractQuery">T</a>&gt;&nbsp;groupBy(java.util.List&lt;<a href="../../../javax/persistence/criteria/Expression.html" title="interface in javax.persistence.criteria">Expression</a>&lt;?&gt;&gt;&nbsp;grouping)</pre>
<div class="block">Specify the expressions that are used to form groups over
the query results.
Replaces the previous specified grouping expressions, if any.
If no grouping expressions are specified, any previously
added grouping expressions are simply removed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>grouping</code> - list of zero or more grouping expressions</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the modified query</dd>
</dl>
</li>
</ul>
<a name="having-javax.persistence.criteria.Expression-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>having</h4>
<pre><a href="../../../javax/persistence/criteria/AbstractQuery.html" title="interface in javax.persistence.criteria">AbstractQuery</a>&lt;<a href="../../../javax/persistence/criteria/AbstractQuery.html" title="type parameter in AbstractQuery">T</a>&gt;&nbsp;having(<a href="../../../javax/persistence/criteria/Expression.html" title="interface in javax.persistence.criteria">Expression</a>&lt;java.lang.Boolean&gt;&nbsp;restriction)</pre>
<div class="block">Specify a restriction over the groups of the query.
Replaces the previous having restriction(s), if any.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>restriction</code> - a simple or compound boolean expression</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the modified query</dd>
</dl>
</li>
</ul>
<a name="having-javax.persistence.criteria.Predicate...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>having</h4>
<pre><a href="../../../javax/persistence/criteria/AbstractQuery.html" title="interface in javax.persistence.criteria">AbstractQuery</a>&lt;<a href="../../../javax/persistence/criteria/AbstractQuery.html" title="type parameter in AbstractQuery">T</a>&gt;&nbsp;having(<a href="../../../javax/persistence/criteria/Predicate.html" title="interface in javax.persistence.criteria">Predicate</a>...&nbsp;restrictions)</pre>
<div class="block">Specify restrictions over the groups of the query
according the conjunction of the specified restriction
predicates.
Replaces the previously having added restriction(s), if any.
If no restrictions are specified, any previously added
restrictions are simply removed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>restrictions</code> - zero or more restriction predicates</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the modified query</dd>
</dl>
</li>
</ul>
<a name="distinct-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>distinct</h4>
<pre><a href="../../../javax/persistence/criteria/AbstractQuery.html" title="interface in javax.persistence.criteria">AbstractQuery</a>&lt;<a href="../../../javax/persistence/criteria/AbstractQuery.html" title="type parameter in AbstractQuery">T</a>&gt;&nbsp;distinct(boolean&nbsp;distinct)</pre>
<div class="block">Specify whether duplicate query results will be eliminated.
A true value will cause duplicates to be eliminated.
A false value will cause duplicates to be retained.
If distinct has not been specified, duplicate results must
be retained.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>distinct</code> - boolean value specifying whether duplicate
results must be eliminated from the query result or
whether they must be retained</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the modified query</dd>
</dl>
</li>
</ul>
<a name="getRoots--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRoots</h4>
<pre>java.util.Set&lt;<a href="../../../javax/persistence/criteria/Root.html" title="interface in javax.persistence.criteria">Root</a>&lt;?&gt;&gt;&nbsp;getRoots()</pre>
<div class="block">Return the query roots. These are the roots that have
been defined for the <code>CriteriaQuery</code> or <code>Subquery</code> itself,
including any subquery roots defined as a result of
correlation. Returns empty set if no roots have been defined.
Modifications to the set do not affect the query.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the set of query roots</dd>
</dl>
</li>
</ul>
<a name="getSelection--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSelection</h4>
<pre><a href="../../../javax/persistence/criteria/Selection.html" title="interface in javax.persistence.criteria">Selection</a>&lt;<a href="../../../javax/persistence/criteria/AbstractQuery.html" title="type parameter in AbstractQuery">T</a>&gt;&nbsp;getSelection()</pre>
<div class="block">Return the selection of the query, or null if no selection
has been set.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>selection item</dd>
</dl>
</li>
</ul>
<a name="getGroupList--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGroupList</h4>
<pre>java.util.List&lt;<a href="../../../javax/persistence/criteria/Expression.html" title="interface in javax.persistence.criteria">Expression</a>&lt;?&gt;&gt;&nbsp;getGroupList()</pre>
<div class="block">Return a list of the grouping expressions. Returns empty
list if no grouping expressions have been specified.
Modifications to the list do not affect the query.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the list of grouping expressions</dd>
</dl>
</li>
</ul>
<a name="getGroupRestriction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGroupRestriction</h4>
<pre><a href="../../../javax/persistence/criteria/Predicate.html" title="interface in javax.persistence.criteria">Predicate</a>&nbsp;getGroupRestriction()</pre>
<div class="block">Return the predicate that corresponds to the restriction(s)
over the grouping items, or null if no restrictions have
been specified.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>having clause predicate</dd>
</dl>
</li>
</ul>
<a name="isDistinct--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDistinct</h4>
<pre>boolean&nbsp;isDistinct()</pre>
<div class="block">Return whether duplicate query results must be eliminated or
retained.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>boolean indicating whether duplicate query results
must be eliminated</dd>
</dl>
</li>
</ul>
<a name="getResultType--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getResultType</h4>
<pre>java.lang.Class&lt;<a href="../../../javax/persistence/criteria/AbstractQuery.html" title="type parameter in AbstractQuery">T</a>&gt;&nbsp;getResultType()</pre>
<div class="block">Return the result type of the query or subquery. If a result
type was specified as an argument to the
<code>createQuery</code> or <code>subquery</code> method, that
type will be returned. If the query was created using the
<code>createTupleQuery</code> method, the result type is
<code>Tuple</code>. Otherwise, the result type is
<code>Object</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>result type</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="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>Prev&nbsp;Class</li>
<li><a href="../../../javax/persistence/criteria/CollectionJoin.html" title="interface in javax.persistence.criteria"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/persistence/criteria/AbstractQuery.html" target="_top">Frames</a></li>
<li><a href="AbstractQuery.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 ======= -->
</body>
</html>