Google Git
Sign in
eclipse / gerrit / www.eclipse.org / eclipselink / a1cc95fb3f44a7bf6484ea92c6e82c7359afaff6 / . / api / 3.0 / org / eclipse / persistence / jpa / jpql / tools / model / query / AbstractConditionalClauseStateObject.html
blob: 3c210ba1f6e9ac1f40acb2b29da1c1b6d503ff0c [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>AbstractConditionalClauseStateObject (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="AbstractConditionalClauseStateObject (EclipseLink 3.0.0, API Reference)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":6,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":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 AbstractConditionalClauseStateObject" class="title">Class AbstractConditionalClauseStateObject</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.AbstractConditionalClauseStateObject</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="HavingClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">HavingClauseStateObject</a></code>, <code><a href="WhenClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">WhenClauseStateObject</a></code>, <code><a href="WhereClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">WhereClauseStateObject</a></code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">AbstractConditionalClauseStateObject</span>
extends <a href="AbstractStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractStateObject</a></pre>
<div class="block">Conditional expressions are composed of other conditional expressions, comparison operations,
logical operations, path expressions that evaluate to boolean values, boolean literals, and
boolean input parameters. Arithmetic expressions can be used in comparison expressions.
Arithmetic expressions are composed of other arithmetic expressions, arithmetic operations, path
expressions that evaluate to numeric values, numeric literals, and numeric input parameters.
Arithmetic operations use numeric promotion. Standard bracketing () for ordering expression
evaluation is supported.
<div><b>BNF:</b> <code>expression ::= identifier conditional_expression</code><p></div></div>
<dl>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>2.4</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../parser/AbstractConditionalClause.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><code>AbstractConditionalClause</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="#CONDITIONAL_STATE_OBJECT_PROPERTY">CONDITIONAL_STATE_OBJECT_PROPERTY</a></span></code></th>
<td class="colLast">
<div class="block">Notifies the conditional expression property 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.StateObject)">AbstractConditionalClauseStateObject</a></span>&#8203;(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&nbsp;parent)</code></th>
<td class="colLast">
<div class="block">Creates a new <code>AbstractConditionalClauseStateObject</code>.</div>
</td>
</tr>
<tr class="rowColor">
<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.StateObject,org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">AbstractConditionalClauseStateObject</a></span>&#8203;(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&nbsp;parent,
<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">Creates a new <code>AbstractConditionalClauseStateObject</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="AndExpressionStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AndExpressionStateObject</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#andParse(java.lang.String)">andParse</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 as the right side of an <code><b>AND</b></code> expression.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../IConditionalExpressionStateObjectBuilder.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model">IConditionalExpressionStateObjectBuilder</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="../IConditionalExpressionStateObjectBuilder.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model"><code>IConditionalExpressionStateObjectBuilder</code></a> that can be used to
programmatically create a conditional expression and once the expression is complete,
<a href="../IConditionalExpressionStateObjectBuilder.html#commit()"><code>IConditionalExpressionStateObjectBuilder.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 conditional expression.</div>
</td>
</tr>
<tr id="i3" 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="#getConditional()">getConditional</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the state object representing the composition of the conditional expressions.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>abstract <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="#getIdentifier()">getIdentifier</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the JPQL identifier of this clause.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasConditional()">hasConditional</a></span>()</code></th>
<td class="colLast">
<div class="block">Determines whether the <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> representing the conditional expression is present
or not.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<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="i7" class="rowColor">
<td class="colFirst"><code><a href="OrExpressionStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">OrExpressionStateObject</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#orParse(java.lang.String)">orParse</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 as the right side of an <code><b>OR</b></code> expression.</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="#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, which represents a conditional expression, and creates the
<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a>.</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="#setConditional(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">setConditional</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 this clause.</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="#shouldEncapsulateORExpression(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">shouldEncapsulateORExpression</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">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<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#getDeclaration()">getDeclaration</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#getParent()">getParent</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#initialize()">initialize</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="CONDITIONAL_STATE_OBJECT_PROPERTY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CONDITIONAL_STATE_OBJECT_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> CONDITIONAL_STATE_OBJECT_PROPERTY</pre>
<div class="block">Notifies the conditional expression property 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.AbstractConditionalClauseStateObject.CONDITIONAL_STATE_OBJECT_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.StateObject)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>AbstractConditionalClauseStateObject</h4>
<pre>protected&nbsp;AbstractConditionalClauseStateObject&#8203;(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&nbsp;parent)</pre>
<div class="block">Creates a new <code>AbstractConditionalClauseStateObject</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>
<a id="&lt;init&gt;(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject,org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractConditionalClauseStateObject</h4>
<pre>protected&nbsp;AbstractConditionalClauseStateObject&#8203;(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&nbsp;parent,
<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&nbsp;conditionalStateObject)</pre>
<div class="block">Creates a new <code>AbstractConditionalClauseStateObject</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>
<dd><code>conditionalStateObject</code> - The <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> representing the conditional expression</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="andParse(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>andParse</h4>
<pre class="methodSignature">public&nbsp;<a href="AndExpressionStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AndExpressionStateObject</a>&nbsp;andParse&#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 as the right side of an <code><b>AND</b></code> expression. The
current conditional expression will become the left side of the <code><b>AND</b></code>
expression.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jpqlFragment</code> - The portion of the query representing the right side of the
<code><b>AND</b></code> expression</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The newly created <a href="AndExpressionStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>AndExpressionStateObject</code></a></dd>
</dl>
</li>
</ul>
<a id="getBuilder()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBuilder</h4>
<pre class="methodSignature">public&nbsp;<a href="../IConditionalExpressionStateObjectBuilder.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model">IConditionalExpressionStateObjectBuilder</a>&nbsp;getBuilder()</pre>
<div class="block">Creates and returns a new <a href="../IConditionalExpressionStateObjectBuilder.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model"><code>IConditionalExpressionStateObjectBuilder</code></a> that can be used to
programmatically create a conditional expression and once the expression is complete,
<a href="../IConditionalExpressionStateObjectBuilder.html#commit()"><code>IConditionalExpressionStateObjectBuilder.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 conditional expression.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A new builder that can be used to quickly create a conditional expression</dd>
</dl>
</li>
</ul>
<a id="getConditional()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConditional</h4>
<pre class="methodSignature">public&nbsp;<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&nbsp;getConditional()</pre>
<div class="block">Returns the state object representing the composition of the conditional expressions.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The actual conditional expression</dd>
</dl>
</li>
</ul>
<a id="getIdentifier()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIdentifier</h4>
<pre class="methodSignature">public abstract&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;getIdentifier()</pre>
<div class="block">Returns the JPQL identifier of this clause.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The JPQL identifier of this conditional clause</dd>
</dl>
</li>
</ul>
<a id="hasConditional()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasConditional</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;hasConditional()</pre>
<div class="block">Determines whether the <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> representing the conditional expression is present
or not.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the conditional expression is not <code>null</code>;
<code>false</code> otherwise</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="orParse(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>orParse</h4>
<pre class="methodSignature">public&nbsp;<a href="OrExpressionStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">OrExpressionStateObject</a>&nbsp;orParse&#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 as the right side of an <code><b>OR</b></code> expression. The
current conditional expression will become the left side of the <code><b>OR</b></code>
expression.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jpqlFragment</code> - The portion of the query representing the right side of the
<code><b>OR</b></code> expression</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The newly created <a href="OrExpressionStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>OrExpressionStateObject</code></a></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, which represents a conditional expression, and creates the
<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jpqlFragment</code> - The portion of the query representing a conditional expression</dd>
</dl>
</li>
</ul>
<a id="setConditional(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConditional</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setConditional&#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 this clause.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conditionalStateObject</code> - The new <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> representing the conditional
expression</dd>
</dl>
</li>
</ul>
<a id="shouldEncapsulateORExpression(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldEncapsulateORExpression</h4>
<pre class="methodSignature">protected&nbsp;boolean&nbsp;shouldEncapsulateORExpression&#8203;(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&nbsp;stateObject)</pre>
</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>