Google Git
Sign in
eclipse / gerrit / www.eclipse.org / eclipselink / a1cc95fb3f44a7bf6484ea92c6e82c7359afaff6 / . / api / 3.0 / org / eclipse / persistence / jpa / jpql / tools / model / query / AbstractModifyStatementStateObject.html
blob: c798ae1eca40c56667811e2939520973b2b70607 [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>AbstractModifyStatementStateObject (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="AbstractModifyStatementStateObject (EclipseLink 3.0.0, API Reference)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":6,"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};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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 AbstractModifyStatementStateObject" class="title">Class AbstractModifyStatementStateObject</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>org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractModifyStatementStateObject</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="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a></code></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="DeleteStatementStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">DeleteStatementStateObject</a></code>, <code><a href="UpdateStatementStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">UpdateStatementStateObject</a></code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">AbstractModifyStatementStateObject</span>
extends <a href="AbstractStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractStateObject</a></pre>
<div class="block">The abstract definition of a modify statement. TODO</div>
<dl>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>2.4</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="DeleteStatementStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>DeleteStatementStateObject</code></a>,
<a href="UpdateStatementStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>UpdateStatementStateObject</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="#WHERE_CLAUSE_PROPERTY">WHERE_CLAUSE_PROPERTY</a></span></code></th>
<td class="colLast">
<div class="block">Notify the state object representing the <code><b>WHERE</b></code> clause has changed.</div>
</td>
</tr>
</table>
</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">Modifier</th>
<th class="colSecond" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.persistence.jpa.jpql.tools.model.query.JPQLQueryStateObject)">AbstractModifyStatementStateObject</a></span>&#8203;(<a href="JPQLQueryStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">JPQLQueryStateObject</a>&nbsp;parent)</code></th>
<td class="colLast">
<div class="block">Creates a new <code>AbstractModifyStatementStateObject</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>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="i1" class="rowColor">
<td class="colFirst"><code><a href="WhereClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">WhereClauseStateObject</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addWhereClause()">addWhereClause</a></span>()</code></th>
<td class="colLast">
<div class="block">Adds the <code><b>WHERE</b></code> clause.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected abstract <a href="AbstractModifyClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractModifyClauseStateObject</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildModifyClause()">buildModifyClause</a></span>()</code></th>
<td class="colLast">
<div class="block">Creates the actual <a href="AbstractModifyClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>AbstractModifyClauseStateObject</code></a> that represents the modify clause.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><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="#getAbstractSchemaName()">getAbstractSchemaName</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the abstract schema name.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="AbstractSchemaNameStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractSchemaNameStateObject</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAbstractSchemaNameStateObject()">getAbstractSchemaNameStateObject</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the <a href="AbstractSchemaNameStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>AbstractSchemaNameStateObject</code></a> holding onto the abstract schema name.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="DeclarationStateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">DeclarationStateObject</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDeclaration()">getDeclaration</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the declaration clause which defines the domain of the query by declaring
identification variables.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../spi/IEntity.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi">IEntity</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEntity()">getEntity</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the actual <a href="../../spi/IEntity.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi"><code>IEntity</code></a> that has the abstract schema name.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><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="#getIdentificationVariable()">getIdentificationVariable</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the identification variable name that is ranging over the abstract schema type.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="IdentificationVariableStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">IdentificationVariableStateObject</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIdentificationVariableStateObject()">getIdentificationVariableStateObject</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the <a href="IdentificationVariableStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>IdentificationVariableStateObject</code></a> holding onto the identification variable.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="AbstractModifyClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractModifyClauseStateObject</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getModifyClause()">getModifyClause</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the state object representing the modify clause part of the modify statement.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="JPQLQueryStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">JPQLQueryStateObject</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="i11" class="rowColor">
<td class="colFirst"><code><a href="RangeVariableDeclarationStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">RangeVariableDeclarationStateObject</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRangeVariableDeclaration()">getRangeVariableDeclaration</a></span>()</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> that defines the range variable declaration.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="WhereClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">WhereClauseStateObject</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getWhereClause()">getWhereClause</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the state object representing the <code><b>WHERE</b></code> clause.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasWhereClause()">hasWhereClause</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the state object representing the <code><b>WHERE</b></code> clause.</div>
</td>
</tr>
<tr id="i14" 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="i15" 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="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeWhereClause()">removeWhereClause</a></span>()</code></th>
<td class="colLast">
<div class="block">Removes the <code><b>WHERE</b></code> clause.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setConditionalStateObject(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">setConditionalStateObject</a></span>&#8203;(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&nbsp;conditionalStateObject)</code></th>
<td class="colLast">
<div class="block">Sets the given <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> to be the conditional expression of the <code><b>WHERE</b></code>
clause.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDeclaration(java.lang.String)">setDeclaration</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;abstractSchemaName)</code></th>
<td class="colLast">
<div class="block">Sets the abstract schema name to the given value and removes the identification variable.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDeclaration(java.lang.String,java.lang.String)">setDeclaration</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;abstractSchemaName,
<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;identificationVariable)</code></th>
<td class="colLast">
<div class="block">Sets the abstract schema name to the given value and the identification variable that will
range over it.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDeclaration(org.eclipse.persistence.jpa.jpql.tools.spi.IEntity)">setDeclaration</a></span>&#8203;(<a href="../../spi/IEntity.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi">IEntity</a>&nbsp;entity)</code></th>
<td class="colLast">
<div class="block">Sets the abstract schema name to the given value.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDeclaration(org.eclipse.persistence.jpa.jpql.tools.spi.IEntity,java.lang.String)">setDeclaration</a></span>&#8203;(<a href="../../spi/IEntity.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi">IEntity</a>&nbsp;entity,
<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;identificationVariable)</code></th>
<td class="colLast">
<div class="block">Sets the abstract schema name to the given value and the identification variable that will
range over it.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setEntity(org.eclipse.persistence.jpa.jpql.tools.spi.IEntity)">setEntity</a></span>&#8203;(<a href="../../spi/IEntity.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi">IEntity</a>&nbsp;entity)</code></th>
<td class="colLast">
<div class="block">Sets the actual <a href="../../spi/IEntity.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi"><code>IEntity</code></a> and updates the abstract schema name.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setEntityName(java.lang.String)">setEntityName</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;entityName)</code></th>
<td class="colLast">
<div class="block">Sets the name of the abstract schema, which is the name of the entity.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setIdentificationVariable(java.lang.String)">setIdentificationVariable</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;identificationVariable)</code></th>
<td class="colLast">
<div class="block">Sets the new identification variable that will range over the abstract schema name.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toggleWhereClause()">toggleWhereClause</a></span>()</code></th>
<td class="colLast">
<div class="block">Either adds or removes the state object representing the <code><b>WHERE</b></code> clause.</div>
</td>
</tr>
<tr id="i26" 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.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#getDecorator()">getDecorator</a>, <a href="AbstractStateObject.html#getExpression()">getExpression</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#accept(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObjectVisitor)">accept</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="WHERE_CLAUSE_PROPERTY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>WHERE_CLAUSE_PROPERTY</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> WHERE_CLAUSE_PROPERTY</pre>
<div class="block">Notify the state object representing the <code><b>WHERE</b></code> clause 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.AbstractModifyStatementStateObject.WHERE_CLAUSE_PROPERTY">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.JPQLQueryStateObject)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractModifyStatementStateObject</h4>
<pre>protected&nbsp;AbstractModifyStatementStateObject&#8203;(<a href="JPQLQueryStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">JPQLQueryStateObject</a>&nbsp;parent)</pre>
<div class="block">Creates a new <code>AbstractModifyStatementStateObject</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="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="addWhereClause()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addWhereClause</h4>
<pre class="methodSignature">public&nbsp;<a href="WhereClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">WhereClauseStateObject</a>&nbsp;addWhereClause()</pre>
<div class="block">Adds the <code><b>WHERE</b></code> clause. The clause is not added if it's already present.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The <a href="GroupByClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>GroupByClauseStateObject</code></a></dd>
</dl>
</li>
</ul>
<a id="buildModifyClause()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildModifyClause</h4>
<pre class="methodSignature">protected abstract&nbsp;<a href="AbstractModifyClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractModifyClauseStateObject</a>&nbsp;buildModifyClause()</pre>
<div class="block">Creates the actual <a href="AbstractModifyClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>AbstractModifyClauseStateObject</code></a> that represents the modify clause.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The modify clause part of this modify statement</dd>
</dl>
</li>
</ul>
<a id="getAbstractSchemaName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAbstractSchemaName</h4>
<pre class="methodSignature">public&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>&nbsp;getAbstractSchemaName()</pre>
<div class="block">Returns the abstract schema name.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The name of the abstract schema type for which the identification variable is ranging
over</dd>
</dl>
</li>
</ul>
<a id="getAbstractSchemaNameStateObject()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAbstractSchemaNameStateObject</h4>
<pre class="methodSignature">public&nbsp;<a href="AbstractSchemaNameStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractSchemaNameStateObject</a>&nbsp;getAbstractSchemaNameStateObject()</pre>
<div class="block">Returns the <a href="AbstractSchemaNameStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>AbstractSchemaNameStateObject</code></a> holding onto the abstract schema name.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The <a href="AbstractSchemaNameStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>AbstractSchemaNameStateObject</code></a>, which is never <code>null</code></dd>
</dl>
</li>
</ul>
<a id="getDeclaration()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeclaration</h4>
<pre class="methodSignature">public&nbsp;<a href="DeclarationStateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">DeclarationStateObject</a>&nbsp;getDeclaration()</pre>
<div class="block">Returns the declaration clause which defines the domain of the query by declaring
identification variables.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="StateObject.html#getDeclaration()">getDeclaration</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="AbstractStateObject.html#getDeclaration()">getDeclaration</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="returnLabel">Returns:</span></dt>
<dd>The declaration clause of which this <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> is a child; i.e. either the
top-level declaration if this is part of the top query or the sub-level declaration if this is
part of a subquery</dd>
</dl>
</li>
</ul>
<a id="getEntity()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEntity</h4>
<pre class="methodSignature">public&nbsp;<a href="../../spi/IEntity.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi">IEntity</a>&nbsp;getEntity()</pre>
<div class="block">Returns the actual <a href="../../spi/IEntity.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi"><code>IEntity</code></a> that has the abstract schema name.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The actual <a href="../../spi/IEntity.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi"><code>IEntity</code></a> or <code>null</code> if no entity exists</dd>
</dl>
</li>
</ul>
<a id="getIdentificationVariable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIdentificationVariable</h4>
<pre class="methodSignature">public&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>&nbsp;getIdentificationVariable()</pre>
<div class="block">Returns the identification variable name that is ranging over the abstract schema type.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The identification variable name</dd>
</dl>
</li>
</ul>
<a id="getIdentificationVariableStateObject()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIdentificationVariableStateObject</h4>
<pre class="methodSignature">public&nbsp;<a href="IdentificationVariableStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">IdentificationVariableStateObject</a>&nbsp;getIdentificationVariableStateObject()</pre>
<div class="block">Returns the <a href="IdentificationVariableStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>IdentificationVariableStateObject</code></a> holding onto the identification variable.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The <a href="IdentificationVariableStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>IdentificationVariableStateObject</code></a>, which is never <code>null</code></dd>
</dl>
</li>
</ul>
<a id="getModifyClause()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getModifyClause</h4>
<pre class="methodSignature">public&nbsp;<a href="AbstractModifyClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractModifyClauseStateObject</a>&nbsp;getModifyClause()</pre>
<div class="block">Returns the state object representing the modify clause part of the modify statement.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The state object representing the modify clause part of the modify statement, which is
never <code>null</code></dd>
</dl>
</li>
</ul>
<a id="getParent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParent</h4>
<pre class="methodSignature">public&nbsp;<a href="JPQLQueryStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">JPQLQueryStateObject</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="AbstractStateObject.html#getParent()">getParent</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="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="getRangeVariableDeclaration()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRangeVariableDeclaration</h4>
<pre class="methodSignature">public&nbsp;<a href="RangeVariableDeclarationStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">RangeVariableDeclarationStateObject</a>&nbsp;getRangeVariableDeclaration()</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> that defines the range variable declaration.</div>
<dl>
<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> that defines the range variable declaration, which is never
<code>null</code></dd>
</dl>
</li>
</ul>
<a id="getWhereClause()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWhereClause</h4>
<pre class="methodSignature">public&nbsp;<a href="WhereClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">WhereClauseStateObject</a>&nbsp;getWhereClause()</pre>
<div class="block">Returns the state object representing the <code><b>WHERE</b></code> clause.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Either the actual state object representing the <code><b>WHERE</b></code> clause or
the <code>null</code> state object since <code>null</code> is never returned</dd>
</dl>
</li>
</ul>
<a id="hasWhereClause()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasWhereClause</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;hasWhereClause()</pre>
<div class="block">Returns the state object representing the <code><b>WHERE</b></code> clause.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Either the actual state object representing the <code><b>WHERE</b></code> clause or
<code>null</code> if it's not present</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="AbstractStateObject.html#isEquivalent(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">isEquivalent</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>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="removeWhereClause()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeWhereClause</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;removeWhereClause()</pre>
<div class="block">Removes the <code><b>WHERE</b></code> clause.</div>
</li>
</ul>
<a id="setConditionalStateObject(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConditionalStateObject</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setConditionalStateObject&#8203;(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&nbsp;conditionalStateObject)</pre>
<div class="block">Sets the given <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> to be the conditional expression of the <code><b>WHERE</b></code>
clause.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conditionalStateObject</code> - The new conditional expression</dd>
</dl>
</li>
</ul>
<a id="setDeclaration(org.eclipse.persistence.jpa.jpql.tools.spi.IEntity)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDeclaration</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setDeclaration&#8203;(<a href="../../spi/IEntity.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi">IEntity</a>&nbsp;entity)</pre>
<div class="block">Sets the abstract schema name to the given value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entity</code> - The <a href="../../spi/IEntity.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi"><code>IEntity</code></a> that this clause will range over</dd>
</dl>
</li>
</ul>
<a id="setDeclaration(org.eclipse.persistence.jpa.jpql.tools.spi.IEntity,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDeclaration</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setDeclaration&#8203;(<a href="../../spi/IEntity.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi">IEntity</a>&nbsp;entity,
<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;identificationVariable)</pre>
<div class="block">Sets the abstract schema name to the given value and the identification variable that will
range over it.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entity</code> - The <a href="../../spi/IEntity.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi"><code>IEntity</code></a> that this clause will range over</dd>
<dd><code>identificationVariable</code> - The new identification variable</dd>
</dl>
</li>
</ul>
<a id="setDeclaration(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDeclaration</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setDeclaration&#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;abstractSchemaName)</pre>
<div class="block">Sets the abstract schema name to the given value and removes the identification variable.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>abstractSchemaName</code> - The name of the abstract schema, which is the name of the entity</dd>
</dl>
</li>
</ul>
<a id="setDeclaration(java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDeclaration</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setDeclaration&#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;abstractSchemaName,
<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;identificationVariable)</pre>
<div class="block">Sets the abstract schema name to the given value and the identification variable that will
range over it.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>abstractSchemaName</code> - The name of the abstract schema, which is the name of the entity</dd>
<dd><code>identificationVariable</code> - The new identification variable</dd>
</dl>
</li>
</ul>
<a id="setEntity(org.eclipse.persistence.jpa.jpql.tools.spi.IEntity)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEntity</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setEntity&#8203;(<a href="../../spi/IEntity.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi">IEntity</a>&nbsp;entity)</pre>
<div class="block">Sets the actual <a href="../../spi/IEntity.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi"><code>IEntity</code></a> and updates the abstract schema name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entity</code> - The <a href="../../spi/IEntity.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi"><code>IEntity</code></a> that this clause will range over</dd>
</dl>
</li>
</ul>
<a id="setEntityName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEntityName</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setEntityName&#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;entityName)</pre>
<div class="block">Sets the name of the abstract schema, which is the name of the entity.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entityName</code> - The name of the entity</dd>
</dl>
</li>
</ul>
<a id="setIdentificationVariable(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIdentificationVariable</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setIdentificationVariable&#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;identificationVariable)</pre>
<div class="block">Sets the new identification variable that will range over the abstract schema name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>identificationVariable</code> - The new identification variable</dd>
</dl>
</li>
</ul>
<a id="toggleWhereClause()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toggleWhereClause</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;toggleWhereClause()</pre>
<div class="block">Either adds or removes the state object representing the <code><b>WHERE</b></code> clause.</div>
</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>