| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.2) on Wed Apr 22 10:19:16 CDT 2020 --> |
| <title>org.eclipse.persistence.jpa.jpql.tools (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="org.eclipse.persistence.jpa.jpql.tools (EclipseLink 3.0.0, API Reference)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| 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 class="navBarCell1Rev">Package</li> |
| <li>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> |
| <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> |
| <main role="main"> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.eclipse.persistence.jpa.jpql.tools</h1> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.CollectionExpressionHelper.html" title="interface in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.CollectionExpressionHelper</a><T extends <a href="../parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser">Expression</a>></th> |
| <td class="colLast"> |
| <div class="block">This helper is used to determine how to add proposals within a collection of expressions.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.MappingCollector.html" title="interface in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.MappingCollector</a></th> |
| <td class="colLast"> |
| <div class="block">A collector is responsible to retrieve the possible proposals by using the mappings that can |
| complete a path expression.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.StatementHelper.html" title="interface in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.StatementHelper</a><T extends <a href="../parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser">Expression</a>></th> |
| <td class="colLast"> |
| <div class="block">This helper helps to add JPQL identifiers for the clauses that make up a query statement and |
| also chains the clauses within the query.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="ContentAssistExtension.html" title="interface in org.eclipse.persistence.jpa.jpql.tools">ContentAssistExtension</a></th> |
| <td class="colLast"> |
| <div class="block">This extension can be used to provide additional support to JPQL content assist that is outside |
| the scope of providing proposals related to JPA metadata.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ContentAssistProposals.html" title="interface in org.eclipse.persistence.jpa.jpql.tools">ContentAssistProposals</a></th> |
| <td class="colLast"> |
| <div class="block">This object stores the various proposals available for content assist for a certain position |
| within a JPQL query.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="ContentAssistProposals.EnumProposals.html" title="interface in org.eclipse.persistence.jpa.jpql.tools">ContentAssistProposals.EnumProposals</a></th> |
| <td class="colLast"> |
| <div class="block">Holds onto the <a href="spi/IType.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi"><code>IType</code></a> of the enum type and the list of possible enum constants.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="RefactoringDelta.html" title="interface in org.eclipse.persistence.jpa.jpql.tools">RefactoringDelta</a></th> |
| <td class="colLast"> |
| <div class="block">A refactoring delta contains an ordered collection of <a href="TextEdit.html" title="interface in org.eclipse.persistence.jpa.jpql.tools"><code>TextEdit</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="RefactoringTool.StateObjectUpdater.html" title="interface in org.eclipse.persistence.jpa.jpql.tools">RefactoringTool.StateObjectUpdater</a><T extends <a href="model/query/StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query">StateObject</a>></th> |
| <td class="colLast"> |
| <div class="block">This interface is used to transparently push the new value into the <a href="model/query/StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ResultQuery.html" title="interface in org.eclipse.persistence.jpa.jpql.tools">ResultQuery</a></th> |
| <td class="colLast"> |
| <div class="block">This is used to retrieve the new JPQL query when a content assist item needs to be insert at |
| a certain position.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="TextEdit.html" title="interface in org.eclipse.persistence.jpa.jpql.tools">TextEdit</a></th> |
| <td class="colLast"> |
| <div class="block">A <code>TextEdit</code> contains the information of a change that can be made to the JPQL query |
| after performing a refactoring operation.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor</a></th> |
| <td class="colLast"> |
| <div class="block">The visitor provides support for finding the possible proposals within a JPQL query at a certain |
| position.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.AbstractAppendableExpressionVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.AbstractAppendableExpressionVisitor</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.AbstractConditionalClauseCollectionHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.AbstractConditionalClauseCollectionHelper</a><T extends <a href="../parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser">Expression</a>></th> |
| <td class="colLast"> |
| <div class="block">This helper handles adding proposals within a conditional expression that might be parsed as |
| a single expression or has a collection of expression, which means the fragment is either |
| incomplete or invalid.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.AbstractFromClauseStatementHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.AbstractFromClauseStatementHelper</a><T extends <a href="../parser/AbstractSelectStatement.html" title="class in org.eclipse.persistence.jpa.jpql.parser">AbstractSelectStatement</a>></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.AbstractGroupByClauseStatementHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.AbstractGroupByClauseStatementHelper</a><T extends <a href="../parser/AbstractSelectStatement.html" title="class in org.eclipse.persistence.jpa.jpql.parser">AbstractSelectStatement</a>></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.AbstractHavingClauseStatementHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.AbstractHavingClauseStatementHelper</a><T extends <a href="../parser/AbstractSelectStatement.html" title="class in org.eclipse.persistence.jpa.jpql.parser">AbstractSelectStatement</a>></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.AbstractSelectClauseCollectionHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.AbstractSelectClauseCollectionHelper</a><T extends <a href="../parser/AbstractSelectClause.html" title="class in org.eclipse.persistence.jpa.jpql.parser">AbstractSelectClause</a>></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.AbstractSelectClauseStatementHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.AbstractSelectClauseStatementHelper</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.AbstractWhereClauseSelectStatementHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.AbstractWhereClauseSelectStatementHelper</a><T extends <a href="../parser/AbstractSelectStatement.html" title="class in org.eclipse.persistence.jpa.jpql.parser">AbstractSelectStatement</a>></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.AcceptableTypeVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.AcceptableTypeVisitor</a></th> |
| <td class="colLast"> |
| <div class="block">This visitor retrieves the permitted type from the path expression's parent.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.AppendableExpressionVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.AppendableExpressionVisitor</a></th> |
| <td class="colLast"> |
| <div class="block">This visitor scans the visited <a href="../parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser"><code>Expression</code></a> and determines if a JPQL identifier can be |
| added ("appended") when the position of the cursor is at the end of the expression.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.CollectionExpressionVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.CollectionExpressionVisitor</a></th> |
| <td class="colLast"> |
| <div class="block">This visitor retrieves the <a href="../parser/CollectionExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><code>CollectionExpression</code></a> if it is visited.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.CollectionMappingFilter.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.CollectionMappingFilter</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.ConcatExpressionCollectionHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.ConcatExpressionCollectionHelper</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.ConditionalClauseCollectionHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.ConditionalClauseCollectionHelper</a></th> |
| <td class="colLast"> |
| <div class="block">This helpers handles adding proposals for <a href="../parser/AbstractConditionalClause.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><code>AbstractConditionalClause</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.ConstrutorCollectionHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.ConstrutorCollectionHelper</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.DeclarationVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.DeclarationVisitor</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.DefaultMappingCollector.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.DefaultMappingCollector</a></th> |
| <td class="colLast"> |
| <div class="block">The default implementation of <a href="AbstractContentAssistVisitor.MappingCollector.html" title="interface in org.eclipse.persistence.jpa.jpql.tools"><code>AbstractContentAssistVisitor.MappingCollector</code></a>, which simply returns an empty collection.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.DeleteClauseCollectionHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.DeleteClauseCollectionHelper</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.DeleteClauseStatementHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.DeleteClauseStatementHelper</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.DifferentComparisonFilter.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.DifferentComparisonFilter</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.DoubleEncapsulatedCollectionHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.DoubleEncapsulatedCollectionHelper</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.EncapsulatedExpressionVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.EncapsulatedExpressionVisitor</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.EndingQueryPositionBuilder.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.EndingQueryPositionBuilder</a></th> |
| <td class="colLast"> |
| <div class="block">This builder populates a <a href="../parser/QueryPosition.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><code>QueryPosition</code></a> by traversing the valid portion of the JPQL |
| query.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.EnumVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.EnumVisitor</a></th> |
| <td class="colLast"> |
| <div class="block">This visitor determines whether a path expression can be resolved as a fully qualified enum |
| type and an enum constant.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.FilteringMappingCollector.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.FilteringMappingCollector</a></th> |
| <td class="colLast"> |
| <div class="block">This <a href="AbstractContentAssistVisitor.MappingCollector.html" title="interface in org.eclipse.persistence.jpa.jpql.tools"><code>AbstractContentAssistVisitor.MappingCollector</code></a> returns the possible mappings (non-collection type or |
| collection type) from a managed type.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.FollowingClausesVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.FollowingClausesVisitor</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.FollowingInvalidExpressionVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.FollowingInvalidExpressionVisitor</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.FromClauseCollectionHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.FromClauseCollectionHelper</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.FromClauseStatementHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.FromClauseStatementHelper</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.GroupByClauseCollectionHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.GroupByClauseCollectionHelper</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.GroupByClauseStatementHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.GroupByClauseStatementHelper</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.HavingClauseStatementHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.HavingClauseStatementHelper</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.IncompleteCollectionExpressionVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.IncompleteCollectionExpressionVisitor</a></th> |
| <td class="colLast"> |
| <div class="block">This visitor is used when a clause or a compound expression was parsed with a collection of |
| expressions representing an invalid fragment.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.InvalidExpressionVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.InvalidExpressionVisitor</a></th> |
| <td class="colLast"> |
| <div class="block">This visitor determines if the visited <a href="../parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser"><code>Expression</code></a> is one of the two that represents |
| an invalid expression.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.JoinCollectionHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.JoinCollectionHelper</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.MappingFilterBuilder.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.MappingFilterBuilder</a></th> |
| <td class="colLast"> |
| <div class="block">This visitor is responsible to create the right <a href="../utility/filter/Filter.html" title="interface in org.eclipse.persistence.jpa.jpql.utility.filter"><code>Filter</code></a> based on the type of the <a href="../parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser"><code>Expression</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.MappingTypeFilter.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.MappingTypeFilter</a></th> |
| <td class="colLast"> |
| <div class="block">This <a href="../utility/filter/Filter.html" title="interface in org.eclipse.persistence.jpa.jpql.utility.filter"><code>Filter</code></a> is responsible to filter out the mappings that can't have their type |
| assignable to the one passed in.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.NotExpressionVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.NotExpressionVisitor</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.OrderByClauseCollectionHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.OrderByClauseCollectionHelper</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.OrderByClauseStatementHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.OrderByClauseStatementHelper</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.PropertyMappingFilter.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.PropertyMappingFilter</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.RangeVariableDeclarationVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.RangeVariableDeclarationVisitor</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.ResultVariableVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.ResultVariableVisitor</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.SelectClauseCollectionHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.SelectClauseCollectionHelper</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.SelectClauseStatementHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.SelectClauseStatementHelper</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.SimpleFromClauseStatementHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.SimpleFromClauseStatementHelper</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.SimpleGroupByClauseStatementHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.SimpleGroupByClauseStatementHelper</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.SimpleHavingClauseStatementHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.SimpleHavingClauseStatementHelper</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.SimpleSelectClauseCollectionHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.SimpleSelectClauseCollectionHelper</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.SimpleSelectClauseStatementHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.SimpleSelectClauseStatementHelper</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.SimpleWhereClauseSelectStatementHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.SimpleWhereClauseSelectStatementHelper</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.SubqueryAppendableExpressionVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.SubqueryAppendableExpressionVisitor</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.SubqueryVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.SubqueryVisitor</a></th> |
| <td class="colLast"> |
| <div class="block">This visitor determines if an <a href="../parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser"><code>Expression</code></a> is in a subquery.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.TripleEncapsulatedCollectionHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.TripleEncapsulatedCollectionHelper</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.UpdateClauseStatementHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.UpdateClauseStatementHelper</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.UpdateItemCollectionHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.UpdateItemCollectionHelper</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.VisitParentVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.VisitParentVisitor</a></th> |
| <td class="colLast"> |
| <div class="block">This visitor is meant to adjust the corrections stack when traversing an <a href="../parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser"><code>Expression</code></a> in |
| order to increase the list of valid proposals.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.WhenClauseConditionalClauseCollectionHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.WhenClauseConditionalClauseCollectionHelper</a></th> |
| <td class="colLast"> |
| <div class="block">This helpers handles adding proposals for <a href="../parser/WhenClause.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><code>WhenClause</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.WhereClauseDeleteStatementHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.WhereClauseDeleteStatementHelper</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.WhereClauseSelectStatementHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.WhereClauseSelectStatementHelper</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.WhereClauseUpdateStatementHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.WhereClauseUpdateStatementHelper</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.WithinInvalidExpressionVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.WithinInvalidExpressionVisitor</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractJPQLQueryHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractJPQLQueryHelper</a></th> |
| <td class="colLast"> |
| <div class="block">This helper can perform the following operations over a JPQL query: |
| |
| Calculates the result type of a query: <a href="AbstractJPQLQueryHelper.html#getResultType()"><code>AbstractJPQLQueryHelper.getResultType()</code></a>; |
| Calculates the type of an input parameter: <a href="AbstractJPQLQueryHelper.html#getParameterType(java.lang.String)"><code>AbstractJPQLQueryHelper.getParameterType(String)</code></a>. |
| Calculates the possible choices to complete the query from a given |
| position (used for content assist): <a href="AbstractJPQLQueryHelper.html#buildContentAssistProposals(int)"><code>AbstractJPQLQueryHelper.buildContentAssistProposals(int)</code></a>. |
| Validates the query by introspecting it grammatically and semantically: |
| |
| <a href="AbstractJPQLQueryHelper.html#validate()"><code>AbstractJPQLQueryHelper.validate()</code></a>, |
| <a href="AbstractJPQLQueryHelper.html#validateGrammar()"><code>AbstractJPQLQueryHelper.validateGrammar()</code></a>, |
| <a href="AbstractJPQLQueryHelper.html#validateSemantic()"><code>AbstractJPQLQueryHelper.validateSemantic()</code></a>. |
| |
| |
| Refactoring support: |
| |
| <a href="AbstractJPQLQueryHelper.html#buildBasicRefactoringTool()"><code>AbstractJPQLQueryHelper.buildBasicRefactoringTool()</code></a> provides support for generating the delta of the |
| refactoring operation through a collection of <a href="TextEdit.html" title="interface in org.eclipse.persistence.jpa.jpql.tools"><code>TextEdit</code></a> objects. |
| <a href="AbstractJPQLQueryHelper.html#buildRefactoringTool()"><code>AbstractJPQLQueryHelper.buildRefactoringTool()</code></a> provides support for refactoring the JPQL query through |
| the editable <a href="model/query/StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> |
| and once all refactoring operations have been executed, the <a href="model/IJPQLQueryFormatter.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model"><code>IJPQLQueryFormatter</code></a> will |
| generate a new string representation of the JPQL query. |
| |
| |
| </div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractRefactoringTool.html" title="class in org.eclipse.persistence.jpa.jpql.tools">AbstractRefactoringTool</a></th> |
| <td class="colLast"> |
| <div class="block">The abstract definition of a refactoring</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="BasicRefactoringTool.html" title="class in org.eclipse.persistence.jpa.jpql.tools">BasicRefactoringTool</a></th> |
| <td class="colLast"> |
| <div class="block">The abstract implementation providing refactoring support for JPQL queries.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="BasicRefactoringTool.JavaQuery.html" title="class in org.eclipse.persistence.jpa.jpql.tools">BasicRefactoringTool.JavaQuery</a></th> |
| <td class="colLast"> |
| <div class="block">A simple implementation of <a href="spi/IQuery.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi"><code>IQuery</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DefaultBasicRefactoringTool.html" title="class in org.eclipse.persistence.jpa.jpql.tools">DefaultBasicRefactoringTool</a></th> |
| <td class="colLast"> |
| <div class="block">This utility class provides basic refactoring support.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DefaultContentAssistProposals.html" title="class in org.eclipse.persistence.jpa.jpql.tools">DefaultContentAssistProposals</a></th> |
| <td class="colLast"> |
| <div class="block">The default implementation of <a href="ContentAssistProposals.html" title="interface in org.eclipse.persistence.jpa.jpql.tools"><code>ContentAssistProposals</code></a> which stores the valid proposals.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DefaultContentAssistVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.tools">DefaultContentAssistVisitor</a></th> |
| <td class="colLast"> |
| <div class="block">This visitor traverses the JPQL parsed tree and gathers the possible proposals at a given position.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DefaultGrammarValidator.html" title="class in org.eclipse.persistence.jpa.jpql.tools">DefaultGrammarValidator</a></th> |
| <td class="colLast"> |
| <div class="block">This validator is responsible to validate a JPQL query grammatically purely based on the JPA |
| specification document.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DefaultJPQLQueryContext.html" title="class in org.eclipse.persistence.jpa.jpql.tools">DefaultJPQLQueryContext</a></th> |
| <td class="colLast"> |
| <div class="block">This context is used to store information related to the JPQL query.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DefaultJPQLQueryHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">DefaultJPQLQueryHelper</a></th> |
| <td class="colLast"> |
| <div class="block">This helper can perform the following operations over a JPQL query: |
| |
| Calculates the result type of a query: <a href="AbstractJPQLQueryHelper.html#getResultType()"><code>AbstractJPQLQueryHelper.getResultType()</code></a>; |
| Calculates the type of an input parameter: <a href="AbstractJPQLQueryHelper.html#getParameterType(java.lang.String)"><code>AbstractJPQLQueryHelper.getParameterType(String)</code></a>. |
| Calculates the possible choices to complete the query from a given |
| position (used for content assist): <a href="AbstractJPQLQueryHelper.html#buildContentAssistProposals(int)"><code>AbstractJPQLQueryHelper.buildContentAssistProposals(int)</code></a>. |
| Validates the query by introspecting it grammatically and semantically: |
| |
| <a href="AbstractJPQLQueryHelper.html#validate()"><code>AbstractJPQLQueryHelper.validate()</code></a>, |
| <a href="AbstractJPQLQueryHelper.html#validateGrammar()"><code>AbstractJPQLQueryHelper.validateGrammar()</code></a>, |
| <a href="AbstractJPQLQueryHelper.html#validateSemantic()"><code>AbstractJPQLQueryHelper.validateSemantic()</code></a>. |
| |
| |
| Refactoring support: |
| |
| <a href="DefaultJPQLQueryHelper.html#buildBasicRefactoringTool()"><code>DefaultJPQLQueryHelper.buildBasicRefactoringTool()</code></a> provides support for generating the delta of the |
| refactoring operation through a collection of <a href="TextEdit.html" title="interface in org.eclipse.persistence.jpa.jpql.tools"><code>TextEdit</code></a> objects. |
| <a href="DefaultJPQLQueryHelper.html#buildRefactoringTool()"><code>DefaultJPQLQueryHelper.buildRefactoringTool()</code></a> provides support for refactoring the JPQL query through |
| the editable <a href="model/query/StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> and |
| once all refactoring operations have been executed, the <a href="model/IJPQLQueryFormatter.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model"><code>IJPQLQueryFormatter</code></a> will |
| generate a new string representation of the JPQL query. |
| |
| |
| |
| |
| This helper should be used when the JPQL query is written using the JPQL grammar defined in the |
| Java Persistence functional specification 1.0 or 2.x.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DefaultLiteralVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.tools">DefaultLiteralVisitor</a></th> |
| <td class="colLast"> |
| <div class="block">This visitor traverses an <a href="../parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser"><code>Expression</code></a> |
| and retrieves the "literal" value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DefaultParameterTypeVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.tools">DefaultParameterTypeVisitor</a></th> |
| <td class="colLast"> |
| <div class="block">This visitor calculates the type of an input parameter.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DefaultRefactoringDelta.html" title="class in org.eclipse.persistence.jpa.jpql.tools">DefaultRefactoringDelta</a></th> |
| <td class="colLast"> |
| <div class="block">The default implementation of <a href="RefactoringDelta.html" title="interface in org.eclipse.persistence.jpa.jpql.tools"><code>RefactoringDelta</code></a> which contains the <a href="TextEdit.html" title="interface in org.eclipse.persistence.jpa.jpql.tools"><code>TextEdit</code></a> that |
| were creating during the refactoring of a JPQL query.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DefaultRefactoringTool.html" title="class in org.eclipse.persistence.jpa.jpql.tools">DefaultRefactoringTool</a></th> |
| <td class="colLast"> |
| <div class="block">This utility class provides basic refactoring support.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DefaultSemanticValidator.html" title="class in org.eclipse.persistence.jpa.jpql.tools">DefaultSemanticValidator</a></th> |
| <td class="colLast"> |
| <div class="block">This validator is responsible to gather the problems found in a JPQL query by validating the |
| content to make sure it is semantically valid.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DefaultSemanticValidator.NullValueVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.tools">DefaultSemanticValidator.NullValueVisitor</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DefaultSemanticValidator.ResultVariableInOrderByVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.tools">DefaultSemanticValidator.ResultVariableInOrderByVisitor</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DefaultSemanticValidator.UpdateClauseAbstractSchemaNameFinder.html" title="class in org.eclipse.persistence.jpa.jpql.tools">DefaultSemanticValidator.UpdateClauseAbstractSchemaNameFinder</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DefaultTextEdit.html" title="class in org.eclipse.persistence.jpa.jpql.tools">DefaultTextEdit</a></th> |
| <td class="colLast"> |
| <div class="block">The default implementation of a <a href="TextEdit.html" title="interface in org.eclipse.persistence.jpa.jpql.tools"><code>TextEdit</code></a>, which contains the location of the change within |
| the JPQL query (offset) and the old and new values.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="EclipseLinkBasicRefactoringTool.html" title="class in org.eclipse.persistence.jpa.jpql.tools">EclipseLinkBasicRefactoringTool</a></th> |
| <td class="colLast"> |
| <div class="block">This utility class provides basic refactoring support.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="EclipseLinkContentAssistVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.tools">EclipseLinkContentAssistVisitor</a></th> |
| <td class="colLast"> |
| <div class="block">This extension over the default content assist visitor adds the additional support EclipseLink |
| provides.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="EclipseLinkContentAssistVisitor.AcceptableTypeVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.tools">EclipseLinkContentAssistVisitor.AcceptableTypeVisitor</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="EclipseLinkContentAssistVisitor.AppendableExpressionVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.tools">EclipseLinkContentAssistVisitor.AppendableExpressionVisitor</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="EclipseLinkContentAssistVisitor.EndingQueryPositionBuilder.html" title="class in org.eclipse.persistence.jpa.jpql.tools">EclipseLinkContentAssistVisitor.EndingQueryPositionBuilder</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="EclipseLinkContentAssistVisitor.FollowingClausesVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.tools">EclipseLinkContentAssistVisitor.FollowingClausesVisitor</a></th> |
| <td class="colLast"> |
| <div class="block">This visitor adds support for the additional clauses provided by EclipseLink, such as the</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="EclipseLinkJPQLQueryContext.html" title="class in org.eclipse.persistence.jpa.jpql.tools">EclipseLinkJPQLQueryContext</a></th> |
| <td class="colLast"> |
| <div class="block">This context is used to store information related to the JPQL query.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="EclipseLinkJPQLQueryHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">EclipseLinkJPQLQueryHelper</a></th> |
| <td class="colLast"> |
| <div class="block">This helper can perform the following operations over a JPQL query: |
| |
| Calculates the result type of a query: <a href="AbstractJPQLQueryHelper.html#getResultType()"><code>AbstractJPQLQueryHelper.getResultType()</code></a>; |
| Calculates the type of an input parameter: <a href="AbstractJPQLQueryHelper.html#getParameterType(java.lang.String)"><code>AbstractJPQLQueryHelper.getParameterType(String)</code></a>. |
| Calculates the possible choices to complete the query from a given |
| position (used for content assist): <a href="AbstractJPQLQueryHelper.html#buildContentAssistProposals(int)"><code>AbstractJPQLQueryHelper.buildContentAssistProposals(int)</code></a>. |
| Validates the query by introspecting it grammatically and semantically: |
| |
| <a href="AbstractJPQLQueryHelper.html#validate()"><code>AbstractJPQLQueryHelper.validate()</code></a>, |
| <a href="AbstractJPQLQueryHelper.html#validateGrammar()"><code>AbstractJPQLQueryHelper.validateGrammar()</code></a>, |
| <a href="AbstractJPQLQueryHelper.html#validateSemantic()"><code>AbstractJPQLQueryHelper.validateSemantic()</code></a>. |
| |
| |
| Refactoring support: |
| |
| <a href="EclipseLinkJPQLQueryHelper.html#buildBasicRefactoringTool()"><code>EclipseLinkJPQLQueryHelper.buildBasicRefactoringTool()</code></a> provides support for generating the delta of the |
| refactoring operation through a collection of <a href="TextEdit.html" title="interface in org.eclipse.persistence.jpa.jpql.tools"><code>TextEdit</code></a> objects. |
| <a href="EclipseLinkJPQLQueryHelper.html#buildRefactoringTool()"><code>EclipseLinkJPQLQueryHelper.buildRefactoringTool()</code></a> provides support for refactoring the JPQL query through |
| the editable <a href="model/query/StateObject.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model.query"><code>StateObject</code></a> and |
| once all refactoring operations have been executed, the <a href="model/IJPQLQueryFormatter.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.model"><code>IJPQLQueryFormatter</code></a> will generate |
| a new string representation of the JPQL query. |
| |
| |
| |
| |
| This helper should be used when the JPQL query is written using the JPQL grammar defined in the |
| Java Persistence functional specification 2.1 and it contains the additional support provided by |
| EclipseLink.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="EclipseLinkParameterTypeVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.tools">EclipseLinkParameterTypeVisitor</a></th> |
| <td class="colLast"> |
| <div class="block">This visitor calculates the type of an input parameter.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="EclipseLinkRefactoringTool.html" title="class in org.eclipse.persistence.jpa.jpql.tools">EclipseLinkRefactoringTool</a></th> |
| <td class="colLast"> |
| <div class="block">This refactoring tool add support for EclipseLink specific extension over the default |
| implementation of JPQL defined in the Java Persistence functional specification.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="EclipseLinkResolverBuilder.html" title="class in org.eclipse.persistence.jpa.jpql.tools">EclipseLinkResolverBuilder</a></th> |
| <td class="colLast"> |
| <div class="block">An implementation of a <a href="resolver/ResolverBuilder.html" title="class in org.eclipse.persistence.jpa.jpql.tools.resolver"><code>ResolverBuilder</code></a> that adds support for EclipseLink extension.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="EclipseLinkSemanticValidator.html" title="class in org.eclipse.persistence.jpa.jpql.tools">EclipseLinkSemanticValidator</a></th> |
| <td class="colLast"> |
| <div class="block">This validator is responsible to gather the problems found in a JPQL query by validating the |
| content to make sure it is semantically valid for EclipseLink.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="GenericSemanticValidatorHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">GenericSemanticValidatorHelper</a></th> |
| <td class="colLast"> |
| <div class="block">An implementation of <a href="../SemanticValidatorHelper.html" title="interface in org.eclipse.persistence.jpa.jpql"><code>SemanticValidatorHelper</code></a> that uses <a href="JPQLQueryContext.html" title="class in org.eclipse.persistence.jpa.jpql.tools"><code>JPQLQueryContext</code></a> to return |
| the required information and Hermes SPI.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="GenericSemanticValidatorHelper.IdentificationVariableVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.tools">GenericSemanticValidatorHelper.IdentificationVariableVisitor</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="GenericTypeHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">GenericTypeHelper</a></th> |
| <td class="colLast"> |
| <div class="block">This generic implementation of <a href="../ITypeHelper.html" title="interface in org.eclipse.persistence.jpa.jpql"><code>ITypeHelper</code></a> wraps <a href="../ITypeHelper.html" title="interface in org.eclipse.persistence.jpa.jpql"><code>ITypeHelper</code></a> and delegates the |
| calls to it.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="JPQLQueryContext.html" title="class in org.eclipse.persistence.jpa.jpql.tools">JPQLQueryContext</a></th> |
| <td class="colLast"> |
| <div class="block">This context is used to store information related to the JPQL query.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="JPQLQueryContext.QueryExpressionVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.tools">JPQLQueryContext.QueryExpressionVisitor</a></th> |
| <td class="colLast"> |
| <div class="block">This visitor is responsible to retrieve the <a href="../parser/Expression.html" title="interface in org.eclipse.persistence.jpa.jpql.parser"><code>Expression</code></a> that is the beginning of a |
| query.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="NumericTypeComparator.html" title="class in org.eclipse.persistence.jpa.jpql.tools">NumericTypeComparator</a></th> |
| <td class="colLast"> |
| <div class="block">This <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Comparator</code></a> is used to sort <a href="spi/IType.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi"><code>ITypes</code></a> based on the numerical priority.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="RefactoringTool.html" title="class in org.eclipse.persistence.jpa.jpql.tools">RefactoringTool</a></th> |
| <td class="colLast"> |
| <div class="block">The abstract implementation providing refactoring support for JPQL queries.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="RefactoringTool.ClassNameRenamer.html" title="class in org.eclipse.persistence.jpa.jpql.tools">RefactoringTool.ClassNameRenamer</a></th> |
| <td class="colLast"> |
| <div class="block">This visitor renames a fully qualified class name.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="RefactoringTool.EntityNameRenamer.html" title="class in org.eclipse.persistence.jpa.jpql.tools">RefactoringTool.EntityNameRenamer</a></th> |
| <td class="colLast"> |
| <div class="block">This visitor renames an entity name.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="RefactoringTool.EnumConstantRenamer.html" title="class in org.eclipse.persistence.jpa.jpql.tools">RefactoringTool.EnumConstantRenamer</a></th> |
| <td class="colLast"> |
| <div class="block">This visitor renames an enum constant.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="RefactoringTool.FieldNameRenamer.html" title="class in org.eclipse.persistence.jpa.jpql.tools">RefactoringTool.FieldNameRenamer</a></th> |
| <td class="colLast"> |
| <div class="block">This visitor renames any segment of a path expression.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="RefactoringTool.ResultVariableNameRenamer.html" title="class in org.eclipse.persistence.jpa.jpql.tools">RefactoringTool.ResultVariableNameRenamer</a></th> |
| <td class="colLast"> |
| <div class="block">This visitor renames all the result variables found in the JPQL query.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="RefactoringTool.VariableNameRenamer.html" title="class in org.eclipse.persistence.jpa.jpql.tools">RefactoringTool.VariableNameRenamer</a></th> |
| <td class="colLast"> |
| <div class="block">This visitor renames all the identification variables found in the JPQL query.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="TypeHelper.html" title="class in org.eclipse.persistence.jpa.jpql.tools">TypeHelper</a></th> |
| <td class="colLast"> |
| <div class="block">This helper contains methods related to <a href="spi/IType.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi"><code>IType</code></a> and can perform equivalency checks.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.AppendableType.html" title="enum in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.AppendableType</a></th> |
| <td class="colLast"> |
| <div class="block">This is used to determine how <a href="AbstractContentAssistVisitor.AppendableExpressionVisitor.html" title="class in org.eclipse.persistence.jpa.jpql.tools"><code>AbstractContentAssistVisitor.AppendableExpressionVisitor</code></a> should perform the check.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="AbstractContentAssistVisitor.IdentificationVariableType.html" title="enum in org.eclipse.persistence.jpa.jpql.tools">AbstractContentAssistVisitor.IdentificationVariableType</a></th> |
| <td class="colLast"> |
| <div class="block">The various ways of retrieving identification variables from the declaration expression.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ContentAssistProposals.ClassType.html" title="enum in org.eclipse.persistence.jpa.jpql.tools">ContentAssistProposals.ClassType</a></th> |
| <td class="colLast"> |
| <div class="block">This enumeration determines the type of classes returned by <a href="ContentAssistProposals.html#classNames()"><code>ContentAssistProposals.classNames()</code></a>.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </div> |
| </main> |
| <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 class="navBarCell1Rev">Package</li> |
| <li>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> |
| <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> |
