Google Git
Sign in
apache / openjpa-site / refs/heads/builds / . / 4.1.1 / apidocs / org / apache / openjpa / kernel / Query.html
blob: 3b8f954ad61c691ee72d29e57d572bde43a41e08 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang>
<head>
<!-- Generated by javadoc -->
<title>Query (OpenJPA Parent POM 4.1.1 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.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.7.1.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Query (OpenJPA Parent POM 4.1.1 API)";
}
}
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,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":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="class-use/Query.html">Use</a></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>
<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>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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.apache.openjpa.kernel</a></div>
<h2 title="Interface Query" class="title">Interface Query</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><code><a href="QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code>, <code><a href="QueryFlushModes.html" title="interface in org.apache.openjpa.kernel">QueryFlushModes</a></code>, <code><a href="QueryOperations.html" title="interface in org.apache.openjpa.kernel">QueryOperations</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="DelegatingQuery.html" title="class in org.apache.openjpa.kernel">DelegatingQuery</a></code>, <code><a href="../slice/DistributedQueryImpl.html" title="class in org.apache.openjpa.slice">DistributedQueryImpl</a></code>, <code><a href="QueryImpl.html" title="class in org.apache.openjpa.kernel">QueryImpl</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">Query</span>
extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a>, <a href="QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a>, <a href="QueryOperations.html" title="interface in org.apache.openjpa.kernel">QueryOperations</a>, <a href="QueryFlushModes.html" title="interface in org.apache.openjpa.kernel">QueryFlushModes</a></pre>
<div class="block">OpenJPA query interface.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.3.0</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Patrick Linskey, Abe White</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.apache.openjpa.kernel.QueryFlushModes">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.openjpa.kernel.<a href="QueryFlushModes.html" title="interface in org.apache.openjpa.kernel">QueryFlushModes</a></h3>
<code><a href="QueryFlushModes.html#FLUSH_FALSE">FLUSH_FALSE</a>, <a href="QueryFlushModes.html#FLUSH_TRUE">FLUSH_TRUE</a>, <a href="QueryFlushModes.html#FLUSH_WITH_CONNECTION">FLUSH_WITH_CONNECTION</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.apache.openjpa.kernel.QueryOperations">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.openjpa.kernel.<a href="QueryOperations.html" title="interface in org.apache.openjpa.kernel">QueryOperations</a></h3>
<code><a href="QueryOperations.html#OP_DELETE">OP_DELETE</a>, <a href="QueryOperations.html#OP_SELECT">OP_SELECT</a>, <a href="QueryOperations.html#OP_UPDATE">OP_UPDATE</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<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>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addAggregateListener(org.apache.openjpa.kernel.exps.AggregateListener)">addAggregateListener</a></span>&#8203;(<a href="exps/AggregateListener.html" title="interface in org.apache.openjpa.kernel.exps">AggregateListener</a>&nbsp;listener)</code></th>
<td class="colLast">
<div class="block">Register an aggregate listener for the query.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addFilterListener(org.apache.openjpa.kernel.exps.FilterListener)">addFilterListener</a></span>&#8203;(<a href="exps/FilterListener.html" title="interface in org.apache.openjpa.kernel.exps">FilterListener</a>&nbsp;listener)</code></th>
<td class="colLast">
<div class="block">Register a filter listener for the query.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#assertNotReadOnly()">assertNotReadOnly</a></span>()</code></th>
<td class="colLast">
<div class="block">Assert that the query is not read-only.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#assertNotSerialized()">assertNotSerialized</a></span>()</code></th>
<td class="colLast">
<div class="block">Check that the query has not been serialized, which causes it to lose
its association with its Broker.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#assertOpen()">assertOpen</a></span>()</code></th>
<td class="colLast">
<div class="block">Assert that the query's broker is still open.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#closeAll()">closeAll</a></span>()</code></th>
<td class="colLast">
<div class="block">Close all open query results.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#closeResources()">closeResources</a></span>()</code></th>
<td class="colLast">
<div class="block">Close query results that are consuming resources.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#compile()">compile</a></span>()</code></th>
<td class="colLast">
<div class="block">Compile the query.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteAll()">deleteAll</a></span>()</code></th>
<td class="colLast">
<div class="block">Deletes all of the instances that are satisfied by the query.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteAll(java.lang.Object%5B%5D)">deleteAll</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>[]&nbsp;parameters)</code></th>
<td class="colLast">
<div class="block">Deletes all of the instances that are satisfied by the query.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteAll(java.util.Map)">deleteAll</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;?,&#8203;?&gt;&nbsp;parameterMap)</code></th>
<td class="colLast">
<div class="block">Deletes all of the instances that are satisfied by the query.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#execute()">execute</a></span>()</code></th>
<td class="colLast">
<div class="block">Execute.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#execute(java.lang.Object%5B%5D)">execute</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>[]&nbsp;params)</code></th>
<td class="colLast">
<div class="block">Execute with parameter array.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#execute(java.util.Map)">execute</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;?,&#8203;?&gt;&nbsp;params)</code></th>
<td class="colLast">
<div class="block">Execute with parameter map.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBroker()">getBroker</a></span>()</code></th>
<td class="colLast">
<div class="block">The broker that generated this query.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="Extent.html" title="interface in org.apache.openjpa.kernel">Extent</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCandidateExtent()">getCandidateExtent</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the candidate extent, or <code>null</code> if a
collection was specified instead of an extent.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDataStoreActions(java.util.Map)">getDataStoreActions</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;?,&#8203;?&gt;&nbsp;params)</code></th>
<td class="colLast">
<div class="block">Returns a description of the commands that will be sent to
the datastore in order to execute this query.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeAggregateListener(org.apache.openjpa.kernel.exps.AggregateListener)">removeAggregateListener</a></span>&#8203;(<a href="exps/AggregateListener.html" title="interface in org.apache.openjpa.kernel.exps">AggregateListener</a>&nbsp;listener)</code></th>
<td class="colLast">
<div class="block">Remove an aggregate listener from the query.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeFilterListener(org.apache.openjpa.kernel.exps.FilterListener)">removeFilterListener</a></span>&#8203;(<a href="exps/FilterListener.html" title="interface in org.apache.openjpa.kernel.exps">FilterListener</a>&nbsp;listener)</code></th>
<td class="colLast">
<div class="block">Remove a filter listener from the query.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCandidateCollection(java.util.Collection)">setCandidateCollection</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;?&gt;&nbsp;coll)</code></th>
<td class="colLast">
<div class="block">Set a collection of candidates.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCandidateExtent(org.apache.openjpa.kernel.Extent)">setCandidateExtent</a></span>&#8203;(<a href="Extent.html" title="interface in org.apache.openjpa.kernel">Extent</a>&nbsp;extent)</code></th>
<td class="colLast">
<div class="block">Set the candidate extent.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setIgnoreChanges(boolean)">setIgnoreChanges</a></span>&#8203;(boolean&nbsp;ignore)</code></th>
<td class="colLast">
<div class="block">Whether to ignore changes in the current transaction.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setQuery(java.lang.Object)">setQuery</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;query)</code></th>
<td class="colLast">
<div class="block">The query string or template.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateAll()">updateAll</a></span>()</code></th>
<td class="colLast">
<div class="block">Performs an update of the instances that are satisfied by the query.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateAll(java.lang.Object%5B%5D)">updateAll</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>[]&nbsp;parameters)</code></th>
<td class="colLast">
<div class="block">Performs an update of the instances that are satisfied by the query.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateAll(java.util.Map)">updateAll</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;?,&#8203;?&gt;&nbsp;parameterMap)</code></th>
<td class="colLast">
<div class="block">Performs an update of the instances that are satisfied by the query.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.openjpa.kernel.QueryContext">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.openjpa.kernel.<a href="QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></h3>
<code><a href="QueryContext.html#classForName(java.lang.String,java.lang.String%5B%5D)">classForName</a>, <a href="QueryContext.html#declareParameters(java.lang.String)">declareParameters</a>, <a href="QueryContext.html#deleteInMemory(org.apache.openjpa.kernel.StoreQuery,org.apache.openjpa.kernel.StoreQuery.Executor,java.lang.Object%5B%5D)">deleteInMemory</a>, <a href="QueryContext.html#getAccessPathMetaDatas()">getAccessPathMetaDatas</a>, <a href="QueryContext.html#getAggregateListener(java.lang.String)">getAggregateListener</a>, <a href="QueryContext.html#getAggregateListeners()">getAggregateListeners</a>, <a href="QueryContext.html#getAlias()">getAlias</a>, <a href="QueryContext.html#getCandidateCollection()">getCandidateCollection</a>, <a href="QueryContext.html#getCandidateType()">getCandidateType</a>, <a href="QueryContext.html#getCompilation()">getCompilation</a>, <a href="QueryContext.html#getEndRange()">getEndRange</a>, <a href="QueryContext.html#getFetchConfiguration()">getFetchConfiguration</a>, <a href="QueryContext.html#getFilterListener(java.lang.String)">getFilterListener</a>, <a href="QueryContext.html#getFilterListeners()">getFilterListeners</a>, <a href="QueryContext.html#getIgnoreChanges()">getIgnoreChanges</a>, <a href="QueryContext.html#getLanguage()">getLanguage</a>, <a href="QueryContext.html#getOperation()">getOperation</a>, <a href="QueryContext.html#getOrderedParameterTypes()">getOrderedParameterTypes</a>, <a href="QueryContext.html#getParameterDeclaration()">getParameterDeclaration</a>, <a href="QueryContext.html#getParameterTypes()">getParameterTypes</a>, <a href="QueryContext.html#getProjectionAliases()">getProjectionAliases</a>, <a href="QueryContext.html#getProjectionTypes()">getProjectionTypes</a>, <a href="QueryContext.html#getQuery()">getQuery</a>, <a href="QueryContext.html#getQueryString()">getQueryString</a>, <a href="QueryContext.html#getResultMappingName()">getResultMappingName</a>, <a href="QueryContext.html#getResultMappingScope()">getResultMappingScope</a>, <a href="QueryContext.html#getResultType()">getResultType</a>, <a href="QueryContext.html#getStartRange()">getStartRange</a>, <a href="QueryContext.html#getStoreContext()">getStoreContext</a>, <a href="QueryContext.html#getUpdates()">getUpdates</a>, <a href="QueryContext.html#hasGrouping()">hasGrouping</a>, <a href="QueryContext.html#hasSubclasses()">hasSubclasses</a>, <a href="QueryContext.html#isAggregate()">isAggregate</a>, <a href="QueryContext.html#isDistinct()">isDistinct</a>, <a href="QueryContext.html#isReadOnly()">isReadOnly</a>, <a href="QueryContext.html#isUnique()">isUnique</a>, <a href="QueryContext.html#lock()">lock</a>, <a href="QueryContext.html#setCandidateType(java.lang.Class,boolean)">setCandidateType</a>, <a href="QueryContext.html#setRange(long,long)">setRange</a>, <a href="QueryContext.html#setReadOnly(boolean)">setReadOnly</a>, <a href="QueryContext.html#setResultMapping(java.lang.Class,java.lang.String)">setResultMapping</a>, <a href="QueryContext.html#setResultType(java.lang.Class)">setResultType</a>, <a href="QueryContext.html#setUnique(boolean)">setUnique</a>, <a href="QueryContext.html#unlock()">unlock</a>, <a href="QueryContext.html#updateInMemory(org.apache.openjpa.kernel.StoreQuery,org.apache.openjpa.kernel.StoreQuery.Executor,java.lang.Object%5B%5D)">updateInMemory</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getBroker()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBroker</h4>
<pre class="methodSignature"><a href="Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a>&nbsp;getBroker()</pre>
<div class="block">The broker that generated this query.</div>
</li>
</ul>
<a id="setQuery(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setQuery</h4>
<pre class="methodSignature">boolean&nbsp;setQuery&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;query)</pre>
<div class="block">The query string or template.</div>
</li>
</ul>
<a id="setIgnoreChanges(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIgnoreChanges</h4>
<pre class="methodSignature">void&nbsp;setIgnoreChanges&#8203;(boolean&nbsp;ignore)</pre>
<div class="block">Whether to ignore changes in the current transaction.</div>
</li>
</ul>
<a id="addFilterListener(org.apache.openjpa.kernel.exps.FilterListener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addFilterListener</h4>
<pre class="methodSignature">void&nbsp;addFilterListener&#8203;(<a href="exps/FilterListener.html" title="interface in org.apache.openjpa.kernel.exps">FilterListener</a>&nbsp;listener)</pre>
<div class="block">Register a filter listener for the query.</div>
</li>
</ul>
<a id="removeFilterListener(org.apache.openjpa.kernel.exps.FilterListener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeFilterListener</h4>
<pre class="methodSignature">void&nbsp;removeFilterListener&#8203;(<a href="exps/FilterListener.html" title="interface in org.apache.openjpa.kernel.exps">FilterListener</a>&nbsp;listener)</pre>
<div class="block">Remove a filter listener from the query.</div>
</li>
</ul>
<a id="addAggregateListener(org.apache.openjpa.kernel.exps.AggregateListener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addAggregateListener</h4>
<pre class="methodSignature">void&nbsp;addAggregateListener&#8203;(<a href="exps/AggregateListener.html" title="interface in org.apache.openjpa.kernel.exps">AggregateListener</a>&nbsp;listener)</pre>
<div class="block">Register an aggregate listener for the query.</div>
</li>
</ul>
<a id="removeAggregateListener(org.apache.openjpa.kernel.exps.AggregateListener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeAggregateListener</h4>
<pre class="methodSignature">void&nbsp;removeAggregateListener&#8203;(<a href="exps/AggregateListener.html" title="interface in org.apache.openjpa.kernel.exps">AggregateListener</a>&nbsp;listener)</pre>
<div class="block">Remove an aggregate listener from the query.</div>
</li>
</ul>
<a id="getCandidateExtent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCandidateExtent</h4>
<pre class="methodSignature"><a href="Extent.html" title="interface in org.apache.openjpa.kernel">Extent</a>&nbsp;getCandidateExtent()</pre>
<div class="block">Return the candidate extent, or <code>null</code> if a
collection was specified instead of an extent.</div>
</li>
</ul>
<a id="setCandidateExtent(org.apache.openjpa.kernel.Extent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCandidateExtent</h4>
<pre class="methodSignature">void&nbsp;setCandidateExtent&#8203;(<a href="Extent.html" title="interface in org.apache.openjpa.kernel">Extent</a>&nbsp;extent)</pre>
<div class="block">Set the candidate extent.</div>
</li>
</ul>
<a id="setCandidateCollection(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCandidateCollection</h4>
<pre class="methodSignature">void&nbsp;setCandidateCollection&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;?&gt;&nbsp;coll)</pre>
<div class="block">Set a collection of candidates.</div>
</li>
</ul>
<a id="compile()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compile</h4>
<pre class="methodSignature">void&nbsp;compile()</pre>
<div class="block">Compile the query.</div>
</li>
</ul>
<a id="execute()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;execute()</pre>
<div class="block">Execute.</div>
</li>
</ul>
<a id="execute(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;execute&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;?,&#8203;?&gt;&nbsp;params)</pre>
<div class="block">Execute with parameter map.</div>
</li>
</ul>
<a id="execute(java.lang.Object[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;execute&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>[]&nbsp;params)</pre>
<div class="block">Execute with parameter array.</div>
</li>
</ul>
<a id="deleteAll()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteAll</h4>
<pre class="methodSignature">long&nbsp;deleteAll()</pre>
<div class="block">Deletes all of the instances that are satisfied by the query.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of instances that were deleted</dd>
</dl>
</li>
</ul>
<a id="deleteAll(java.lang.Object[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteAll</h4>
<pre class="methodSignature">long&nbsp;deleteAll&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>[]&nbsp;parameters)</pre>
<div class="block">Deletes all of the instances that are satisfied by the query.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parameters</code> - the positional parameters for the query</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of instances that were deleted</dd>
</dl>
</li>
</ul>
<a id="deleteAll(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteAll</h4>
<pre class="methodSignature">long&nbsp;deleteAll&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;?,&#8203;?&gt;&nbsp;parameterMap)</pre>
<div class="block">Deletes all of the instances that are satisfied by the query.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parameterMap</code> - the named parameter map</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of instances that were deleted</dd>
</dl>
</li>
</ul>
<a id="updateAll()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateAll</h4>
<pre class="methodSignature">long&nbsp;updateAll()</pre>
<div class="block">Performs an update of the instances that are satisfied by the query.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of instances that were update</dd>
</dl>
</li>
</ul>
<a id="updateAll(java.lang.Object[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateAll</h4>
<pre class="methodSignature">long&nbsp;updateAll&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>[]&nbsp;parameters)</pre>
<div class="block">Performs an update of the instances that are satisfied by the query.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parameters</code> - the positional parameter array</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of instances that were update</dd>
</dl>
</li>
</ul>
<a id="updateAll(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateAll</h4>
<pre class="methodSignature">long&nbsp;updateAll&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;?,&#8203;?&gt;&nbsp;parameterMap)</pre>
<div class="block">Performs an update of the instances that are satisfied by the query.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parameterMap</code> - the named parameter map</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of instances that were update</dd>
</dl>
</li>
</ul>
<a id="closeAll()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>closeAll</h4>
<pre class="methodSignature">void&nbsp;closeAll()</pre>
<div class="block">Close all open query results.</div>
</li>
</ul>
<a id="closeResources()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>closeResources</h4>
<pre class="methodSignature">void&nbsp;closeResources()</pre>
<div class="block">Close query results that are consuming resources. Allow results that
are not consuming resources to remain open so that they continue to
function normally.</div>
</li>
</ul>
<a id="getDataStoreActions(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDataStoreActions</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[]&nbsp;getDataStoreActions&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;?,&#8203;?&gt;&nbsp;params)</pre>
<div class="block">Returns a description of the commands that will be sent to
the datastore in order to execute this query. This will
typically be in the native query language of the database (e.g., SQL).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>params</code> - the named parameter map for the query invocation</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.3.2</dd>
</dl>
</li>
</ul>
<a id="assertOpen()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>assertOpen</h4>
<pre class="methodSignature">void&nbsp;assertOpen()</pre>
<div class="block">Assert that the query's broker is still open.</div>
</li>
</ul>
<a id="assertNotReadOnly()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>assertNotReadOnly</h4>
<pre class="methodSignature">void&nbsp;assertNotReadOnly()</pre>
<div class="block">Assert that the query is not read-only.</div>
</li>
</ul>
<a id="assertNotSerialized()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>assertNotSerialized</h4>
<pre class="methodSignature">void&nbsp;assertNotSerialized()</pre>
<div class="block">Check that the query has not been serialized, which causes it to lose
its association with its Broker.</div>
</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="class-use/Query.html">Use</a></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>
<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>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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; 2006&#x2013;2025 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>