Google Git
Sign in
eclipse / gerrit / www.eclipse.org / eclipselink / a1cc95fb3f44a7bf6484ea92c6e82c7359afaff6 / . / api / 3.0 / org / eclipse / persistence / jpa / jpql / tools / ContentAssistProposals.html
blob: ede57dac0ee4ca5619553f2a1e2853b6e891374b [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.2) on Wed Apr 22 10:19:16 CDT 2020 -->
<title>ContentAssistProposals (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="ContentAssistProposals (EclipseLink 3.0.0, API Reference)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":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&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.eclipse.persistence.jpa.jpql.tools</a></div>
<h2 title="Interface ContentAssistProposals" class="title">Interface ContentAssistProposals</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="DefaultContentAssistProposals.html" title="class in org.eclipse.persistence.jpa.jpql.tools">DefaultContentAssistProposals</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">ContentAssistProposals</span></pre>
<div class="block">This object stores the various proposals available for content assist for a certain position
within a JPQL query. The proposals are stored in categories (abstract schema types, identifiers,
identification variables and mappings).
<p>
Provisional API: This interface is part of an interim API that is still under development and
expected to change significantly before reaching stability. It is available at this early stage
to solicit feedback from pioneering adopters on the understanding that any code that uses this
API will almost certainly be broken (repeatedly) as the API evolves.</div>
<dl>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>2.5</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Pascal Filion</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.3</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="ContentAssistProposals.ClassType.html" title="enum in org.eclipse.persistence.jpa.jpql.tools">ContentAssistProposals.ClassType</a></span></code></th>
<td class="colLast">
<div class="block">This enumeration determines the type of classes returned by <a href="#classNames()"><code>classNames()</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="ContentAssistProposals.EnumProposals.html" title="interface in org.eclipse.persistence.jpa.jpql.tools">ContentAssistProposals.EnumProposals</a></span></code></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>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a>&lt;<a href="spi/IEntity.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi">IEntity</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#abstractSchemaTypes()">abstractSchemaTypes</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the collection of possible abstract schema types.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="ResultQuery.html" title="interface in org.eclipse.persistence.jpa.jpql.tools">ResultQuery</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildEscapedQuery(java.lang.String,java.lang.String,int,boolean)">buildEscapedQuery</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;jpqlQuery,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;proposal,
int&nbsp;position,
boolean&nbsp;insert)</code></th>
<td class="colLast">
<div class="block">Creates a new JPQL query by inserting the given proposal at the given position.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="ResultQuery.html" title="interface in org.eclipse.persistence.jpa.jpql.tools">ResultQuery</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildQuery(java.lang.String,java.lang.String,int,boolean)">buildQuery</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;jpqlQuery,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;proposal,
int&nbsp;position,
boolean&nbsp;insert)</code></th>
<td class="colLast">
<div class="block">Creates a new JPQL query by inserting the given proposal at the given position.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="ResultQuery.html" title="interface in org.eclipse.persistence.jpa.jpql.tools">ResultQuery</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildXmlQuery(java.lang.String,java.lang.String,int,boolean)">buildXmlQuery</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;jpqlQuery,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;proposal,
int&nbsp;position,
boolean&nbsp;insert)</code></th>
<td class="colLast">
<div class="block">Creates a new JPQL query by inserting the given proposal at the given position.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a>&lt;<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>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#classNames()">classNames</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the filtered list of possible class names.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a>&lt;<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>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#columnNames()">columnNames</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the filtered list of possible column names.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a>&lt;<a href="ContentAssistProposals.EnumProposals.html" title="interface in org.eclipse.persistence.jpa.jpql.tools">ContentAssistProposals.EnumProposals</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#enumConstant()">enumConstant</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the filtered list of possible enum constant names.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="spi/IEntity.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi">IEntity</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAbstractSchemaType(java.lang.String)">getAbstractSchemaType</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;identificationVariable)</code></th>
<td class="colLast">
<div class="block">Retrieves the abstract schema type that is mapped with the given identification variable.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="ContentAssistProposals.ClassType.html" title="enum in org.eclipse.persistence.jpa.jpql.tools">ContentAssistProposals.ClassType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getClassType()">getClassType</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../parser/IdentifierRole.html" title="enum in org.eclipse.persistence.jpa.jpql.parser">IdentifierRole</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIdentifierRole(java.lang.String)">getIdentifierRole</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;identifier)</code></th>
<td class="colLast">
<div class="block">Returns the role of the given JPQL identifier.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasProposals()">hasProposals</a></span>()</code></th>
<td class="colLast">
<div class="block">Determines whether there is at least one proposals.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a>&lt;<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>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#identificationVariables()">identificationVariables</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the collection of possible identification variables.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a>&lt;<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>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#identifiers()">identifiers</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the collection of possible JPQL identifiers.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a>&lt;<a href="spi/IMapping.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi">IMapping</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#mappings()">mappings</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the collection of possible <a href="spi/IMapping.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi"><code>mappings</code></a>, which can be state fields,
association fields and/or collection fields depending on the location used to retrieve the
possible proposals.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a>&lt;<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>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#tableNames()">tableNames</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the filtered list of possible table names.</div>
</td>
</tr>
</table>
</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="abstractSchemaTypes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>abstractSchemaTypes</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a>&lt;<a href="spi/IEntity.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi">IEntity</a>&gt;&nbsp;abstractSchemaTypes()</pre>
<div class="block">Returns the collection of possible abstract schema types.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The <a href="spi/IEntity.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi"><code>entities</code></a> defined in the persistence context</dd>
</dl>
</li>
</ul>
<a id="buildEscapedQuery(java.lang.String,java.lang.String,int,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildEscapedQuery</h4>
<pre class="methodSignature"><a href="ResultQuery.html" title="interface in org.eclipse.persistence.jpa.jpql.tools">ResultQuery</a>&nbsp;buildEscapedQuery&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;jpqlQuery,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;proposal,
int&nbsp;position,
boolean&nbsp;insert)</pre>
<div class="block">Creates a new JPQL query by inserting the given proposal at the given position. The updated
JPQL query and position will be adjusted by converting some characters into their corresponding
escaped characters, for instance '\r' will be converted to '\\r.
<p>
The replacement will also handle compound JPQL identifiers when updating the JPQL query.
<p>
Example: If the cursor is within "IS NOT N|" and the proposal is "IS NOT NULL", then "IS NOT"
will not be added twice. If the word to replace is "IS NULL" and the proposal is "IS NOT NULL",
then "NOT" will be inserted between "IS" and "NULL".</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jpqlQuery</code> - The JPQL query to modify with the given proposal</dd>
<dd><code>proposal</code> - The proposal to insert into the query</dd>
<dd><code>position</code> - The position of insertion</dd>
<dd><code>insert</code> - Flag that determines if the partial word following the cursor should be left
intact or should be replaced by the proposal</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The result of inserting the proposal into the query, including the adjust position, if
it was required</dd>
</dl>
</li>
</ul>
<a id="buildQuery(java.lang.String,java.lang.String,int,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildQuery</h4>
<pre class="methodSignature"><a href="ResultQuery.html" title="interface in org.eclipse.persistence.jpa.jpql.tools">ResultQuery</a>&nbsp;buildQuery&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;jpqlQuery,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;proposal,
int&nbsp;position,
boolean&nbsp;insert)</pre>
<div class="block">Creates a new JPQL query by inserting the given proposal at the given position.
<p>
The replacement will also handle compound JPQL identifiers when updating the JPQL query.
<p>
Example: If the cursor is within "IS NOT N|" and the proposal is "IS NOT NULL", then "IS NOT"
will not be added twice. If the word to replace is "IS NULL" and the proposal is "IS NOT NULL",
then "NOT" will be inserted between "IS" and "NULL".</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jpqlQuery</code> - The JPQL query to modify with the given proposal</dd>
<dd><code>proposal</code> - The proposal to insert into the query</dd>
<dd><code>position</code> - The position of insertion</dd>
<dd><code>insert</code> - Flag that determines if the partial word following the cursor should be left
intact or should be replaced by the proposal</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The result of inserting the proposal into the query, including the adjust position, if
it was required</dd>
</dl>
</li>
</ul>
<a id="buildXmlQuery(java.lang.String,java.lang.String,int,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildXmlQuery</h4>
<pre class="methodSignature"><a href="ResultQuery.html" title="interface in org.eclipse.persistence.jpa.jpql.tools">ResultQuery</a>&nbsp;buildXmlQuery&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;jpqlQuery,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;proposal,
int&nbsp;position,
boolean&nbsp;insert)</pre>
<div class="block">Creates a new JPQL query by inserting the given proposal at the given position. The updated
JPQL query and position will be adjusted by converting some characters into their corresponding
escaped characters, for instance '&gt;' will be converted to '&amp;gt;'.
<p>
The replacement will also handle compound JPQL identifiers when updating the JPQL query.
<p>
Example: If the cursor is within "IS NOT N|" and the proposal is "IS NOT NULL", then "IS NOT"
will not be added twice. If the word to replace is "IS NULL" and the proposal is "IS NOT NULL",
then "NOT" will be inserted between "IS" and "NULL".</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jpqlQuery</code> - The JPQL query to modify with the given proposal, which should be the non-
converted string, i.e. any escaped characters should not be converted</dd>
<dd><code>proposal</code> - The proposal to insert into the query</dd>
<dd><code>position</code> - The position of insertion, which was derived from the parsed tree representation
of the JPQL query</dd>
<dd><code>insert</code> - Flag that determines if the partial word following the cursor should be left
intact or should be replaced by the proposal</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The result of inserting the proposal into the query, including the adjust position, if
it was required</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.5</dd>
</dl>
</li>
</ul>
<a id="classNames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>classNames</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a>&lt;<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>&gt;&nbsp;classNames()</pre>
<div class="block">Returns the filtered list of possible class names. This is usually available when the cursor
is within the constructor name of the constructor expression.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The filtered list of possible class names</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../parser/ConstructorExpression.html" title="class in org.eclipse.persistence.jpa.jpql.parser"><code>ConstructorExpression</code></a></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.5</dd>
</dl>
</li>
</ul>
<a id="columnNames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>columnNames</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a>&lt;<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>&gt;&nbsp;columnNames()</pre>
<div class="block">Returns the filtered list of possible column names.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The filtered list of possible column names</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.5</dd>
</dl>
</li>
</ul>
<a id="enumConstant()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enumConstant</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a>&lt;<a href="ContentAssistProposals.EnumProposals.html" title="interface in org.eclipse.persistence.jpa.jpql.tools">ContentAssistProposals.EnumProposals</a>&gt;&nbsp;enumConstant()</pre>
<div class="block">Returns the filtered list of possible enum constant names. This is usually available when the
cursor is after the dot separating a fully qualified enum type and the enum constant.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The filtered list of possible enum constant names associated with its enum type</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.5</dd>
</dl>
</li>
</ul>
<a id="getAbstractSchemaType(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAbstractSchemaType</h4>
<pre class="methodSignature"><a href="spi/IEntity.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi">IEntity</a>&nbsp;getAbstractSchemaType&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;identificationVariable)</pre>
<div class="block">Retrieves the abstract schema type that is mapped with the given identification variable.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>identificationVariable</code> - The identification variable that, if defined as a range variable,
will be mapped to a managed type</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The abstract schema type mapped with the given identification variable or
<code>null</code> if the given variable is mapped to something else or not mapped to anything</dd>
</dl>
</li>
</ul>
<a id="getClassType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClassType</h4>
<pre class="methodSignature"><a href="ContentAssistProposals.ClassType.html" title="enum in org.eclipse.persistence.jpa.jpql.tools">ContentAssistProposals.ClassType</a>&nbsp;getClassType()</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.5</dd>
</dl>
</li>
</ul>
<a id="getIdentifierRole(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIdentifierRole</h4>
<pre class="methodSignature"><a href="../parser/IdentifierRole.html" title="enum in org.eclipse.persistence.jpa.jpql.parser">IdentifierRole</a>&nbsp;getIdentifierRole&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;identifier)</pre>
<div class="block">Returns the role of the given JPQL identifier.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>identifier</code> - The JPQL identifier to retrieve its role</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The <a href="../parser/IdentifierRole.html" title="enum in org.eclipse.persistence.jpa.jpql.parser"><code>IdentifierRole</code></a> for the given JPQL identifier or <code>null</code> if no
role was defined or if the given string is not a valid JPQL identifier</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.4</dd>
</dl>
</li>
</ul>
<a id="hasProposals()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasProposals</h4>
<pre class="methodSignature">boolean&nbsp;hasProposals()</pre>
<div class="block">Determines whether there is at least one proposals.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if there is at least one proposal; otherwise <code>false</code></dd>
</dl>
</li>
</ul>
<a id="identificationVariables()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>identificationVariables</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a>&lt;<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>&gt;&nbsp;identificationVariables()</pre>
<div class="block">Returns the collection of possible identification variables.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The list of possible identification variables</dd>
</dl>
</li>
</ul>
<a id="identifiers()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>identifiers</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a>&lt;<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>&gt;&nbsp;identifiers()</pre>
<div class="block">Returns the collection of possible JPQL identifiers.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The list of possible JPQL identifiers</dd>
</dl>
</li>
</ul>
<a id="mappings()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mappings</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a>&lt;<a href="spi/IMapping.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi">IMapping</a>&gt;&nbsp;mappings()</pre>
<div class="block">Returns the collection of possible <a href="spi/IMapping.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi"><code>mappings</code></a>, which can be state fields,
association fields and/or collection fields depending on the location used to retrieve the
possible proposals.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The list of possible proposals <a href="spi/IMapping.html" title="interface in org.eclipse.persistence.jpa.jpql.tools.spi"><code>mappings</code></a></dd>
</dl>
</li>
</ul>
<a id="tableNames()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>tableNames</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a>&lt;<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>&gt;&nbsp;tableNames()</pre>
<div class="block">Returns the filtered list of possible table names.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The filtered list of possible table names</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.5</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage">EclipseLink 3.0.0, API Reference</div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2017&#x2013;2020 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p>
</footer>
</body>
</html>