Google Git
Sign in
eclipse / gerrit / www.eclipse.org / eclipselink / a1cc95fb3f44a7bf6484ea92c6e82c7359afaff6 / . / api / 3.0 / org / eclipse / persistence / jpa / jpql / tools / model / query / AbsExpressionStateObject.html
blob: 2432306bb3c7dfadf656d06a13406564e30c44cb [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>AbsExpressionStateObject (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="AbsExpressionStateObject (EclipseLink 3.0.0, API Reference)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage">EclipseLink 3.0.0, API Reference</div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&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 AbsExpressionStateObject" class="title">Class AbsExpressionStateObject</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="AbstractStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject</a></li>
<li>
<ul class="inheritance">
<li><a href="AbstractEncapsulatedExpressionStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractEncapsulatedExpressionStateObject</a></li>
<li>
<ul class="inheritance">
<li><a href="AbstractSingleEncapsulatedExpressionStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.persistence.jpa.jpql.tools.model.query.AbsExpressionStateObject</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">AbsExpressionStateObject</span>
extends <a href="AbstractSingleEncapsulatedExpressionStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractSingleEncapsulatedExpressionStateObject</a></pre>
<div class="block">The <code><b>ABS</b></code> function removes the minus sign from a specified argument and returns
the absolute value, which is always a positive number or zero.
<p>
This is one of the JPQL arithmetic functions. The <code><b>ABS</b></code> function takes a
numeric argument and returns a number (integer, float, or double) of the same type as the
argument to the function.
<div><b>BNF:</b> <code>expression ::= ABS(simple_arithmetic_expression)</code></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/AbsExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><code>AbsExpression</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>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.persistence.jpa.jpql.tools.model.query.<a href="AbstractSingleEncapsulatedExpressionStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractSingleEncapsulatedExpressionStateObject</a></h3>
<code><a href="AbstractSingleEncapsulatedExpressionStateObject.html#STATE_OBJECT_PROPERTY">STATE_OBJECT_PROPERTY</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colSecond" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&nbsp;</code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">AbsExpressionStateObject</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>AbsExpressionStateObject</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,java.lang.String)">AbsExpressionStateObject</a></span>&#8203;(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&nbsp;parent,
<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">Creates a new <code>AbsExpressionStateObject</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&nbsp;</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)">AbsExpressionStateObject</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;stateObject)</code></th>
<td class="colLast">
<div class="block">Creates a new <code>AbsExpressionStateObject</code>.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#accept(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObjectVisitor)">accept</a></span>&#8203;(<a href="StateObjectVisitor.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObjectVisitor</a>&nbsp;visitor)</code></th>
<td class="colLast">
<div class="block">Visits this <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> by the given <a href="StateObjectVisitor.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>visitor</code></a>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../parser/AbsExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser">AbsExpression</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExpression()">getExpression</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the actual parsed object if this <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> representation of the JPQL query
was created by parsing an existing JPQL query.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<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="#getIdentifier()">getIdentifier</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the JPQL identifier of the expression represented by this <a href="AbstractSingleEncapsulatedExpressionStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>AbstractSingleEncapsulatedExpressionStateObject</code></a>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected <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="#getQueryBNFId()">getQueryBNFId</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the unique identifier of the <a href="../../../parser/JPQLQueryBNF.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><code>JPQLQueryBNF</code></a> that will determine how to parse the encapsulated expression.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setExpression(org.eclipse.persistence.jpa.jpql.parser.AbsExpression)">setExpression</a></span>&#8203;(<a href="../../../parser/AbsExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser">AbsExpression</a>&nbsp;expression)</code></th>
<td class="colLast">
<div class="block">Keeps a reference of the <a href="../../../parser/AbsExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><code>parsed object</code></a> object, which should only be
done when this object is instantiated during the conversion of a parsed JPQL query into
<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObjects</code></a>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setStateObject(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">setStateObject</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">Sets the given <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> to represent the new encapsulated expression.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractSingleEncapsulatedExpressionStateObject">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.persistence.jpa.jpql.tools.model.query.<a href="AbstractSingleEncapsulatedExpressionStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractSingleEncapsulatedExpressionStateObject</a></h3>
<code><a href="AbstractSingleEncapsulatedExpressionStateObject.html#addChildren(java.util.List)">addChildren</a>, <a href="AbstractSingleEncapsulatedExpressionStateObject.html#getStateObject()">getStateObject</a>, <a href="AbstractSingleEncapsulatedExpressionStateObject.html#hasStateObject()">hasStateObject</a>, <a href="AbstractSingleEncapsulatedExpressionStateObject.html#isEquivalent(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">isEquivalent</a>, <a href="AbstractSingleEncapsulatedExpressionStateObject.html#parse(java.lang.String)">parse</a>, <a href="AbstractSingleEncapsulatedExpressionStateObject.html#toTextEncapsulatedExpression(java.lang.Appendable)">toTextEncapsulatedExpression</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractEncapsulatedExpressionStateObject">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.persistence.jpa.jpql.tools.model.query.<a href="AbstractEncapsulatedExpressionStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractEncapsulatedExpressionStateObject</a></h3>
<code><a href="AbstractEncapsulatedExpressionStateObject.html#toTextInternal(java.lang.Appendable)">toTextInternal</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.persistence.jpa.jpql.tools.model.query.<a href="AbstractStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractStateObject</a></h3>
<code><a href="AbstractStateObject.html#acceptUnknownVisitor(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObjectVisitor)">acceptUnknownVisitor</a>, <a href="AbstractStateObject.html#acceptUnknownVisitor(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObjectVisitor,java.lang.Class,java.lang.Class)">acceptUnknownVisitor</a>, <a href="AbstractStateObject.html#addProblems(java.util.List)">addProblems</a>, <a href="AbstractStateObject.html#addPropertyChangeListener(java.lang.String,org.eclipse.persistence.jpa.jpql.tools.model.IPropertyChangeListener)">addPropertyChangeListener</a>, <a href="AbstractStateObject.html#areEquivalent(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject,org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">areEquivalent</a>, <a href="AbstractStateObject.html#buildProblem(java.lang.String)">buildProblem</a>, <a href="AbstractStateObject.html#buildProblem(java.lang.String,java.lang.String...)">buildProblem</a>, <a href="AbstractStateObject.html#buildStateObject(java.lang.CharSequence,java.lang.String)">buildStateObject</a>, <a href="AbstractStateObject.html#buildStateObjects(java.lang.CharSequence,java.lang.String)">buildStateObjects</a>, <a href="AbstractStateObject.html#checkParent(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">checkParent</a>, <a href="AbstractStateObject.html#children()">children</a>, <a href="AbstractStateObject.html#decorate(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">decorate</a>, <a href="AbstractStateObject.html#equals(java.lang.Object)">equals</a>, <a href="AbstractStateObject.html#findIdentificationVariable(java.lang.String)">findIdentificationVariable</a>, <a href="AbstractStateObject.html#firePropertyChanged(java.lang.String,java.lang.Object,java.lang.Object)">firePropertyChanged</a>, <a href="AbstractStateObject.html#getChangeSupport()">getChangeSupport</a>, <a href="AbstractStateObject.html#getDeclaration()">getDeclaration</a>, <a href="AbstractStateObject.html#getDecorator()">getDecorator</a>, <a href="AbstractStateObject.html#getGrammar()">getGrammar</a>, <a href="AbstractStateObject.html#getManagedTypeProvider()">getManagedTypeProvider</a>, <a href="AbstractStateObject.html#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>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= 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>AbsExpressionStateObject</h4>
<pre>public&nbsp;AbsExpressionStateObject&#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>AbsExpressionStateObject</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="blockList">
<li class="blockList">
<h4>AbsExpressionStateObject</h4>
<pre>public&nbsp;AbsExpressionStateObject&#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;stateObject)</pre>
<div class="block">Creates a new <code>AbsExpressionStateObject</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>stateObject</code> - The <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> representing the encapsulated 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>
<a id="&lt;init&gt;(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject,java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbsExpressionStateObject</h4>
<pre>protected&nbsp;AbsExpressionStateObject&#8203;(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&nbsp;parent,
<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">Creates a new <code>AbsExpressionStateObject</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>jpqlFragment</code> - The portion of the query representing the encapsulated 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="accept(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObjectVisitor)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>accept</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;accept&#8203;(<a href="StateObjectVisitor.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObjectVisitor</a>&nbsp;visitor)</pre>
<div class="block">Visits this <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> by the given <a href="StateObjectVisitor.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>visitor</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>visitor</code> - The <a href="StateObjectVisitor.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>visitor</code></a> to visit this object</dd>
</dl>
</li>
</ul>
<a id="getExpression()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExpression</h4>
<pre class="methodSignature">public&nbsp;<a href="../../../parser/AbsExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser">AbsExpression</a>&nbsp;getExpression()</pre>
<div class="block">Returns the actual parsed object if this <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> representation of the JPQL query
was created by parsing an existing JPQL query.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="StateObject.html#getExpression()">getExpression</a></code>&nbsp;in interface&nbsp;<code><a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="AbstractSingleEncapsulatedExpressionStateObject.html#getExpression()">getExpression</a></code>&nbsp;in class&nbsp;<code><a href="AbstractSingleEncapsulatedExpressionStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractSingleEncapsulatedExpressionStateObject</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The parsed object when a JPQL query is parsed and converted into a <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a>
or <code>null</code> when the JPQL query is manually created (i.e. not from a string)</dd>
</dl>
</li>
</ul>
<a id="getIdentifier()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIdentifier</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;getIdentifier()</pre>
<div class="block">Returns the JPQL identifier of the expression represented by this <a href="AbstractSingleEncapsulatedExpressionStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>AbstractSingleEncapsulatedExpressionStateObject</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="AbstractEncapsulatedExpressionStateObject.html#getIdentifier()">getIdentifier</a></code>&nbsp;in class&nbsp;<code><a href="AbstractEncapsulatedExpressionStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractEncapsulatedExpressionStateObject</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The JPQL identifier that is shown before the left parenthesis</dd>
</dl>
</li>
</ul>
<a id="getQueryBNFId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueryBNFId</h4>
<pre class="methodSignature">protected&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;getQueryBNFId()</pre>
<div class="block">Returns the unique identifier of the <a href="../../../parser/JPQLQueryBNF.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><code>JPQLQueryBNF</code></a> that will determine how to parse the encapsulated expression.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="AbstractSingleEncapsulatedExpressionStateObject.html#getQueryBNFId()">getQueryBNFId</a></code>&nbsp;in class&nbsp;<code><a href="AbstractSingleEncapsulatedExpressionStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractSingleEncapsulatedExpressionStateObject</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The non-<code>null</code> ID of the BNF</dd>
</dl>
</li>
</ul>
<a id="setExpression(org.eclipse.persistence.jpa.jpql.parser.AbsExpression)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExpression</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setExpression&#8203;(<a href="../../../parser/AbsExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser">AbsExpression</a>&nbsp;expression)</pre>
<div class="block">Keeps a reference of the <a href="../../../parser/AbsExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><code>parsed object</code></a> object, which should only be
done when this object is instantiated during the conversion of a parsed JPQL query into
<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObjects</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>expression</code> - The <a href="../../../parser/AbsExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><code>parsed object</code></a> representing a <code><b>ABS</b></code>
expression</dd>
</dl>
</li>
</ul>
<a id="setStateObject(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setStateObject</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setStateObject&#8203;(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>&nbsp;stateObject)</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 represent the new encapsulated expression.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="AbstractSingleEncapsulatedExpressionStateObject.html#setStateObject(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">setStateObject</a></code>&nbsp;in class&nbsp;<code><a href="AbstractSingleEncapsulatedExpressionStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractSingleEncapsulatedExpressionStateObject</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stateObject</code> - The new encapsulated <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a></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>Field&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>