| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.2) on Wed Apr 22 10:19:16 CDT 2020 --> |
| <title>DeclarationStateObject (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="DeclarationStateObject (EclipseLink 3.0.0, API Reference)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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="Interface DeclarationStateObject" class="title">Interface DeclarationStateObject</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="AbstractFromClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractFromClauseStateObject</a></code>, <code><a href="AbstractModifyClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">AbstractModifyClauseStateObject</a></code>, <code><a href="DeleteClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">DeleteClauseStateObject</a></code>, <code><a href="FromClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">FromClauseStateObject</a></code>, <code><a href="SimpleFromClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">SimpleFromClauseStateObject</a></code>, <code><a href="UpdateClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query">UpdateClauseStateObject</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">DeclarationStateObject</span> |
| extends <a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a></pre> |
| <div class="block">This defines the declaration portion of a query, which is the <code><b>FROM</b></code> clause |
| of a query.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Version:</span></dt> |
| <dd>2.5</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="FromClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>FromClauseStateObject</code></a>, |
| <a href="SimpleFromClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>SimpleFromClauseStateObject</code></a>, |
| <a href="DeleteClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>DeleteClauseStateObject</code></a>, |
| <a href="UpdateClauseStateObject.html" title="class in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>UpdateClauseStateObject</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"> |
| <!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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><a href="../../../utility/iterable/ListIterable.html" title="interface in org.eclipse.persistence.jpa.jpql.utility.iterable">ListIterable</a><? extends <a href="VariableDeclarationStateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">VariableDeclarationStateObject</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#declarations()">declarations</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the list of declarations declared in the declaration clause of the current query.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../spi/IManagedType.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi">IManagedType</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findManagedType(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">findManagedType</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">Returns the <a href="../../spi/IManagedType.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi"><code>IManagedType</code></a> for the given identification variable.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../spi/IManagedType.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi">IManagedType</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getManagedType(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">getManagedType</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">Returns the <a href="../../spi/IManagedType.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi"><code>IManagedType</code></a> for the given identification variable.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.persistence.jpa.jpql.tools.model.query.<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a></h3> |
| <code><a href="StateObject.html#accept(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObjectVisitor)">accept</a>, <a href="StateObject.html#addPropertyChangeListener(java.lang.String,org.eclipse.persistence.jpa.jpql.tools.model.IPropertyChangeListener)">addPropertyChangeListener</a>, <a href="StateObject.html#children()">children</a>, <a href="StateObject.html#decorate(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">decorate</a>, <a href="StateObject.html#findIdentificationVariable(java.lang.String)">findIdentificationVariable</a>, <a href="StateObject.html#getDeclaration()">getDeclaration</a>, <a href="StateObject.html#getDecorator()">getDecorator</a>, <a href="StateObject.html#getExpression()">getExpression</a>, <a href="StateObject.html#getGrammar()">getGrammar</a>, <a href="StateObject.html#getManagedTypeProvider()">getManagedTypeProvider</a>, <a href="StateObject.html#getParent()">getParent</a>, <a href="StateObject.html#getQueryBuilder()">getQueryBuilder</a>, <a href="StateObject.html#getRoot()">getRoot</a>, <a href="StateObject.html#isDecorated()">isDecorated</a>, <a href="StateObject.html#isEquivalent(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">isEquivalent</a>, <a href="StateObject.html#removePropertyChangeListener(java.lang.String,org.eclipse.persistence.jpa.jpql.tools.model.IPropertyChangeListener)">removePropertyChangeListener</a>, <a href="StateObject.html#setParent(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)">setParent</a>, <a href="StateObject.html#toString(java.lang.Appendable)">toString</a>, <a href="StateObject.html#toText(java.lang.Appendable)">toText</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="declarations()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>declarations</h4> |
| <pre class="methodSignature"><a href="../../../utility/iterable/ListIterable.html" title="interface in org.eclipse.persistence.jpa.jpql.utility.iterable">ListIterable</a><? extends <a href="VariableDeclarationStateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">VariableDeclarationStateObject</a>> declarations()</pre> |
| <div class="block">Returns the list of declarations declared in the declaration clause of the current query.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The list of <a href="VariableDeclarationStateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>VariableDeclarationStateObject</code></a> that define the domain of the query</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="findManagedType(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>findManagedType</h4> |
| <pre class="methodSignature"><a href="../../spi/IManagedType.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi">IManagedType</a> findManagedType​(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a> stateObject)</pre> |
| <div class="block">Returns the <a href="../../spi/IManagedType.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi"><code>IManagedType</code></a> for the given identification variable. If the declaration is |
| for a subquery and there is no managed type associated with the identification then the search |
| will traverse up the query hierarchy. |
| |
| <pre><code>SELECT e FROM Department d JOIN KEY(d.employees).addresses a</code></pre> |
| In the above query, the managed type associated with the identification variable: |
| <ul> |
| <li>d is "Department" |
| <li>a is "Address" |
| </ul></div> |
| <dl> |
| <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> that should be an simple identification variable or |
| an encapsulated identification variable with the identifier <code><b>KEY</b></code> or |
| <code><b>VALUE</b></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The <a href="../../spi/IManagedType.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi"><code>IManagedType</code></a> representing the domain object declared by the given |
| identification variable</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getManagedType(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)"><code>getManagedType(StateObject)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getManagedType(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getManagedType</h4> |
| <pre class="methodSignature"><a href="../../spi/IManagedType.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi">IManagedType</a> getManagedType​(<a href="StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a> stateObject)</pre> |
| <div class="block">Returns the <a href="../../spi/IManagedType.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi"><code>IManagedType</code></a> for the given identification variable. The search does not |
| traverse up the query hierarchy if this declaration is for a subquery. |
| |
| <pre><code>SELECT e FROM Department d JOIN KEY(d.employees).addresses a</code></pre> |
| In the above query, the managed type associated with the identification variable: |
| <ul> |
| <li>d is "Department" |
| <li>a is "Address" |
| </ul></div> |
| <dl> |
| <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> that should be an simple identification variable or |
| an encapsulated identification variable with the identifier <code><b>KEY</b></code> or |
| <code><b>VALUE</b></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The <a href="../../spi/IManagedType.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi"><code>IManagedType</code></a> representing the domain object declared by the given |
| identification variable</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#findManagedType(org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject)"><code>findManagedType(StateObject)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage">EclipseLink 3.0.0, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../../../allclasses.html">All 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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> |
