| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.2) on Wed Apr 22 10:19:16 CDT 2020 --> |
| <title>JPQLQueryStateObject (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="JPQLQueryStateObject (EclipseLink 3.0.0, API Reference)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10}; |
| 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 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: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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"> </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> <a href="package-summary.html">org.eclipse.persistence.jpa.jpql.tools.model.query</a></div> |
| <h2 title="Class JPQLQueryStateObject" class="title">Class JPQLQueryStateObject</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="AbstractStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.persistence.jpa.jpql.tools.model.query.JPQLQueryStateObject</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">JPQLQueryStateObject</span> |
| extends <a href="AbstractStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractStateObject</a></pre> |
| <div class="block">This is the root of the <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> hierarchy that represents a JPQL query. The only |
| child of this state object is one of the three possible query statements.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Version:</span></dt> |
| <dd>2.4</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="DeleteStatementStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>DeleteStatementStateObject</code></a>, |
| <a href="SelectStatementStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>SelectStatementStateObject</code></a>, |
| <a href="UpdateStatementStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>UpdateStatementStateObject</code></a>, |
| <a href="../../../parser/JPQLExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><code>JPQLExpression</code></a></dd> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Pascal Filion</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.4</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#QUERY_STATEMENT_PROPERTY">QUERY_STATEMENT_PROPERTY</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Notifies the query statement has changed.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryBuilder,org.eclipse.persistence.jpa.jpql.tools.spi.IManagedTypeProvider)">JPQLQueryStateObject</a></span>​(<a href="../IJPQLQueryBuilder.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model">IJPQLQueryBuilder</a> queryBuilder, |
| <a href="../../spi/IManagedTypeProvider.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi">IManagedTypeProvider</a> provider)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new <code>JPQLQueryStateObject</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>​(<a href="StateObjectVisitor.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObjectVisitor</a> visitor)</code></th> |
| <td class="colLast"> |
| <div class="block">Visits this <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> by the given <a href="StateObjectVisitor.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>visitor</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addChildren(java.util.List)">addChildren</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>> children)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds the children of this <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> to the given list.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="DeleteStatementStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">DeleteStatementStateObject</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addDeleteStatement()">addDeleteStatement</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Changes the query statement to be a <code><b>DELETE</b></code> statement.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="SelectStatementStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">SelectStatementStateObject</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addDistinctSelectStatement()">addDistinctSelectStatement</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Changes the query statement to be a <code><b>SELECT</b></code> statement.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="SelectStatementStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">SelectStatementStateObject</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addSelectStatement()">addSelectStatement</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Changes the query statement to be a <code><b>SELECT</b></code> statement.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="SelectStatementStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">SelectStatementStateObject</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addSelectStatement(java.lang.String)">addSelectStatement</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" class="externalLink">String</a> jpqlFragment)</code></th> |
| <td class="colLast"> |
| <div class="block">Changes the query statement to be a <code><b>SELECT</b></code> statement.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="UpdateStatementStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">UpdateStatementStateObject</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addUpdateStatement()">addUpdateStatement</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Changes the query statement to be a <code><b>UPDATE</b></code> statement.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="UpdateStatementStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">UpdateStatementStateObject</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addUpdateStatement(java.lang.String)">addUpdateStatement</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" class="externalLink">String</a> jpqlFragment)</code></th> |
| <td class="colLast"> |
| <div class="block">Changes the query statement to be a <code><b>UPDATE</b></code> statement.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>protected <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkParent(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">checkParent</a></span>​(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a> parent)</code></th> |
| <td class="colLast"> |
| <div class="block">Checks whether the given parent is <code>null</code> or not.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="DeclarationStateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">DeclarationStateObject</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDeclaration()">getDeclaration</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the declaration clause which defines the domain of the query by declaring |
| identification variables.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../parser/JPQLExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser">JPQLExpression</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="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../parser/JPQLGrammar.html" title="interface in org.eclipse.persistence.jpa.jpql.parser">JPQLGrammar</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGrammar()">getGrammar</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the grammar that defines how to parse a JPQL query.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../spi/IManagedTypeProvider.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi">IManagedTypeProvider</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getManagedTypeProvider()">getManagedTypeProvider</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the provider of managed types.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParent()">getParent</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the parent of this <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../IJPQLQueryBuilder.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model">IJPQLQueryBuilder</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQueryBuilder()">getQueryBuilder</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the <a href="../IJPQLQueryBuilder.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model"><code>IJPQLQueryBuilder</code></a> that is responsible to create various part of the <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> hierarchy.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQueryStatement()">getQueryStatement</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the only child of this state object, which represents one of the three query statement.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="JPQLQueryStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">JPQLQueryStateObject</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRoot()">getRoot</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the root of the <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> hierarchy.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasQueryStatement()">hasQueryStatement</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Determines whether a query statement has been defined.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#initialize(org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryBuilder,org.eclipse.persistence.jpa.jpql.tools.spi.IManagedTypeProvider)">initialize</a></span>​(<a href="../IJPQLQueryBuilder.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model">IJPQLQueryBuilder</a> queryBuilder, |
| <a href="../../spi/IManagedTypeProvider.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi">IManagedTypeProvider</a> provider)</code></th> |
| <td class="colLast"> |
| <div class="block">Initializes this <code>JPQLQueryStateObject</code>.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isEquivalent(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">isEquivalent</a></span>​(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a> stateObject)</code></th> |
| <td class="colLast"> |
| <div class="block">Determines whether the given <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> is equivalent to this one, i.e.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parse(java.lang.CharSequence,java.lang.String)">parse</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang" class="externalLink">CharSequence</a> jpqlFragment, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> queryBNFId)</code></th> |
| <td class="colLast"> |
| <div class="block">Parses the given JPQL fragment as this state object's query statement.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setExpression(org.eclipse.persistence.jpa.jpql.parser.JPQLExpression)">setExpression</a></span>​(<a href="../../../parser/JPQLExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser">JPQLExpression</a> expression)</code></th> |
| <td class="colLast"> |
| <div class="block">Keeps a reference of the <a href="../../../parser/JPQLExpression.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="i22" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setQueryStatement(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">setQueryStatement</a></span>​(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a> queryStatement)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the only child of this state object, which represents one of the three query statement.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toTextInternal(java.lang.Appendable)">toTextInternal</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Appendable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Appendable</a> writer)</code></th> |
| <td class="colLast"> |
| <div class="block">Prints out a string representation of this <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a>, which should not be used to |
| define a <code>true</code> string representation of a JPQL query but should be used for |
| debugging purposes.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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#children()">children</a>, <a href="AbstractStateObject.html#decorate(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">decorate</a>, <a href="AbstractStateObject.html#equals(java.lang.Object)">equals</a>, <a href="AbstractStateObject.html#findIdentificationVariable(java.lang.String)">findIdentificationVariable</a>, <a href="AbstractStateObject.html#firePropertyChanged(java.lang.String,java.lang.Object,java.lang.Object)">firePropertyChanged</a>, <a href="AbstractStateObject.html#getChangeSupport()">getChangeSupport</a>, <a href="AbstractStateObject.html#getDecorator()">getDecorator</a>, <a href="AbstractStateObject.html#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 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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="QUERY_STATEMENT_PROPERTY"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>QUERY_STATEMENT_PROPERTY</h4> |
| <pre>public static final <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> QUERY_STATEMENT_PROPERTY</pre> |
| <div class="block">Notifies the query statement has changed.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../../constant-values.html#org.eclipse.persistence.jpa.jpql.tools.model.query.JPQLQueryStateObject.QUERY_STATEMENT_PROPERTY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryBuilder,org.eclipse.persistence.jpa.jpql.tools.spi.IManagedTypeProvider)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>JPQLQueryStateObject</h4> |
| <pre>public JPQLQueryStateObject​(<a href="../IJPQLQueryBuilder.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model">IJPQLQueryBuilder</a> queryBuilder, |
| <a href="../../spi/IManagedTypeProvider.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi">IManagedTypeProvider</a> provider)</pre> |
| <div class="block">Creates a new <code>JPQLQueryStateObject</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>queryBuilder</code> - The builder that can create any <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> for any given JPQL |
| fragment when using a parse method</dd> |
| <dd><code>provider</code> - The external form of a provider that gives access to the JPA metadata</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> - If one of the given arguments is <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 void accept​(<a href="StateObjectVisitor.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObjectVisitor</a> 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="addChildren(java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addChildren</h4> |
| <pre class="methodSignature">protected void addChildren​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>> children)</pre> |
| <div class="block">Adds the children of this <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> to the given list.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="AbstractStateObject.html#addChildren(java.util.List)">addChildren</a></code> in class <code><a href="AbstractStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractStateObject</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>children</code> - The list used to store the children</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addDeleteStatement()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addDeleteStatement</h4> |
| <pre class="methodSignature">public <a href="DeleteStatementStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">DeleteStatementStateObject</a> addDeleteStatement()</pre> |
| <div class="block">Changes the query statement to be a <code><b>DELETE</b></code> statement.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The new root object of the <code><b>DELETE</b></code> statement</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addDistinctSelectStatement()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addDistinctSelectStatement</h4> |
| <pre class="methodSignature">public <a href="SelectStatementStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">SelectStatementStateObject</a> addDistinctSelectStatement()</pre> |
| <div class="block">Changes the query statement to be a <code><b>SELECT</b></code> statement. The <code><b>SELECT</b></code> |
| clause will have the <code><b>DISTINCT</b></code> identifier set.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The new root object of the <code><b>SELECT</b></code> statement</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addSelectStatement()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addSelectStatement</h4> |
| <pre class="methodSignature">public <a href="SelectStatementStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">SelectStatementStateObject</a> addSelectStatement()</pre> |
| <div class="block">Changes the query statement to be a <code><b>SELECT</b></code> statement.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The new root object of the <code><b>SELECT</b></code> statement</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addSelectStatement(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addSelectStatement</h4> |
| <pre class="methodSignature">public <a href="SelectStatementStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">SelectStatementStateObject</a> addSelectStatement​(<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> jpqlFragment)</pre> |
| <div class="block">Changes the query statement to be a <code><b>SELECT</b></code> statement.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>jpqlFragment</code> - The portion of the query representing the select items, excluding the |
| <code><b>SELECT</b></code> identifier</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The new root object of the <code><b>SELECT</b></code> statement</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addUpdateStatement()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addUpdateStatement</h4> |
| <pre class="methodSignature">public <a href="UpdateStatementStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">UpdateStatementStateObject</a> addUpdateStatement()</pre> |
| <div class="block">Changes the query statement to be a <code><b>UPDATE</b></code> statement.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The new root object of the <code><b>UPDTE</b></code> statement</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addUpdateStatement(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addUpdateStatement</h4> |
| <pre class="methodSignature">public <a href="UpdateStatementStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">UpdateStatementStateObject</a> addUpdateStatement​(<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> jpqlFragment)</pre> |
| <div class="block">Changes the query statement to be a <code><b>UPDATE</b></code> statement.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>jpqlFragment</code> - The portion of the query representing the select items, excluding the |
| <code><b>UPDATE</b></code> identifier</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The new root object of the <code><b>UPDATE</b></code> statement</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="checkParent(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkParent</h4> |
| <pre class="methodSignature">protected <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a> checkParent​(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a> parent)</pre> |
| <div class="block">Checks whether the given parent is <code>null</code> or not. If it's <code>null</code> then |
| throw a <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"><code>NullPointerException</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="AbstractStateObject.html#checkParent(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">checkParent</a></code> in class <code><a href="AbstractStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractStateObject</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parent</code> - The parent of this state object</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The given object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDeclaration()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaration</h4> |
| <pre class="methodSignature">public <a href="DeclarationStateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">DeclarationStateObject</a> getDeclaration()</pre> |
| <div class="block">Returns the declaration clause which defines the domain of the query by declaring |
| identification variables.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="StateObject.html#getDeclaration()">getDeclaration</a></code> in interface <code><a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="AbstractStateObject.html#getDeclaration()">getDeclaration</a></code> in class <code><a href="AbstractStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractStateObject</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The declaration clause of which this <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> is a child; i.e. either the |
| top-level declaration if this is part of the top query or the sub-level declaration if this is |
| part of a subquery</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getExpression()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExpression</h4> |
| <pre class="methodSignature">public <a href="../../../parser/JPQLExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser">JPQLExpression</a> 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> in interface <code><a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="AbstractStateObject.html#getExpression()">getExpression</a></code> in class <code><a href="AbstractStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractStateObject</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The 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="getGrammar()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGrammar</h4> |
| <pre class="methodSignature">public <a href="../../../parser/JPQLGrammar.html" title="interface in org.eclipse.persistence.jpa.jpql.parser">JPQLGrammar</a> getGrammar()</pre> |
| <div class="block">Returns the grammar that defines how to parse a JPQL query.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="StateObject.html#getGrammar()">getGrammar</a></code> in interface <code><a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="AbstractStateObject.html#getGrammar()">getGrammar</a></code> in class <code><a href="AbstractStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractStateObject</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The grammar that was used to parse the JPQL query</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getManagedTypeProvider()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getManagedTypeProvider</h4> |
| <pre class="methodSignature">public <a href="../../spi/IManagedTypeProvider.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi">IManagedTypeProvider</a> getManagedTypeProvider()</pre> |
| <div class="block">Returns the provider of managed types.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="StateObject.html#getManagedTypeProvider()">getManagedTypeProvider</a></code> in interface <code><a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="AbstractStateObject.html#getManagedTypeProvider()">getManagedTypeProvider</a></code> in class <code><a href="AbstractStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractStateObject</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The provider that gives access to the managed types</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getParent()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParent</h4> |
| <pre class="methodSignature">public <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a> getParent()</pre> |
| <div class="block">Returns the parent of this <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="StateObject.html#getParent()">getParent</a></code> in interface <code><a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="AbstractStateObject.html#getParent()">getParent</a></code> in class <code><a href="AbstractStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractStateObject</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Returns the parent of this <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a>, which is <code>null</code> only when |
| this is the root of the hierarchy</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getQueryBuilder()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueryBuilder</h4> |
| <pre class="methodSignature">public <a href="../IJPQLQueryBuilder.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model">IJPQLQueryBuilder</a> getQueryBuilder()</pre> |
| <div class="block">Returns the <a href="../IJPQLQueryBuilder.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model"><code>IJPQLQueryBuilder</code></a> that is responsible to create various part of the <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> hierarchy.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="StateObject.html#getQueryBuilder()">getQueryBuilder</a></code> in interface <code><a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="AbstractStateObject.html#getQueryBuilder()">getQueryBuilder</a></code> in class <code><a href="AbstractStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractStateObject</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The builder that created this <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> from a JPQL query or that gives |
| access to various sub-builders</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getQueryStatement()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueryStatement</h4> |
| <pre class="methodSignature">public <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a> getQueryStatement()</pre> |
| <div class="block">Returns the only child of this state object, which represents one of the three query statement.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The state object representing the query statement, which was created based on the |
| query type</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRoot()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRoot</h4> |
| <pre class="methodSignature">public <a href="JPQLQueryStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">JPQLQueryStateObject</a> getRoot()</pre> |
| <div class="block">Returns the root of the <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> hierarchy.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="StateObject.html#getRoot()">getRoot</a></code> in interface <code><a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="AbstractStateObject.html#getRoot()">getRoot</a></code> in class <code><a href="AbstractStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractStateObject</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The root of the state model representing the JPQL query</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hasQueryStatement()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasQueryStatement</h4> |
| <pre class="methodSignature">public boolean hasQueryStatement()</pre> |
| <div class="block">Determines whether a query statement has been defined.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if there is a query statement defined; <code>false</code> otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="initialize(org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryBuilder,org.eclipse.persistence.jpa.jpql.tools.spi.IManagedTypeProvider)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initialize</h4> |
| <pre class="methodSignature">protected void initialize​(<a href="../IJPQLQueryBuilder.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model">IJPQLQueryBuilder</a> queryBuilder, |
| <a href="../../spi/IManagedTypeProvider.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi">IManagedTypeProvider</a> provider)</pre> |
| <div class="block">Initializes this <code>JPQLQueryStateObject</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>queryBuilder</code> - The builder that can create any <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> for any given JPQL fragment</dd> |
| <dd><code>provider</code> - The external form that gives access to the JPA metadata</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> - If one of the given arguments is <code>null</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isEquivalent(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEquivalent</h4> |
| <pre class="methodSignature">public boolean isEquivalent​(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a> stateObject)</pre> |
| <div class="block">Determines whether the given <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> is equivalent to this one, i.e. the |
| information of both <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> is the same.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="StateObject.html#isEquivalent(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">isEquivalent</a></code> in interface <code><a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="AbstractStateObject.html#isEquivalent(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">isEquivalent</a></code> in class <code><a href="AbstractStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractStateObject</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>stateObject</code> - The <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> to compare its content to this one</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if both object are equivalent; <code>false</code> otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="parse(java.lang.CharSequence,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parse</h4> |
| <pre class="methodSignature">public void parse​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang" class="externalLink">CharSequence</a> jpqlFragment, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> queryBNFId)</pre> |
| <div class="block">Parses the given JPQL fragment as this state object's query statement.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>jpqlFragment</code> - The portion of the query to parse</dd> |
| <dd><code>queryBNFId</code> - The unique identifier of the BNF that determines how to parse the fragment</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setExpression(org.eclipse.persistence.jpa.jpql.parser.JPQLExpression)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExpression</h4> |
| <pre class="methodSignature">public void setExpression​(<a href="../../../parser/JPQLExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser">JPQLExpression</a> expression)</pre> |
| <div class="block">Keeps a reference of the <a href="../../../parser/JPQLExpression.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/JPQLExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><code>parsed object</code></a> representing the JPQL query</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setQueryStatement(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setQueryStatement</h4> |
| <pre class="methodSignature">public void setQueryStatement​(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a> queryStatement)</pre> |
| <div class="block">Sets the only child of this state object, which represents one of the three query statement.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>queryStatement</code> - The state object representing the query statement, which was created |
| based on the query type</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toTextInternal(java.lang.Appendable)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toTextInternal</h4> |
| <pre class="methodSignature">protected void toTextInternal​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Appendable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Appendable</a> writer) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre> |
| <div class="block">Prints out a string representation of this <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a>, which should not be used to |
| define a <code>true</code> string representation of a JPQL query but should be used for |
| debugging purposes.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="AbstractStateObject.html#toTextInternal(java.lang.Appendable)">toTextInternal</a></code> in class <code><a href="AbstractStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractStateObject</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>writer</code> - The writer used to print out the string representation</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - This should never happens, it is only required because <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Appendable.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Appendable</code></a> |
| is used instead of any concrete class</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage">EclipseLink 3.0.0, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../../../allclasses.html">All 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: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 2017–2020 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |