Google Git
Sign in
eclipse / gerrit / www.eclipse.org / eclipselink / a1cc95fb3f44a7bf6484ea92c6e82c7359afaff6 / . / api / 3.0 / org / eclipse / persistence / jpa / jpql / tools / model / query / SelectClauseStateObject.html
blob: 987404c17d71a6f5b7eec9f84e539ff46dcecdee [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.2) on Wed Apr 22 10:19:16 CDT 2020 -->
<title>SelectClauseStateObject (EclipseLink 3.0.0, API Reference)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-04-22">
<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.3.1.js"></script>
<script type="text/javascript" src="../../../../../../../../jquery/jquery-migrate-3.0.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="SelectClauseStateObject (EclipseLink 3.0.0, API Reference)";
}
}
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":10,"i15":10,"i16":10,"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,"i30":10,"i31":10,"i32":10};
var tabs = {65535:["t0","All 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 = true;
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="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">EclipseLink 3.0.0, API Reference</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.eclipse.persistence.jpa.jpql.tools.model.query</a></div>
<h2 title="Class SelectClauseStateObject" class="title">Class SelectClauseStateObject</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><a href="AbstractStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject</a></li>
<li>
<ul class="inheritance">
<li><a href="AbstractSelectClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSelectClauseStateObject</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.persistence.jpa.jpql.tools.model.query.SelectClauseStateObject</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="ListHolderStateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">ListHolderStateObject</a>&lt;<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&gt;</code>, <code><a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">SelectClauseStateObject</span>
extends <a href="AbstractSelectClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractSelectClauseStateObject</a>
implements <a href="ListHolderStateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">ListHolderStateObject</a>&lt;<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&gt;</pre>
<div class="block">The <code><b>SELECT</b></code> statement queries data from entities, which determines the type of
the objects or values to be selected.
<pre><code>BNF: select_clause ::= SELECT [DISTINCT] select_expression {, select_expression}*
select_expression ::= single_valued_path_expression |
aggregate_expression |
identification_variable |
OBJECT(identification_variable) |
constructor_expression</code></pre></div>
<dl>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>2.4</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="SelectStatementStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>SelectStatementStateObject</code></a>,
<a href="../../../parser/SelectClause.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><code>SelectClause</code></a></dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Pascal Filion</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.4</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>static <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="#SELECT_ITEMS_LIST">SELECT_ITEMS_LIST</a></span></code></th>
<td class="colLast">
<div class="block">A constant used to notify the list of select expressions has changed.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSelectClauseStateObject">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.persistence.jpa.jpql.tools.model.query.<a href="AbstractSelectClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractSelectClauseStateObject</a></h3>
<code><a href="AbstractSelectClauseStateObject.html#DISTINCT_PROPERTY">DISTINCT_PROPERTY</a></code></li>
</ul>
</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(org.eclipse.persistence.jpa.jpql.tools.model.query.SelectStatementStateObject)">SelectClauseStateObject</a></span>&#8203;(<a href="SelectStatementStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">SelectStatementStateObject</a>&nbsp;parent)</code></th>
<td class="colLast">
<div class="block">Creates a new <code>SelectClauseStateObject</code>.</div>
</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="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>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#accept(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObjectVisitor)">accept</a></span>&#8203;(<a href="StateObjectVisitor.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObjectVisitor</a>&nbsp;visitor)</code></th>
<td class="colLast">
<div class="block">Visits this <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> by the given <a href="StateObjectVisitor.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>visitor</code></a>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addChildren(java.util.List)">addChildren</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="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&gt;&nbsp;children)</code></th>
<td class="colLast">
<div class="block">Adds the children of this <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> to the given list.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addItem(java.lang.String)">addItem</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;jpqlFragment)</code></th>
<td class="colLast">
<div class="block">Adds the given path as a select item, which can either be an identification variable or a
state-field path expression.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="ResultVariableStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">ResultVariableStateObject</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addItem(java.lang.String,java.lang.String)">addItem</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;jpqlFragment,
<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;resultVariable)</code></th>
<td class="colLast">
<div class="block">Adds the given expression as a select item.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="ResultVariableStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">ResultVariableStateObject</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addItem(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject,java.lang.String)">addItem</a></span>&#8203;(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&nbsp;stateObject,
<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;resultVariable)</code></th>
<td class="colLast">
<div class="block">Adds the given <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> as a select item.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>&lt;S extends <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&gt;<br>S</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addItem(S)">addItem</a></span>&#8203;(S&nbsp;item)</code></th>
<td class="colLast">
<div class="block">Adds the given <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> as a child of this one.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="ResultVariableStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">ResultVariableStateObject</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addItemAs(java.lang.String,java.lang.String)">addItemAs</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;jpqlFragment,
<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;resultVariable)</code></th>
<td class="colLast">
<div class="block">Adds the given JPQL fragment as a select item.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="ResultVariableStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">ResultVariableStateObject</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addItemAs(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject,java.lang.String)">addItemAs</a></span>&#8203;(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&nbsp;stateObject,
<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;resultVariable)</code></th>
<td class="colLast">
<div class="block">Adds the given <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> as a select item.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addItems(java.util.List)">addItems</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;? extends <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&gt;&nbsp;items)</code></th>
<td class="colLast">
<div class="block">Adds the given list of <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObjects</code></a> as children of this one.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addListChangeListener(java.lang.String,org.eclipse.persistence.jpa.jpql.tools.model.IListChangeListener)">addListChangeListener</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;listName,
<a href="../IListChangeListener.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model">IListChangeListener</a>&lt;<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&gt;&nbsp;listener)</code></th>
<td class="colLast">
<div class="block">Registers the given <a href="../IListChangeListener.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model"><code>IListChangeListener</code></a> for the specified list.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#areChildrenEquivalent(org.eclipse.persistence.jpa.jpql.tools.model.query.SelectClauseStateObject)">areChildrenEquivalent</a></span>&#8203;(<a href="SelectClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">SelectClauseStateObject</a>&nbsp;stateObject)</code></th>
<td class="colLast">
<div class="block">Determines whether the children of this <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> are equivalent to the children
of the given one, i.e.</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="#canMoveDown(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">canMoveDown</a></span>&#8203;(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&nbsp;item)</code></th>
<td class="colLast">
<div class="block">Determines whether the given <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> can be moved down by one position in the
list owned by its parent.</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="#canMoveUp(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">canMoveUp</a></span>&#8203;(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&nbsp;item)</code></th>
<td class="colLast">
<div class="block">Determines whether the given <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> can be moved up by one position in the list
owned by its parent.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../ISelectExpressionStateObjectBuilder.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model">ISelectExpressionStateObjectBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBuilder()">getBuilder</a></span>()</code></th>
<td class="colLast">
<div class="block">Creates and returns a new <a href="../ISelectExpressionStateObjectBuilder.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model"><code>ISelectExpressionStateObjectBuilder</code></a> that can be used to
programmatically create a single select expression and once the expression is complete,
<a href="../ISelectExpressionStateObjectBuilder.html#commit()"><code>ISelectExpressionStateObjectBuilder.commit()</code></a> will push the <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a>
representation of that expression as this clause's select expression.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../../parser/SelectClause.html" title="class in org.eclipse.persistence.jpa.jpql.parser">SelectClause</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExpression()">getExpression</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the actual parsed object if this <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> representation of the JPQL query
was created by parsing an existing JPQL query.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="FromClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">FromClauseStateObject</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFromClause()">getFromClause</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the <a href="AbstractFromClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>AbstractFromClauseStateObject</code></a> representing the <b>FROM</b> clause.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getItem(int)">getItem</a></span>&#8203;(int&nbsp;index)</code></th>
<td class="colLast">
<div class="block">Returns the <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> at the given positions from the list</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="SelectStatementStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">SelectStatementStateObject</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParent()">getParent</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the parent of this <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a>.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasItems()">hasItems</a></span>()</code></th>
<td class="colLast">
<div class="block">Determines whether this <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> has any children.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasSelectItem()">hasSelectItem</a></span>()</code></th>
<td class="colLast">
<div class="block">Determines whether this <code><b>SELECT</b></code> clause has a select item defined (only one
can be set for a subquery's <code><b>SELECT</b></code> clause and many for a top-level query).</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#initialize()">initialize</a></span>()</code></th>
<td class="colLast">
<div class="block">Initializes this state object.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isEquivalent(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">isEquivalent</a></span>&#8203;(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&nbsp;stateObject)</code></th>
<td class="colLast">
<div class="block">Determines whether the given <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> is equivalent to this one, i.e.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code><a href="../../../utility/iterable/ListIterable.html" title="interface in org.eclipse.persistence.jpa.jpql.utility.iterable">ListIterable</a>&lt;<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#items()">items</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns an <a href="../../../utility/iterable/ListIterable.html" title="interface in org.eclipse.persistence.jpa.jpql.utility.iterable"><code>ListIterable</code></a> over the children.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#itemsSize()">itemsSize</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the number of children this list holder has.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#moveDown(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">moveDown</a></span>&#8203;(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&nbsp;item)</code></th>
<td class="colLast">
<div class="block">Moves the given <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> down by one position in the list owned by its parent.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code><a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#moveUp(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">moveUp</a></span>&#8203;(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&nbsp;item)</code></th>
<td class="colLast">
<div class="block">Moves the given <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> up by one position in the list owned by its parent.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parse(java.lang.String)">parse</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;jpqlFragment)</code></th>
<td class="colLast">
<div class="block">Parses the given JPQL fragment and create the select item.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeItem(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">removeItem</a></span>&#8203;(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&nbsp;stateObject)</code></th>
<td class="colLast">
<div class="block">Removes the given <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> from the list of children.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeItems(java.util.Collection)">removeItems</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;<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&gt;&nbsp;items)</code></th>
<td class="colLast">
<div class="block">Removes the given <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> from the list of children.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeListChangeListener(java.lang.String,org.eclipse.persistence.jpa.jpql.tools.model.IListChangeListener)">removeListChangeListener</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;listName,
<a href="../IListChangeListener.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model">IListChangeListener</a>&lt;<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&gt;&nbsp;listener)</code></th>
<td class="colLast">
<div class="block">Unregisters the given <a href="../IListChangeListener.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model"><code>IListChangeListener</code></a> that was registered for the specified list.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setExpression(org.eclipse.persistence.jpa.jpql.parser.SelectClause)">setExpression</a></span>&#8203;(<a href="../../../parser/SelectClause.html" title="class in org.eclipse.persistence.jpa.jpql.parser">SelectClause</a>&nbsp;expression)</code></th>
<td class="colLast">
<div class="block">Keeps a reference of the <a href="../../../parser/SelectClause.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><code>parsed object</code></a> object, which should only be
done when this object is instantiated during the conversion of a parsed JPQL query into
<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObjects</code></a>.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setItems(java.util.List)">setItems</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="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&gt;&nbsp;stateObjects)</code></th>
<td class="colLast">
<div class="block">Sets the select expression to be those contained on the given collection.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toTextInternal(java.lang.Appendable)">toTextInternal</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Appendable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Appendable</a>&nbsp;writer)</code></th>
<td class="colLast">
<div class="block">Prints out a string representation of this <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a>, which should not be used to
define a <code>true</code> string representation of a JPQL query but should be used for
debugging purposes.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSelectClauseStateObject">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.persistence.jpa.jpql.tools.model.query.<a href="AbstractSelectClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractSelectClauseStateObject</a></h3>
<code><a href="AbstractSelectClauseStateObject.html#hasDistinct()">hasDistinct</a>, <a href="AbstractSelectClauseStateObject.html#setDistinct(boolean)">setDistinct</a>, <a href="AbstractSelectClauseStateObject.html#toggleDistinct()">toggleDistinct</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.persistence.jpa.jpql.tools.model.query.<a href="AbstractStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractStateObject</a></h3>
<code><a href="AbstractStateObject.html#acceptUnknownVisitor(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObjectVisitor)">acceptUnknownVisitor</a>, <a href="AbstractStateObject.html#acceptUnknownVisitor(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObjectVisitor,java.lang.Class,java.lang.Class)">acceptUnknownVisitor</a>, <a href="AbstractStateObject.html#addProblems(java.util.List)">addProblems</a>, <a href="AbstractStateObject.html#addPropertyChangeListener(java.lang.String,org.eclipse.persistence.jpa.jpql.tools.model.IPropertyChangeListener)">addPropertyChangeListener</a>, <a href="AbstractStateObject.html#areEquivalent(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject,org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">areEquivalent</a>, <a href="AbstractStateObject.html#buildProblem(java.lang.String)">buildProblem</a>, <a href="AbstractStateObject.html#buildProblem(java.lang.String,java.lang.String...)">buildProblem</a>, <a href="AbstractStateObject.html#buildStateObject(java.lang.CharSequence,java.lang.String)">buildStateObject</a>, <a href="AbstractStateObject.html#buildStateObjects(java.lang.CharSequence,java.lang.String)">buildStateObjects</a>, <a href="AbstractStateObject.html#checkParent(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">checkParent</a>, <a href="AbstractStateObject.html#children()">children</a>, <a href="AbstractStateObject.html#decorate(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">decorate</a>, <a href="AbstractStateObject.html#equals(java.lang.Object)">equals</a>, <a href="AbstractStateObject.html#findIdentificationVariable(java.lang.String)">findIdentificationVariable</a>, <a href="AbstractStateObject.html#firePropertyChanged(java.lang.String,java.lang.Object,java.lang.Object)">firePropertyChanged</a>, <a href="AbstractStateObject.html#getChangeSupport()">getChangeSupport</a>, <a href="AbstractStateObject.html#getDeclaration()">getDeclaration</a>, <a href="AbstractStateObject.html#getDecorator()">getDecorator</a>, <a href="AbstractStateObject.html#getGrammar()">getGrammar</a>, <a href="AbstractStateObject.html#getManagedTypeProvider()">getManagedTypeProvider</a>, <a href="AbstractStateObject.html#getQueryBuilder()">getQueryBuilder</a>, <a href="AbstractStateObject.html#getRoot()">getRoot</a>, <a href="AbstractStateObject.html#getType(java.lang.Class)">getType</a>, <a href="AbstractStateObject.html#getType(java.lang.String)">getType</a>, <a href="AbstractStateObject.html#getTypeHelper()">getTypeHelper</a>, <a href="AbstractStateObject.html#getTypeRepository()">getTypeRepository</a>, <a href="AbstractStateObject.html#hashCode()">hashCode</a>, <a href="AbstractStateObject.html#isDecorated()">isDecorated</a>, <a href="AbstractStateObject.html#parent(java.util.List)">parent</a>, <a href="AbstractStateObject.html#parent(T)">parent</a>, <a href="AbstractStateObject.html#parent(T...)">parent</a>, <a href="AbstractStateObject.html#removePropertyChangeListener(java.lang.String,org.eclipse.persistence.jpa.jpql.tools.model.IPropertyChangeListener)">removePropertyChangeListener</a>, <a href="AbstractStateObject.html#setExpression(org.eclipse.persistence.jpa.jpql.parser.Expression)">setExpression</a>, <a href="AbstractStateObject.html#setParent(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">setParent</a>, <a href="AbstractStateObject.html#toString()">toString</a>, <a href="AbstractStateObject.html#toString(java.lang.Appendable)">toString</a>, <a href="AbstractStateObject.html#toStringInternal(java.lang.Appendable)">toStringInternal</a>, <a href="AbstractStateObject.html#toStringItems(java.lang.Appendable,java.util.List,boolean)">toStringItems</a>, <a href="AbstractStateObject.html#toText(java.lang.Appendable)">toText</a></code></li>
</ul>
<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.org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.persistence.jpa.jpql.tools.model.query.<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a></h3>
<code><a href="StateObject.html#addPropertyChangeListener(java.lang.String,org.eclipse.persistence.jpa.jpql.tools.model.IPropertyChangeListener)">addPropertyChangeListener</a>, <a href="StateObject.html#children()">children</a>, <a href="StateObject.html#decorate(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">decorate</a>, <a href="StateObject.html#findIdentificationVariable(java.lang.String)">findIdentificationVariable</a>, <a href="StateObject.html#getDeclaration()">getDeclaration</a>, <a href="StateObject.html#getDecorator()">getDecorator</a>, <a href="StateObject.html#getGrammar()">getGrammar</a>, <a href="StateObject.html#getManagedTypeProvider()">getManagedTypeProvider</a>, <a href="StateObject.html#getQueryBuilder()">getQueryBuilder</a>, <a href="StateObject.html#getRoot()">getRoot</a>, <a href="StateObject.html#isDecorated()">isDecorated</a>, <a href="StateObject.html#removePropertyChangeListener(java.lang.String,org.eclipse.persistence.jpa.jpql.tools.model.IPropertyChangeListener)">removePropertyChangeListener</a>, <a href="StateObject.html#setParent(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">setParent</a>, <a href="StateObject.html#toString(java.lang.Appendable)">toString</a>, <a href="StateObject.html#toText(java.lang.Appendable)">toText</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="SELECT_ITEMS_LIST">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SELECT_ITEMS_LIST</h4>
<pre>public static final&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> SELECT_ITEMS_LIST</pre>
<div class="block">A constant used to notify the list of select expressions has changed.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../../constant-values.html#org.eclipse.persistence.jpa.jpql.tools.model.query.SelectClauseStateObject.SELECT_ITEMS_LIST">Constant Field Values</a></dd>
</dl>
</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;(org.eclipse.persistence.jpa.jpql.tools.model.query.SelectStatementStateObject)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SelectClauseStateObject</h4>
<pre>public&nbsp;SelectClauseStateObject&#8203;(<a href="SelectStatementStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">SelectStatementStateObject</a>&nbsp;parent)</pre>
<div class="block">Creates a new <code>SelectClauseStateObject</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parent</code> - The parent of this state object, which cannot be <code>null</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - The given parent cannot be <code>null</code></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="accept(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObjectVisitor)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>accept</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;accept&#8203;(<a href="StateObjectVisitor.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObjectVisitor</a>&nbsp;visitor)</pre>
<div class="block">Visits this <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> by the given <a href="StateObjectVisitor.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>visitor</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="StateObject.html#accept(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObjectVisitor)">accept</a></code>&nbsp;in interface&nbsp;<code><a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>visitor</code> - The <a href="StateObjectVisitor.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>visitor</code></a> to visit this object</dd>
</dl>
</li>
</ul>
<a id="addChildren(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addChildren</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;addChildren&#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="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&gt;&nbsp;children)</pre>
<div class="block">Adds the children of this <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> to the given list.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="AbstractStateObject.html#addChildren(java.util.List)">addChildren</a></code>&nbsp;in class&nbsp;<code><a href="AbstractStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractStateObject</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>children</code> - The list used to store the children</dd>
</dl>
</li>
</ul>
<a id="addItem(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addItem</h4>
<pre class="methodSignature">public&nbsp;<a href="ResultVariableStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">ResultVariableStateObject</a>&nbsp;addItem&#8203;(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&nbsp;stateObject,
<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;resultVariable)</pre>
<div class="block">Adds the given <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> as a select item.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stateObject</code> - The <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> representing the select expression</dd>
<dd><code>resultVariable</code> - The result variable identifying the select expression</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The newly created <a href="ResultVariableStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>ResultVariableStateObject</code></a></dd>
</dl>
</li>
</ul>
<a id="addItem(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addItem</h4>
<pre class="methodSignature">public&nbsp;<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&nbsp;addItem&#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;jpqlFragment)</pre>
<div class="block">Adds the given path as a select item, which can either be an identification variable or a
state-field path expression.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jpqlFragment</code> - The select expression to parse as a select item</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> encapsulating the given path</dd>
</dl>
</li>
</ul>
<a id="addItem(java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addItem</h4>
<pre class="methodSignature">public&nbsp;<a href="ResultVariableStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">ResultVariableStateObject</a>&nbsp;addItem&#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;jpqlFragment,
<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;resultVariable)</pre>
<div class="block">Adds the given expression as a select item.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jpqlFragment</code> - The select expression to parse as a select item</dd>
<dd><code>resultVariable</code> - The result variable identifying the select expression</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The newly created <a href="ResultVariableStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>ResultVariableStateObject</code></a></dd>
</dl>
</li>
</ul>
<a id="addItem(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">
<!-- -->
</a><a id="addItem(S)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addItem</h4>
<pre class="methodSignature">public&nbsp;&lt;S extends <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&gt;&nbsp;S&nbsp;addItem&#8203;(S&nbsp;item)</pre>
<div class="block">Adds the given <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> as a child of this one.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ListHolderStateObject.html#addItem(S)">addItem</a></code>&nbsp;in interface&nbsp;<code><a href="ListHolderStateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">ListHolderStateObject</a>&lt;<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>item</code> - The child <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> to become a child of this one
return The given item</dd>
</dl>
</li>
</ul>
<a id="addItemAs(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addItemAs</h4>
<pre class="methodSignature">public&nbsp;<a href="ResultVariableStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">ResultVariableStateObject</a>&nbsp;addItemAs&#8203;(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&nbsp;stateObject,
<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;resultVariable)</pre>
<div class="block">Adds the given <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> as a select item.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stateObject</code> - The <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> representing the select expression</dd>
<dd><code>resultVariable</code> - The result variable identifying the select expression</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The newly created <a href="ResultVariableStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>ResultVariableStateObject</code></a></dd>
</dl>
</li>
</ul>
<a id="addItemAs(java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addItemAs</h4>
<pre class="methodSignature">public&nbsp;<a href="ResultVariableStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">ResultVariableStateObject</a>&nbsp;addItemAs&#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;jpqlFragment,
<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;resultVariable)</pre>
<div class="block">Adds the given JPQL fragment as a select item.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jpqlFragment</code> - The portion of a JPQL query that represents a select expression</dd>
<dd><code>resultVariable</code> - The result variable identifying the select expression</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The newly created <a href="ResultVariableStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>ResultVariableStateObject</code></a></dd>
</dl>
</li>
</ul>
<a id="addItems(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addItems</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;addItems&#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;? extends <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&gt;&nbsp;items)</pre>
<div class="block">Adds the given list of <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObjects</code></a> as children of this one.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ListHolderStateObject.html#addItems(java.util.List)">addItems</a></code>&nbsp;in interface&nbsp;<code><a href="ListHolderStateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">ListHolderStateObject</a>&lt;<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>items</code> - The <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObjects</code></a> to become children of this one</dd>
</dl>
</li>
</ul>
<a id="addListChangeListener(java.lang.String,org.eclipse.persistence.jpa.jpql.tools.model.IListChangeListener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addListChangeListener</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;addListChangeListener&#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;listName,
<a href="../IListChangeListener.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model">IListChangeListener</a>&lt;<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&gt;&nbsp;listener)</pre>
<div class="block">Registers the given <a href="../IListChangeListener.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model"><code>IListChangeListener</code></a> for the specified list. The listener will be
notified only when items are added, removed, moved from the list.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ListHolderStateObject.html#addListChangeListener(java.lang.String,org.eclipse.persistence.jpa.jpql.tools.model.IListChangeListener)">addListChangeListener</a></code>&nbsp;in interface&nbsp;<code><a href="ListHolderStateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">ListHolderStateObject</a>&lt;<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listName</code> - The name of the list for which the listener will be notified when the content
of the list has changed</dd>
<dd><code>listener</code> - The listener to be notified upon changes</dd>
</dl>
</li>
</ul>
<a id="areChildrenEquivalent(org.eclipse.persistence.jpa.jpql.tools.model.query.SelectClauseStateObject)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>areChildrenEquivalent</h4>
<pre class="methodSignature">protected&nbsp;boolean&nbsp;areChildrenEquivalent&#8203;(<a href="SelectClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">SelectClauseStateObject</a>&nbsp;stateObject)</pre>
<div class="block">Determines whether the children of this <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> are equivalent to the children
of the given one, i.e. the information of the <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObjects</code></a> is the same.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stateObject</code> - The <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> to compare its children to this one's children</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if both have equivalent children; <code>false</code> otherwise</dd>
</dl>
</li>
</ul>
<a id="canMoveDown(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>canMoveDown</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;canMoveDown&#8203;(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&nbsp;item)</pre>
<div class="block">Determines whether the given <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> can be moved down by one position in the
list owned by its parent.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ListHolderStateObject.html#canMoveDown(T)">canMoveDown</a></code>&nbsp;in interface&nbsp;<code><a href="ListHolderStateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">ListHolderStateObject</a>&lt;<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>item</code> - The <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> that could potentially be moved down</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the object can be moved down by one unit; <code>false</code>
otherwise</dd>
</dl>
</li>
</ul>
<a id="canMoveUp(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>canMoveUp</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;canMoveUp&#8203;(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&nbsp;item)</pre>
<div class="block">Determines whether the given <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> can be moved up by one position in the list
owned by its parent.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ListHolderStateObject.html#canMoveUp(T)">canMoveUp</a></code>&nbsp;in interface&nbsp;<code><a href="ListHolderStateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">ListHolderStateObject</a>&lt;<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>item</code> - The <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> that could potentially be moved up</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the object can be moved up by one unit; <code>false</code>
otherwise</dd>
</dl>
</li>
</ul>
<a id="getBuilder()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBuilder</h4>
<pre class="methodSignature">public&nbsp;<a href="../ISelectExpressionStateObjectBuilder.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model">ISelectExpressionStateObjectBuilder</a>&nbsp;getBuilder()</pre>
<div class="block">Creates and returns a new <a href="../ISelectExpressionStateObjectBuilder.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model"><code>ISelectExpressionStateObjectBuilder</code></a> that can be used to
programmatically create a single select expression and once the expression is complete,
<a href="../ISelectExpressionStateObjectBuilder.html#commit()"><code>ISelectExpressionStateObjectBuilder.commit()</code></a> will push the <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a>
representation of that expression as this clause's select expression.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A new builder that can be used to quickly create a select expression</dd>
</dl>
</li>
</ul>
<a id="getExpression()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExpression</h4>
<pre class="methodSignature">public&nbsp;<a href="../../../parser/SelectClause.html" title="class in org.eclipse.persistence.jpa.jpql.parser">SelectClause</a>&nbsp;getExpression()</pre>
<div class="block">Returns the actual parsed object if this <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> representation of the JPQL query
was created by parsing an existing JPQL query.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="StateObject.html#getExpression()">getExpression</a></code>&nbsp;in interface&nbsp;<code><a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="AbstractSelectClauseStateObject.html#getExpression()">getExpression</a></code>&nbsp;in class&nbsp;<code><a href="AbstractSelectClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractSelectClauseStateObject</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The parsed object when a JPQL query is parsed and converted into a <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a>
or <code>null</code> when the JPQL query is manually created (i.e. not from a string)</dd>
</dl>
</li>
</ul>
<a id="getFromClause()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFromClause</h4>
<pre class="methodSignature">public&nbsp;<a href="FromClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">FromClauseStateObject</a>&nbsp;getFromClause()</pre>
<div class="block">Returns the <a href="AbstractFromClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>AbstractFromClauseStateObject</code></a> representing the <b>FROM</b> clause.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="AbstractSelectClauseStateObject.html#getFromClause()">getFromClause</a></code>&nbsp;in class&nbsp;<code><a href="AbstractSelectClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractSelectClauseStateObject</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The state object representing the <b>FROM</b> clause</dd>
</dl>
</li>
</ul>
<a id="getItem(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getItem</h4>
<pre class="methodSignature">public&nbsp;<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&nbsp;getItem&#8203;(int&nbsp;index)</pre>
<div class="block">Returns the <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> at the given positions from the list</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ListHolderStateObject.html#getItem(int)">getItem</a></code>&nbsp;in interface&nbsp;<code><a href="ListHolderStateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">ListHolderStateObject</a>&lt;<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - The position of the <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> to retrieve</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> at the given position</dd>
</dl>
</li>
</ul>
<a id="getParent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParent</h4>
<pre class="methodSignature">public&nbsp;<a href="SelectStatementStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">SelectStatementStateObject</a>&nbsp;getParent()</pre>
<div class="block">Returns the parent of this <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="StateObject.html#getParent()">getParent</a></code>&nbsp;in interface&nbsp;<code><a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="AbstractSelectClauseStateObject.html#getParent()">getParent</a></code>&nbsp;in class&nbsp;<code><a href="AbstractSelectClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractSelectClauseStateObject</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Returns the parent of this <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a>, which is <code>null</code> only when
this is the root of the hierarchy</dd>
</dl>
</li>
</ul>
<a id="hasItems()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasItems</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;hasItems()</pre>
<div class="block">Determines whether this <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> has any children.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ListHolderStateObject.html#hasItems()">hasItems</a></code>&nbsp;in interface&nbsp;<code><a href="ListHolderStateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">ListHolderStateObject</a>&lt;<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if this <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> has children; <code>false</code> otherwise</dd>
</dl>
</li>
</ul>
<a id="hasSelectItem()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasSelectItem</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;hasSelectItem()</pre>
<div class="block">Determines whether this <code><b>SELECT</b></code> clause has a select item defined (only one
can be set for a subquery's <code><b>SELECT</b></code> clause and many for a top-level query).</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="AbstractSelectClauseStateObject.html#hasSelectItem()">hasSelectItem</a></code>&nbsp;in class&nbsp;<code><a href="AbstractSelectClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractSelectClauseStateObject</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if this state object has children; <code>false</code> otherwise</dd>
</dl>
</li>
</ul>
<a id="initialize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initialize</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;initialize()</pre>
<div class="block">Initializes this state object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="AbstractStateObject.html#initialize()">initialize</a></code>&nbsp;in class&nbsp;<code><a href="AbstractStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractStateObject</a></code></dd>
</dl>
</li>
</ul>
<a id="isEquivalent(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEquivalent</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isEquivalent&#8203;(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&nbsp;stateObject)</pre>
<div class="block">Determines whether the given <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> is equivalent to this one, i.e. the
information of both <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> is the same.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="StateObject.html#isEquivalent(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">isEquivalent</a></code>&nbsp;in interface&nbsp;<code><a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="AbstractSelectClauseStateObject.html#isEquivalent(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">isEquivalent</a></code>&nbsp;in class&nbsp;<code><a href="AbstractSelectClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractSelectClauseStateObject</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stateObject</code> - The <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> to compare its content to this one</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if both object are equivalent; <code>false</code> otherwise</dd>
</dl>
</li>
</ul>
<a id="items()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>items</h4>
<pre class="methodSignature">public&nbsp;<a href="../../../utility/iterable/ListIterable.html" title="interface in org.eclipse.persistence.jpa.jpql.utility.iterable">ListIterable</a>&lt;<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&gt;&nbsp;items()</pre>
<div class="block">Returns an <a href="../../../utility/iterable/ListIterable.html" title="interface in org.eclipse.persistence.jpa.jpql.utility.iterable"><code>ListIterable</code></a> over the children.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ListHolderStateObject.html#items()">items</a></code>&nbsp;in interface&nbsp;<code><a href="ListHolderStateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">ListHolderStateObject</a>&lt;<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An <a href="../../../utility/iterable/ListIterable.html" title="interface in org.eclipse.persistence.jpa.jpql.utility.iterable"><code>ListIterable</code></a> that is iterating over the children</dd>
</dl>
</li>
</ul>
<a id="itemsSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>itemsSize</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;itemsSize()</pre>
<div class="block">Returns the number of children this list holder has.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ListHolderStateObject.html#itemsSize()">itemsSize</a></code>&nbsp;in interface&nbsp;<code><a href="ListHolderStateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">ListHolderStateObject</a>&lt;<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The count of <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObjects</code></a> that are children of this one</dd>
</dl>
</li>
</ul>
<a id="moveDown(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>moveDown</h4>
<pre class="methodSignature">public&nbsp;<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&nbsp;moveDown&#8203;(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&nbsp;item)</pre>
<div class="block">Moves the given <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> down by one position in the list owned by its parent.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ListHolderStateObject.html#moveDown(T)">moveDown</a></code>&nbsp;in interface&nbsp;<code><a href="ListHolderStateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">ListHolderStateObject</a>&lt;<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>item</code> - The <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> to move down in the list</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The given item</dd>
</dl>
</li>
</ul>
<a id="moveUp(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>moveUp</h4>
<pre class="methodSignature">public&nbsp;<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&nbsp;moveUp&#8203;(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&nbsp;item)</pre>
<div class="block">Moves the given <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> up by one position in the list owned by its parent.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ListHolderStateObject.html#moveUp(T)">moveUp</a></code>&nbsp;in interface&nbsp;<code><a href="ListHolderStateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">ListHolderStateObject</a>&lt;<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>item</code> - The <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> to move up in the list</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The given item</dd>
</dl>
</li>
</ul>
<a id="parse(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parse</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;parse&#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;jpqlFragment)</pre>
<div class="block">Parses the given JPQL fragment and create the select item. For the top-level query, the
fragment can contain several select items but for a subquery, it can represent only one.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="AbstractSelectClauseStateObject.html#parse(java.lang.String)">parse</a></code>&nbsp;in class&nbsp;<code><a href="AbstractSelectClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractSelectClauseStateObject</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jpqlFragment</code> - The portion of the query representing one or several select items</dd>
</dl>
</li>
</ul>
<a id="removeItem(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeItem</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;removeItem&#8203;(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&nbsp;stateObject)</pre>
<div class="block">Removes the given <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> from the list of children.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ListHolderStateObject.html#removeItem(T)">removeItem</a></code>&nbsp;in interface&nbsp;<code><a href="ListHolderStateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">ListHolderStateObject</a>&lt;<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stateObject</code> - The child <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> to not longer be a child</dd>
</dl>
</li>
</ul>
<a id="removeItems(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeItems</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;removeItems&#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;<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&gt;&nbsp;items)</pre>
<div class="block">Removes the given <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> from the list of children.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ListHolderStateObject.html#removeItems(java.util.Collection)">removeItems</a></code>&nbsp;in interface&nbsp;<code><a href="ListHolderStateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">ListHolderStateObject</a>&lt;<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>items</code> - The <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObjects</code></a> to remove from this one</dd>
</dl>
</li>
</ul>
<a id="removeListChangeListener(java.lang.String,org.eclipse.persistence.jpa.jpql.tools.model.IListChangeListener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeListChangeListener</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;removeListChangeListener&#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;listName,
<a href="../IListChangeListener.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model">IListChangeListener</a>&lt;<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&gt;&nbsp;listener)</pre>
<div class="block">Unregisters the given <a href="../IListChangeListener.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model"><code>IListChangeListener</code></a> that was registered for the specified list.
The listener will no longer be notified only when items are added, removed, moved from the
list.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ListHolderStateObject.html#removeListChangeListener(java.lang.String,org.eclipse.persistence.jpa.jpql.tools.model.IListChangeListener)">removeListChangeListener</a></code>&nbsp;in interface&nbsp;<code><a href="ListHolderStateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">ListHolderStateObject</a>&lt;<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listName</code> - The name of the list for which the listener was registered</dd>
<dd><code>listener</code> - The listener to unregister</dd>
</dl>
</li>
</ul>
<a id="setExpression(org.eclipse.persistence.jpa.jpql.parser.SelectClause)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExpression</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setExpression&#8203;(<a href="../../../parser/SelectClause.html" title="class in org.eclipse.persistence.jpa.jpql.parser">SelectClause</a>&nbsp;expression)</pre>
<div class="block">Keeps a reference of the <a href="../../../parser/SelectClause.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><code>parsed object</code></a> object, which should only be
done when this object is instantiated during the conversion of a parsed JPQL query into
<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObjects</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>expression</code> - The <a href="../../../parser/SelectClause.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><code>parsed object</code></a> representing a <code><b>SELECT</b></code>
clause</dd>
</dl>
</li>
</ul>
<a id="setItems(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setItems</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setItems&#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="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&gt;&nbsp;stateObjects)</pre>
<div class="block">Sets the select expression to be those contained on the given collection. If any select items
were already set, they will be removed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stateObjects</code> - The new select expressions</dd>
</dl>
</li>
</ul>
<a id="toTextInternal(java.lang.Appendable)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toTextInternal</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;toTextInternal&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Appendable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Appendable</a>&nbsp;writer)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
<div class="block">Prints out a string representation of this <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a>, which should not be used to
define a <code>true</code> string representation of a JPQL query but should be used for
debugging purposes.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="AbstractStateObject.html#toTextInternal(java.lang.Appendable)">toTextInternal</a></code>&nbsp;in class&nbsp;<code><a href="AbstractStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractStateObject</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>writer</code> - The writer used to print out the string representation</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - This should never happens, it is only required because <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Appendable.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Appendable</code></a>
is used instead of any concrete class</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="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">EclipseLink 3.0.0, API Reference</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; 2017&#x2013;2020 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p>
</footer>
</body>
</html>