blob: e2136a896a5cc6d2c6e97305b217c046a2739345 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_252) on Fri Jul 16 09:38:46 UTC 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>RangeVariableDeclaration (EclipseLink 3.0.2, API Reference)</title>
<meta name="date" content="2021-07-16">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="RangeVariableDeclaration (EclipseLink 3.0.2, API Reference)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10};
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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage">EclipseLink 3.0.2, API Reference</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/RangeDeclarationFactory.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/RangeVariableDeclarationBNF.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/persistence/jpa/jpql/parser/RangeVariableDeclaration.html" target="_top">Frames</a></li>
<li><a href="RangeVariableDeclaration.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.eclipse.persistence.jpa.jpql.parser.AbstractExpression">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 name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.eclipse.persistence.jpa.jpql.parser</div>
<h2 title="Class RangeVariableDeclaration" class="title">Class RangeVariableDeclaration</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">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser">org.eclipse.persistence.jpa.jpql.parser.AbstractExpression</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.persistence.jpa.jpql.parser.RangeVariableDeclaration</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser">Expression</a></dd>
</dl>
<hr>
<br>
<pre>public final class <span class="typeNameLabel">RangeVariableDeclaration</span>
extends <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser">AbstractExpression</a></pre>
<div class="block">Range variable declarations allow the developer to designate a "root" for objects which may not
be reachable by navigation. In order to select values by comparing more than one instance of an
entity abstract schema type, more than one identification variable ranging over the abstract
schema type is needed in the <b>FROM</b> clause.
<p>
JPA:
<div><b>BNF:</b> <code>range_variable_declaration ::= abstract_schema_name [AS] identification_variable</code></div>
<p>
EclipseLink 2.4:
<div><b>BNF:</b> <code>range_variable_declaration ::= { root_object } [AS] identification_variable</code></div>
<div><b>BNF:</b> <code>root_object ::= abstract_schema_name | (subquery)</code></div></div>
<dl>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>2.5</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Pascal Filion</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.3</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.eclipse.persistence.jpa.jpql.parser.AbstractExpression">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.persistence.jpa.jpql.parser.<a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser">AbstractExpression</a></h3>
<code><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#COMMA">COMMA</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#DOT">DOT</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#DOUBLE_QUOTE">DOUBLE_QUOTE</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#LEFT_CURLY_BRACKET">LEFT_CURLY_BRACKET</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#LEFT_PARENTHESIS">LEFT_PARENTHESIS</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#NOT_DEFINED">NOT_DEFINED</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#RIGHT_CURLY_BRACKET">RIGHT_CURLY_BRACKET</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#RIGHT_PARENTHESIS">RIGHT_PARENTHESIS</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#SINGLE_QUOTE">SINGLE_QUOTE</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#SPACE">SPACE</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#UNDERSCORE">UNDERSCORE</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.eclipse.persistence.jpa.jpql.parser.Expression">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.eclipse.persistence.jpa.jpql.parser.<a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser">Expression</a></h3>
<code><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#ABS">ABS</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#ALL">ALL</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#AND">AND</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#ANY">ANY</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#AS">AS</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#AS_OF">AS_OF</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#ASC">ASC</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#AVG">AVG</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#BETWEEN">BETWEEN</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#BIT_LENGTH">BIT_LENGTH</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#BOTH">BOTH</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#CASE">CASE</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#CAST">CAST</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#CHAR_LENGTH">CHAR_LENGTH</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#CHARACTER_LENGTH">CHARACTER_LENGTH</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#CLASS">CLASS</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#COALESCE">COALESCE</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#COLUMN">COLUMN</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#CONCAT">CONCAT</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#CONNECT_BY">CONNECT_BY</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#COUNT">COUNT</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#CURRENT_DATE">CURRENT_DATE</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#CURRENT_TIME">CURRENT_TIME</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#CURRENT_TIMESTAMP">CURRENT_TIMESTAMP</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#DELETE">DELETE</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#DELETE_FROM">DELETE_FROM</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#DESC">DESC</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#DIFFERENT">DIFFERENT</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#DISTINCT">DISTINCT</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#DIVISION">DIVISION</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#ELSE">ELSE</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#EMPTY">EMPTY</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#END">END</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#ENTRY">ENTRY</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#EQUAL">EQUAL</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#ESCAPE">ESCAPE</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#EXCEPT">EXCEPT</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#EXISTS">EXISTS</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#EXTRACT">EXTRACT</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#FALSE">FALSE</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#FETCH">FETCH</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#FIRST">FIRST</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#FROM">FROM</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#FUNC">FUNC</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#FUNCTION">FUNCTION</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#GREATER_THAN">GREATER_THAN</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#GREATER_THAN_OR_EQUAL">GREATER_THAN_OR_EQUAL</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#GROUP_BY">GROUP_BY</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#HAVING">HAVING</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#IN">IN</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#INDEX">INDEX</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#INNER">INNER</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#INNER_JOIN">INNER_JOIN</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#INNER_JOIN_FETCH">INNER_JOIN_FETCH</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#INTERSECT">INTERSECT</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#IS">IS</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#IS_EMPTY">IS_EMPTY</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#IS_NOT_EMPTY">IS_NOT_EMPTY</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#IS_NOT_NULL">IS_NOT_NULL</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#IS_NULL">IS_NULL</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#JOIN">JOIN</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#JOIN_FETCH">JOIN_FETCH</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#KEY">KEY</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#LAST">LAST</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#LEADING">LEADING</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#LEFT">LEFT</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#LEFT_JOIN">LEFT_JOIN</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#LEFT_JOIN_FETCH">LEFT_JOIN_FETCH</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#LEFT_OUTER_JOIN">LEFT_OUTER_JOIN</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#LEFT_OUTER_JOIN_FETCH">LEFT_OUTER_JOIN_FETCH</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#LENGTH">LENGTH</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#LIKE">LIKE</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#LOCATE">LOCATE</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#LOWER">LOWER</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#LOWER_THAN">LOWER_THAN</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#LOWER_THAN_OR_EQUAL">LOWER_THAN_OR_EQUAL</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#MAX">MAX</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#MEMBER">MEMBER</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#MEMBER_OF">MEMBER_OF</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#MIN">MIN</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#MINUS">MINUS</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#MOD">MOD</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#MULTIPLICATION">MULTIPLICATION</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#NAMED_PARAMETER">NAMED_PARAMETER</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#NEW">NEW</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#NOT">NOT</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#NOT_BETWEEN">NOT_BETWEEN</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#NOT_EQUAL">NOT_EQUAL</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#NOT_EXISTS">NOT_EXISTS</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#NOT_IN">NOT_IN</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#NOT_LIKE">NOT_LIKE</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#NOT_MEMBER">NOT_MEMBER</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#NOT_MEMBER_OF">NOT_MEMBER_OF</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#NULL">NULL</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#NULLIF">NULLIF</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#NULLS">NULLS</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#NULLS_FIRST">NULLS_FIRST</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#NULLS_LAST">NULLS_LAST</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#OBJECT">OBJECT</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#OF">OF</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#ON">ON</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#OPERATOR">OPERATOR</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#OR">OR</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#ORDER_BY">ORDER_BY</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#ORDER_SIBLINGS_BY">ORDER_SIBLINGS_BY</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#OUTER">OUTER</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#PLUS">PLUS</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#POSITION">POSITION</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#POSITIONAL_PARAMETER">POSITIONAL_PARAMETER</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#QUOTE">QUOTE</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#REGEXP">REGEXP</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#SCN">SCN</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#SELECT">SELECT</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#SET">SET</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#SIZE">SIZE</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#SOME">SOME</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#SQL">SQL</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#SQRT">SQRT</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#START_WITH">START_WITH</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#SUBSTRING">SUBSTRING</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#SUM">SUM</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#TABLE">TABLE</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#THEN">THEN</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#TIMESTAMP">TIMESTAMP</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#TRAILING">TRAILING</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#TREAT">TREAT</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#TRIM">TRIM</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#TRUE">TRUE</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#TYPE">TYPE</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#UNION">UNION</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#UNKNOWN">UNKNOWN</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#UPDATE">UPDATE</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#UPPER">UPPER</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#VALUE">VALUE</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#WHEN">WHEN</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#WHERE">WHERE</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/RangeVariableDeclaration.html#RangeVariableDeclaration-org.eclipse.persistence.jpa.jpql.parser.AbstractExpression-">RangeVariableDeclaration</a></span>(<a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser">AbstractExpression</a>&nbsp;parent)</code>
<div class="block">Creates a new <code>RangeVariableDeclaration</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/RangeVariableDeclaration.html#RangeVariableDeclaration-java.lang.String-java.lang.String-">RangeVariableDeclaration</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;entityName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;variableName)</code>
<div class="block">Creates a new <code>RangeVariableDeclaration</code>, which is used as a virtual declaration.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/RangeVariableDeclaration.html#accept-org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor-">accept</a></span>(<a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/ExpressionVisitor.html" title="interface in org.eclipse.persistence.jpa.jpql.parser">ExpressionVisitor</a>&nbsp;visitor)</code>
<div class="block">Visits this <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser"><code>Expression</code></a> by the given <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/ExpressionVisitor.html" title="interface in org.eclipse.persistence.jpa.jpql.parser"><code>visitor</code></a>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/RangeVariableDeclaration.html#acceptChildren-org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor-">acceptChildren</a></span>(<a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/ExpressionVisitor.html" title="interface in org.eclipse.persistence.jpa.jpql.parser">ExpressionVisitor</a>&nbsp;visitor)</code>
<div class="block">Visits the children of this <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser"><code>Expression</code></a>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/RangeVariableDeclaration.html#addChildrenTo-java.util.Collection-">addChildrenTo</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser">Expression</a>&gt;&nbsp;children)</code>
<div class="block">Adds the children of this <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><code>AbstractExpression</code></a> to the given collection.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/RangeVariableDeclaration.html#addOrderedChildrenTo-java.util.List-">addOrderedChildrenTo</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser">Expression</a>&gt;&nbsp;children)</code>
<div class="block">Adds the children of this <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><code>AbstractExpression</code></a> to the given list.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/JPQLQueryBNF.html" title="class in org.eclipse.persistence.jpa.jpql.parser">JPQLQueryBNF</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/RangeVariableDeclaration.html#findQueryBNF-org.eclipse.persistence.jpa.jpql.parser.Expression-">findQueryBNF</a></span>(<a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser">Expression</a>&nbsp;expression)</code>
<div class="block">Retrieves the <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/JPQLQueryBNF.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><code>JPQLQueryBNF</code></a> that represents the fragment of this <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser"><code>Expression</code></a>
that was used when parsing the given <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser"><code>Expression</code></a>.</div>
</td>
</tr>
<tr id="i5" 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">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/RangeVariableDeclaration.html#getActualAsIdentifier--">getActualAsIdentifier</a></span>()</code>
<div class="block">Returns the actual <b>AS</b> found in the string representation of the JPQL query, which has
the actual case that was used.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser">Expression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/RangeVariableDeclaration.html#getIdentificationVariable--">getIdentificationVariable</a></span>()</code>
<div class="block">Returns the <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser"><code>Expression</code></a> that represents the identification variable.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/JPQLQueryBNF.html" title="class in org.eclipse.persistence.jpa.jpql.parser">JPQLQueryBNF</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/RangeVariableDeclaration.html#getQueryBNF--">getQueryBNF</a></span>()</code>
<div class="block">Returns the BNF of this <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser"><code>Expression</code></a>.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser">Expression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/RangeVariableDeclaration.html#getRootObject--">getRootObject</a></span>()</code>
<div class="block">Returns the <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser"><code>Expression</code></a> that represents the "root" object.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/RangeVariableDeclaration.html#hasAs--">hasAs</a></span>()</code>
<div class="block">Determines whether the identifier <b>AS</b> was parsed.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/RangeVariableDeclaration.html#hasIdentificationVariable--">hasIdentificationVariable</a></span>()</code>
<div class="block">Determines whether the identification variable was parsed.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/RangeVariableDeclaration.html#hasRootObject--">hasRootObject</a></span>()</code>
<div class="block">Determines whether the "root" object was parsed.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/RangeVariableDeclaration.html#hasSpaceAfterAs--">hasSpaceAfterAs</a></span>()</code>
<div class="block">Determines whether a whitespace was parsed after <b>AS</b>.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/RangeVariableDeclaration.html#hasSpaceAfterRootObject--">hasSpaceAfterRootObject</a></span>()</code>
<div class="block">Determines whether a whitespace was parsed after the "root" object.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/RangeVariableDeclaration.html#hasVirtualIdentificationVariable--">hasVirtualIdentificationVariable</a></span>()</code>
<div class="block">Determines whether this identification variable is virtual, meaning it's not part of the
query but is required for proper navigability.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/RangeVariableDeclaration.html#isParsingComplete-org.eclipse.persistence.jpa.jpql.WordParser-java.lang.String-org.eclipse.persistence.jpa.jpql.parser.Expression-">isParsingComplete</a></span>(<a href="../../../../../../org/eclipse/persistence/jpa/jpql/WordParser.html" title="class in org.eclipse.persistence.jpa.jpql">WordParser</a>&nbsp;wordParser,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;word,
<a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser">Expression</a>&nbsp;expression)</code>
<div class="block">Determines whether the parsing is complete based on what is left in the given text.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/RangeVariableDeclaration.html#parse-org.eclipse.persistence.jpa.jpql.WordParser-boolean-">parse</a></span>(<a href="../../../../../../org/eclipse/persistence/jpa/jpql/WordParser.html" title="class in org.eclipse.persistence.jpa.jpql">WordParser</a>&nbsp;wordParser,
boolean&nbsp;tolerant)</code>
<div class="block">Parses the query by starting at the current position, which is part of the given <a href="../../../../../../org/eclipse/persistence/jpa/jpql/WordParser.html" title="class in org.eclipse.persistence.jpa.jpql"><code>WordParser</code></a>.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/RangeVariableDeclaration.html#setVirtualIdentificationVariable-java.lang.String-">setVirtualIdentificationVariable</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;variableName)</code>
<div class="block">Sets a virtual identification variable because the "root" object was parsed without one.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/RangeVariableDeclaration.html#setVirtualIdentificationVariable-java.lang.String-java.lang.String-">setVirtualIdentificationVariable</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;variableName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;path)</code>
<div class="block">Sets a virtual identification variable to qualify the "root" object.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/RangeVariableDeclaration.html#shouldParseWithFactoryFirst--">shouldParseWithFactoryFirst</a></span>()</code>
<div class="block">Determines whether the parsing of the query should be performed using the <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/ExpressionFactory.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><code>factories</code></a> first or it should automatically fallback to the fallback factory.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/RangeVariableDeclaration.html#toParsedText-java.lang.StringBuilder-boolean-">toParsedText</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;writer,
boolean&nbsp;actual)</code>
<div class="block">Generates a string representation of this <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser"><code>Expression</code></a>, including its children,
if it has any.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.persistence.jpa.jpql.parser.AbstractExpression">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.persistence.jpa.jpql.parser.<a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser">AbstractExpression</a></h3>
<code><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#acceptUnknownVisitor-org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor-">acceptUnknownVisitor</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#acceptUnknownVisitor-org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor-java.lang.Class-java.lang.Class-">acceptUnknownVisitor</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#buildExpressionFromFallingBack-org.eclipse.persistence.jpa.jpql.WordParser-java.lang.String-org.eclipse.persistence.jpa.jpql.parser.JPQLQueryBNF-org.eclipse.persistence.jpa.jpql.parser.AbstractExpression-boolean-">buildExpressionFromFallingBack</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#buildNullExpression--">buildNullExpression</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#buildStringExpression-char-">buildStringExpression</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#buildStringExpression-java.lang.String-">buildStringExpression</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#buildUnknownExpression-java.lang.String-">buildUnknownExpression</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#calculatePosition-org.eclipse.persistence.jpa.jpql.parser.Expression-int-">calculatePosition</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#children--">children</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#findFallBackExpressionFactory-org.eclipse.persistence.jpa.jpql.parser.JPQLQueryBNF-">findFallBackExpressionFactory</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#getExpressionFactory-java.lang.String-">getExpressionFactory</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#getExpressionRegistry--">getExpressionRegistry</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#getGrammar--">getGrammar</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#getIdentifierVersion-java.lang.String-">getIdentifierVersion</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#getJPAVersion--">getJPAVersion</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#getLength--">getLength</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#getOffset--">getOffset</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#getParent--">getParent</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#getQueryBNF-java.lang.String-">getQueryBNF</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#getRoot--">getRoot</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#getText--">getText</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#handleAggregate-org.eclipse.persistence.jpa.jpql.parser.JPQLQueryBNF-">handleAggregate</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#handleCollection-org.eclipse.persistence.jpa.jpql.parser.JPQLQueryBNF-">handleCollection</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#isAncestor-org.eclipse.persistence.jpa.jpql.parser.Expression-">isAncestor</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#isIdentifier-java.lang.String-">isIdentifier</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#isNull--">isNull</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#isTolerant--">isTolerant</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#isUnknown--">isUnknown</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#isVirtual--">isVirtual</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#orderedChildren--">orderedChildren</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#parse-org.eclipse.persistence.jpa.jpql.WordParser-java.lang.String-boolean-">parse</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#parseUsingExpressionFactory-org.eclipse.persistence.jpa.jpql.WordParser-java.lang.String-boolean-">parseUsingExpressionFactory</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#populatePosition-org.eclipse.persistence.jpa.jpql.parser.QueryPosition-int-">populatePosition</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#rebuildActualText--">rebuildActualText</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#rebuildParsedText--">rebuildParsedText</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#setParent-org.eclipse.persistence.jpa.jpql.parser.AbstractExpression-">setParent</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#setText-java.lang.String-">setText</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#shouldSkipLiteral-org.eclipse.persistence.jpa.jpql.parser.AbstractExpression-">shouldSkipLiteral</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#toActualText--">toActualText</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#toParsedText--">toParsedText</a>, <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#toString--">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="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">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">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</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">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">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</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">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">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">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">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">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="RangeVariableDeclaration-org.eclipse.persistence.jpa.jpql.parser.AbstractExpression-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RangeVariableDeclaration</h4>
<pre>public&nbsp;RangeVariableDeclaration(<a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser">AbstractExpression</a>&nbsp;parent)</pre>
<div class="block">Creates a new <code>RangeVariableDeclaration</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parent</code> - The parent of this expression</dd>
</dl>
</li>
</ul>
<a name="RangeVariableDeclaration-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RangeVariableDeclaration</h4>
<pre>public&nbsp;RangeVariableDeclaration(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;entityName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;variableName)</pre>
<div class="block">Creates a new <code>RangeVariableDeclaration</code>, which is used as a virtual declaration.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entityName</code> - The name of the entity to be accessible with the given variable name</dd>
<dd><code>variableName</code> - The identification variable used to navigate to the entity</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="accept-org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>accept</h4>
<pre>public&nbsp;void&nbsp;accept(<a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/ExpressionVisitor.html" title="interface in org.eclipse.persistence.jpa.jpql.parser">ExpressionVisitor</a>&nbsp;visitor)</pre>
<div class="block">Visits this <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser"><code>Expression</code></a> by the given <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/ExpressionVisitor.html" title="interface in org.eclipse.persistence.jpa.jpql.parser"><code>visitor</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>visitor</code> - The <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/ExpressionVisitor.html" title="interface in org.eclipse.persistence.jpa.jpql.parser"><code>ExpressionVisitor</code></a> to visit this object</dd>
</dl>
</li>
</ul>
<a name="acceptChildren-org.eclipse.persistence.jpa.jpql.parser.ExpressionVisitor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>acceptChildren</h4>
<pre>public&nbsp;void&nbsp;acceptChildren(<a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/ExpressionVisitor.html" title="interface in org.eclipse.persistence.jpa.jpql.parser">ExpressionVisitor</a>&nbsp;visitor)</pre>
<div class="block">Visits the children of this <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser"><code>Expression</code></a>. This method can be used to optimize traversing
the children since a new list is not created every time <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#children--"><code>Expression.children()</code></a> is called.
<p>
This does not traverse the <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser"><code>Expression</code></a> sub-hierarchy, use a subclass of
<a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractTraverseChildrenVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><code>AbstractTraverseChildrenVisitor</code></a> in order to traverse the entire sub-hierarchy.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>visitor</code> - The <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/ExpressionVisitor.html" title="interface in org.eclipse.persistence.jpa.jpql.parser"><code>visitor</code></a> to visit the children of this object.</dd>
</dl>
</li>
</ul>
<a name="addChildrenTo-java.util.Collection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addChildrenTo</h4>
<pre>protected&nbsp;void&nbsp;addChildrenTo(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser">Expression</a>&gt;&nbsp;children)</pre>
<div class="block">Adds the children of this <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><code>AbstractExpression</code></a> to the given collection.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#addChildrenTo-java.util.Collection-">addChildrenTo</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser">AbstractExpression</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>children</code> - The collection used to store the children</dd>
</dl>
</li>
</ul>
<a name="addOrderedChildrenTo-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addOrderedChildrenTo</h4>
<pre>protected&nbsp;void&nbsp;addOrderedChildrenTo(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser">Expression</a>&gt;&nbsp;children)</pre>
<div class="block">Adds the children of this <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><code>AbstractExpression</code></a> to the given list.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#addOrderedChildrenTo-java.util.List-">addOrderedChildrenTo</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser">AbstractExpression</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>children</code> - The list used to store the string representation of this <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><code>AbstractExpression</code></a></dd>
</dl>
</li>
</ul>
<a name="findQueryBNF-org.eclipse.persistence.jpa.jpql.parser.Expression-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findQueryBNF</h4>
<pre>public&nbsp;<a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/JPQLQueryBNF.html" title="class in org.eclipse.persistence.jpa.jpql.parser">JPQLQueryBNF</a>&nbsp;findQueryBNF(<a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser">Expression</a>&nbsp;expression)</pre>
<div class="block">Retrieves the <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/JPQLQueryBNF.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><code>JPQLQueryBNF</code></a> that represents the fragment of this <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser"><code>Expression</code></a>
that was used when parsing the given <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser"><code>Expression</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html#findQueryBNF-org.eclipse.persistence.jpa.jpql.parser.Expression-">findQueryBNF</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser">Expression</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#findQueryBNF-org.eclipse.persistence.jpa.jpql.parser.Expression-">findQueryBNF</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser">AbstractExpression</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>expression</code> - The <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser"><code>Expression</code></a> that is a descendant of this one</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/JPQLQueryBNF.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><code>JPQLQueryBNF</code></a> that was used to parse the given expression</dd>
</dl>
</li>
</ul>
<a name="getActualAsIdentifier--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getActualAsIdentifier</h4>
<pre>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">String</a>&nbsp;getActualAsIdentifier()</pre>
<div class="block">Returns the actual <b>AS</b> found in the string representation of the JPQL query, which has
the actual case that was used.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The <b>AS</b> identifier that was actually parsed, or an empty string if it was not
parsed</dd>
</dl>
</li>
</ul>
<a name="getIdentificationVariable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIdentificationVariable</h4>
<pre>public&nbsp;<a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser">Expression</a>&nbsp;getIdentificationVariable()</pre>
<div class="block">Returns the <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser"><code>Expression</code></a> that represents the identification variable.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The expression that was parsed representing the identification variable</dd>
</dl>
</li>
</ul>
<a name="getQueryBNF--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueryBNF</h4>
<pre>public&nbsp;<a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/JPQLQueryBNF.html" title="class in org.eclipse.persistence.jpa.jpql.parser">JPQLQueryBNF</a>&nbsp;getQueryBNF()</pre>
<div class="block">Returns the BNF of this <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser"><code>Expression</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/JPQLQueryBNF.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><code>JPQLQueryBNF</code></a>, which represents the grammar of this <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser"><code>Expression</code></a></dd>
</dl>
</li>
</ul>
<a name="getRootObject--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRootObject</h4>
<pre>public&nbsp;<a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser">Expression</a>&nbsp;getRootObject()</pre>
<div class="block">Returns the <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser"><code>Expression</code></a> that represents the "root" object.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The expression that was parsed representing the "root" object</dd>
</dl>
</li>
</ul>
<a name="hasAs--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasAs</h4>
<pre>public&nbsp;boolean&nbsp;hasAs()</pre>
<div class="block">Determines whether the identifier <b>AS</b> was parsed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the identifier <b>AS</b> was parsed; <code>false</code> otherwise</dd>
</dl>
</li>
</ul>
<a name="hasIdentificationVariable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasIdentificationVariable</h4>
<pre>public&nbsp;boolean&nbsp;hasIdentificationVariable()</pre>
<div class="block">Determines whether the identification variable was parsed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the identification variable was parsed; <code>false</code> otherwise</dd>
</dl>
</li>
</ul>
<a name="hasRootObject--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasRootObject</h4>
<pre>public&nbsp;boolean&nbsp;hasRootObject()</pre>
<div class="block">Determines whether the "root" object was parsed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the "root" object was parsed; <code>false</code> otherwise</dd>
</dl>
</li>
</ul>
<a name="hasSpaceAfterAs--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasSpaceAfterAs</h4>
<pre>public&nbsp;boolean&nbsp;hasSpaceAfterAs()</pre>
<div class="block">Determines whether a whitespace was parsed after <b>AS</b>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if there was a whitespace after <b>AS</b>; <code>false</code> otherwise</dd>
</dl>
</li>
</ul>
<a name="hasSpaceAfterRootObject--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasSpaceAfterRootObject</h4>
<pre>public&nbsp;boolean&nbsp;hasSpaceAfterRootObject()</pre>
<div class="block">Determines whether a whitespace was parsed after the "root" object.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if there was a whitespace after "root" object;
<code>false</code> otherwise</dd>
</dl>
</li>
</ul>
<a name="hasVirtualIdentificationVariable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasVirtualIdentificationVariable</h4>
<pre>public&nbsp;boolean&nbsp;hasVirtualIdentificationVariable()</pre>
<div class="block">Determines whether this identification variable is virtual, meaning it's not part of the
query but is required for proper navigability.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if this identification variable was virtually created to fully
qualify path expression; <code>false</code> if it was parsed</dd>
</dl>
</li>
</ul>
<a name="isParsingComplete-org.eclipse.persistence.jpa.jpql.WordParser-java.lang.String-org.eclipse.persistence.jpa.jpql.parser.Expression-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isParsingComplete</h4>
<pre>protected&nbsp;boolean&nbsp;isParsingComplete(<a href="../../../../../../org/eclipse/persistence/jpa/jpql/WordParser.html" title="class in org.eclipse.persistence.jpa.jpql">WordParser</a>&nbsp;wordParser,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;word,
<a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser">Expression</a>&nbsp;expression)</pre>
<div class="block">Determines whether the parsing is complete based on what is left in the given text. The text
is never empty.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#isParsingComplete-org.eclipse.persistence.jpa.jpql.WordParser-java.lang.String-org.eclipse.persistence.jpa.jpql.parser.Expression-">isParsingComplete</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser">AbstractExpression</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>wordParser</code> - The text to parse based on the current position of the cursor</dd>
<dd><code>word</code> - The word that was retrieved from the given text, which is the first word in the text</dd>
<dd><code>expression</code> - The <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser"><code>Expression</code></a> that has already been parsed</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the text no longer can't be parsed by the current expression;
<code>false</code> if more can be parsed</dd>
</dl>
</li>
</ul>
<a name="parse-org.eclipse.persistence.jpa.jpql.WordParser-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parse</h4>
<pre>protected&nbsp;void&nbsp;parse(<a href="../../../../../../org/eclipse/persistence/jpa/jpql/WordParser.html" title="class in org.eclipse.persistence.jpa.jpql">WordParser</a>&nbsp;wordParser,
boolean&nbsp;tolerant)</pre>
<div class="block">Parses the query by starting at the current position, which is part of the given <a href="../../../../../../org/eclipse/persistence/jpa/jpql/WordParser.html" title="class in org.eclipse.persistence.jpa.jpql"><code>WordParser</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#parse-org.eclipse.persistence.jpa.jpql.WordParser-boolean-">parse</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser">AbstractExpression</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>wordParser</code> - The text to parse based on the current position of the cursor</dd>
<dd><code>tolerant</code> - Determines whether the parsing system should be tolerant, meaning if it should
try to parse invalid or incomplete queries</dd>
</dl>
</li>
</ul>
<a name="setVirtualIdentificationVariable-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setVirtualIdentificationVariable</h4>
<pre>public&nbsp;void&nbsp;setVirtualIdentificationVariable(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;variableName)</pre>
<div class="block">Sets a virtual identification variable because the "root" object was parsed without one. This
is valid in an <b>UPDATE</b> and <b>DELETE</b> queries. Example:
<p>
<code>UPDATE DateTime SET date = CURRENT_DATE</code>
<p>
is equivalent to
<p>
<code>UPDATE DateTime d SET d.date = CURRENT_DATE</code></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>variableName</code> - A virtual identification variable that will identify the "root" object</dd>
</dl>
</li>
</ul>
<a name="setVirtualIdentificationVariable-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setVirtualIdentificationVariable</h4>
<pre>public&nbsp;void&nbsp;setVirtualIdentificationVariable(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;variableName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;path)</pre>
<div class="block">Sets a virtual identification variable to qualify the "root" object. The "root" object is a
derived path that does not start with an identification variable. Example:
<p>
<code>UPDATE Employee SET firstName = 'MODIFIED'
WHERE (SELECT COUNT(m) FROM managedEmployees m) &gt; 0</code>
<p>
<i>'managedEmployees'</i> is a derived path and will become qualified with the given virtual
identification variable.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>variableName</code> - The identification variable that was generated to qualify the "root" object</dd>
<dd><code>path</code> - The path that was parsed as a "root" object</dd>
</dl>
</li>
</ul>
<a name="shouldParseWithFactoryFirst--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldParseWithFactoryFirst</h4>
<pre>protected&nbsp;boolean&nbsp;shouldParseWithFactoryFirst()</pre>
<div class="block">Determines whether the parsing of the query should be performed using the <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/ExpressionFactory.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><code>factories</code></a> first or it should automatically fallback to the fallback factory.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#shouldParseWithFactoryFirst--">shouldParseWithFactoryFirst</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser">AbstractExpression</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> is returned by default so the factories are used before falling back</dd>
</dl>
</li>
</ul>
<a name="toParsedText-java.lang.StringBuilder-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toParsedText</h4>
<pre>protected&nbsp;void&nbsp;toParsedText(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;writer,
boolean&nbsp;actual)</pre>
<div class="block">Generates a string representation of this <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser"><code>Expression</code></a>, including its children,
if it has any.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html#toParsedText-java.lang.StringBuilder-boolean-">toParsedText</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/AbstractExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser">AbstractExpression</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>writer</code> - The buffer used to append this <a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser"><code>Expression</code></a>'s string representation</dd>
<dd><code>actual</code> - Determines whether the string representation should represent what was parsed,
i.e. include any "virtual" whitespace (such as ending whitespace) and the actual case of the
JPQL identifiers</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage">EclipseLink 3.0.2, API Reference</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/RangeDeclarationFactory.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/eclipse/persistence/jpa/jpql/parser/RangeVariableDeclarationBNF.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/persistence/jpa/jpql/parser/RangeVariableDeclaration.html" target="_top">Frames</a></li>
<li><a href="RangeVariableDeclaration.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.eclipse.persistence.jpa.jpql.parser.AbstractExpression">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 name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p>
</body>
</html>