| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_252) on Thu Sep 03 11:54:23 CEST 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>DelegatingQuery (OpenJPA Parent POM 3.1.2 API)</title> |
| <meta name="date" content="2020-09-03"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="DelegatingQuery (OpenJPA Parent POM 3.1.2 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":10,"i61":10,"i62":10,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":10,"i69":10,"i70":10,"i71":10,"i72":10,"i73":10,"i74":10,"i75":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/DelegatingQuery.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"> |
| <li><a href="../../../../org/apache/openjpa/kernel/DelegatingFetchConfiguration.html" title="class in org.apache.openjpa.kernel"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/kernel/DelegatingResultList.html" title="class in org.apache.openjpa.kernel"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/kernel/DelegatingQuery.html" target="_top">Frames</a></li> |
| <li><a href="DelegatingQuery.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.openjpa.kernel</div> |
| <h2 title="Class DelegatingQuery" class="title">Class DelegatingQuery</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.openjpa.kernel.DelegatingQuery</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a>, <a href="../../../../org/apache/openjpa/kernel/QueryFlushModes.html" title="interface in org.apache.openjpa.kernel">QueryFlushModes</a>, <a href="../../../../org/apache/openjpa/kernel/QueryOperations.html" title="interface in org.apache.openjpa.kernel">QueryOperations</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">DelegatingQuery</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></pre> |
| <div class="block">Delegating query that can also perform exception translation |
| for use in facades.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.4.0</dd> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Abe White</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../serialized-form.html#org.apache.openjpa.kernel.DelegatingQuery">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.openjpa.kernel.QueryOperations"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.openjpa.kernel.<a href="../../../../org/apache/openjpa/kernel/QueryOperations.html" title="interface in org.apache.openjpa.kernel">QueryOperations</a></h3> |
| <code><a href="../../../../org/apache/openjpa/kernel/QueryOperations.html#OP_DELETE">OP_DELETE</a>, <a href="../../../../org/apache/openjpa/kernel/QueryOperations.html#OP_SELECT">OP_SELECT</a>, <a href="../../../../org/apache/openjpa/kernel/QueryOperations.html#OP_UPDATE">OP_UPDATE</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.openjpa.kernel.QueryFlushModes"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.openjpa.kernel.<a href="../../../../org/apache/openjpa/kernel/QueryFlushModes.html" title="interface in org.apache.openjpa.kernel">QueryFlushModes</a></h3> |
| <code><a href="../../../../org/apache/openjpa/kernel/QueryFlushModes.html#FLUSH_FALSE">FLUSH_FALSE</a>, <a href="../../../../org/apache/openjpa/kernel/QueryFlushModes.html#FLUSH_TRUE">FLUSH_TRUE</a>, <a href="../../../../org/apache/openjpa/kernel/QueryFlushModes.html#FLUSH_WITH_CONNECTION">FLUSH_WITH_CONNECTION</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#DelegatingQuery-org.apache.openjpa.kernel.Query-">DelegatingQuery</a></span>(<a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a> query)</code> |
| <div class="block">Constructor; supply delegate.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#DelegatingQuery-org.apache.openjpa.kernel.Query-org.apache.openjpa.util.RuntimeExceptionTranslator-">DelegatingQuery</a></span>(<a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a> query, |
| <a href="../../../../org/apache/openjpa/util/RuntimeExceptionTranslator.html" title="interface in org.apache.openjpa.util">RuntimeExceptionTranslator</a> trans)</code> |
| <div class="block">Constructor; supply delegate and exception translator.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#addAggregateListener-org.apache.openjpa.kernel.exps.AggregateListener-">addAggregateListener</a></span>(<a href="../../../../org/apache/openjpa/kernel/exps/AggregateListener.html" title="interface in org.apache.openjpa.kernel.exps">AggregateListener</a> listener)</code> |
| <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> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#addFilterListener-org.apache.openjpa.kernel.exps.FilterListener-">addFilterListener</a></span>(<a href="../../../../org/apache/openjpa/kernel/exps/FilterListener.html" title="interface in org.apache.openjpa.kernel.exps">FilterListener</a> listener)</code> |
| <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> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#assertNotReadOnly--">assertNotReadOnly</a></span>()</code> |
| <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> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#assertNotSerialized--">assertNotSerialized</a></span>()</code> |
| <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> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#assertOpen--">assertOpen</a></span>()</code> |
| <div class="block">Assert that the query's broker is still open.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#classForName-java.lang.String-java.lang.String:A-">classForName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] imports)</code> |
| <div class="block">Helper method to instantiate the class with the given name, taking |
| into account the query's candidate package, automatic imports, and |
| the given imports (if any).</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#closeAll--">closeAll</a></span>()</code> |
| <div class="block">Close all open query results.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#closeResources--">closeResources</a></span>()</code> |
| <div class="block">Close query results that are consuming resources.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#compile--">compile</a></span>()</code> |
| <div class="block">Compile the query.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#declareParameters-java.lang.String-">declareParameters</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> params)</code> |
| <div class="block">Declared parameters, for query languages that use them.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#deleteAll--">deleteAll</a></span>()</code> |
| <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>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#deleteAll-java.util.Map-">deleteAll</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> parameterMap)</code> |
| <div class="block">Deletes all of the instances that are satisfied by the query.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#deleteAll-java.lang.Object:A-">deleteAll</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[] parameters)</code> |
| <div class="block">Deletes all of the instances that are satisfied by the query.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#deleteInMemory-org.apache.openjpa.kernel.StoreQuery-org.apache.openjpa.kernel.StoreQuery.Executor-java.lang.Object:A-">deleteInMemory</a></span>(<a href="../../../../org/apache/openjpa/kernel/StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a> q, |
| <a href="../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel">StoreQuery.Executor</a> ex, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[] params)</code> |
| <div class="block">Helper method to delete the objects found by executing a query on |
| the given executor.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#equals-java.lang.Object-">equals</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> other)</code> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#execute--">execute</a></span>()</code> |
| <div class="block">Execute.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#execute-java.util.Map-">execute</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> params)</code> |
| <div class="block">Execute with parameter map.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#execute-java.lang.Object:A-">execute</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[] params)</code> |
| <div class="block">Execute with parameter array.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#getAccessPathMetaDatas--">getAccessPathMetaDatas</a></span>()</code> |
| <div class="block">Return the classes that affect this query.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/exps/AggregateListener.html" title="interface in org.apache.openjpa.kernel.exps">AggregateListener</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#getAggregateListener-java.lang.String-">getAggregateListener</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tag)</code> |
| <div class="block">Return the filter listener for the given tag, or null.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#getAggregateListeners--">getAggregateListeners</a></span>()</code> |
| <div class="block">The set of aggregate listeners.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#getAlias--">getAlias</a></span>()</code> |
| <div class="block">If this query is not a projection but places candidate results into a |
| result class under an alias, return that alias.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#getBroker--">getBroker</a></span>()</code> |
| <div class="block">The broker that generated this query.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#getCandidateCollection--">getCandidateCollection</a></span>()</code> |
| <div class="block">Return the candidate collection, or <code>null</code> if an |
| extent was specified instead of a collection.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/Extent.html" title="interface in org.apache.openjpa.kernel">Extent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#getCandidateExtent--">getCandidateExtent</a></span>()</code> |
| <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="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#getCandidateType--">getCandidateType</a></span>()</code> |
| <div class="block">Return the class of the objects that this query will return, |
| or <code>null</code> if this information is not available / not relevant.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#getCompilation--">getCompilation</a></span>()</code> |
| <div class="block">Return the query's compilation state.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#getDataStoreActions-java.util.Map-">getDataStoreActions</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> params)</code> |
| <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="i28" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#getDelegate--">getDelegate</a></span>()</code> |
| <div class="block">Return the direct delegate.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#getEndRange--">getEndRange</a></span>()</code> |
| <div class="block">Return the 0-based exclusive end index for the returned results, |
| or <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true#MAX_VALUE" title="class or interface in java.lang"><code>Long.MAX_VALUE</code></a> for no limit.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#getFetchConfiguration--">getFetchConfiguration</a></span>()</code> |
| <div class="block">Return the fetch configuration for this query.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/exps/FilterListener.html" title="interface in org.apache.openjpa.kernel.exps">FilterListener</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#getFilterListener-java.lang.String-">getFilterListener</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tag)</code> |
| <div class="block">Return the filter listener for the given tag, or null.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#getFilterListeners--">getFilterListeners</a></span>()</code> |
| <div class="block">The set of filter listeners.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#getIgnoreChanges--">getIgnoreChanges</a></span>()</code> |
| <div class="block">Whether to ignore changes in the current transaction.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#getInnermostDelegate--">getInnermostDelegate</a></span>()</code> |
| <div class="block">Return the native delegate.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#getLanguage--">getLanguage</a></span>()</code> |
| <div class="block">The query language.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#getOperation--">getOperation</a></span>()</code> |
| <div class="block">Returns the operation that this query will be expected to perform.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/lib/util/OrderedMap.html" title="class in org.apache.openjpa.lib.util">OrderedMap</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#getOrderedParameterTypes--">getOrderedParameterTypes</a></span>()</code> |
| <div class="block">Return a map of parameter name to type for this query.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#getParameterDeclaration--">getParameterDeclaration</a></span>()</code> |
| <div class="block">The parameter declaration.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>org.apache.commons.collections4.map.LinkedMap</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#getParameterTypes--">getParameterTypes</a></span>()</code> |
| <div class="block">Return a map of parameter name to type for this query.</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#getProjectionAliases--">getProjectionAliases</a></span>()</code> |
| <div class="block">If this query is a projection, return the projection aliases.</div> |
| </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#getProjectionTypes--">getProjectionTypes</a></span>()</code> |
| <div class="block">If this query is a projection, return the projection types.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#getQuery--">getQuery</a></span>()</code> |
| <div class="block">Return the query for this context.</div> |
| </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#getQueryString--">getQueryString</a></span>()</code> |
| <div class="block">The query string.</div> |
| </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#getResultMappingName--">getResultMappingName</a></span>()</code> |
| <div class="block">Name of a mapping from the result data to its object representation.</div> |
| </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#getResultMappingScope--">getResultMappingScope</a></span>()</code> |
| <div class="block">Scope of a mapping from the result data to its object representation.</div> |
| </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#getResultType--">getResultType</a></span>()</code> |
| <div class="block">Returns the result class that has been set through |
| <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setResultType-java.lang.Class-"><code>QueryContext.setResultType(java.lang.Class<?>)</code></a>, or null if none.</div> |
| </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#getStartRange--">getStartRange</a></span>()</code> |
| <div class="block">Return the 0-based start index for the returned results.</div> |
| </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#getStoreContext--">getStoreContext</a></span>()</code> |
| <div class="block">The persistence context for the query.</div> |
| </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#getUpdates--">getUpdates</a></span>()</code> |
| <div class="block">If this query is a bulk update, return a map of the |
| <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta"><code>FieldMetaData</code></a>s to <a href="../../../../org/apache/openjpa/kernel/exps/Constant.html" title="interface in org.apache.openjpa.kernel.exps"><code>Constant</code></a>s.</div> |
| </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#hasGrouping--">hasGrouping</a></span>()</code> |
| <div class="block">Return true if the query uses grouping.</div> |
| </td> |
| </tr> |
| <tr id="i51" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#hashCode--">hashCode</a></span>()</code> </td> |
| </tr> |
| <tr id="i52" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#hasSubclasses--">hasSubclasses</a></span>()</code> |
| <div class="block">Whether query results will include subclasses of the candidate class.</div> |
| </td> |
| </tr> |
| <tr id="i53" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#isAggregate--">isAggregate</a></span>()</code> |
| <div class="block">Return true if the query is an aggregate.</div> |
| </td> |
| </tr> |
| <tr id="i54" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#isDistinct--">isDistinct</a></span>()</code> |
| <div class="block">Affirms if this query results are distinct instance(s).</div> |
| </td> |
| </tr> |
| <tr id="i55" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#isReadOnly--">isReadOnly</a></span>()</code> |
| <div class="block">Whether the query has been marked read-only.</div> |
| </td> |
| </tr> |
| <tr id="i56" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#isUnique--">isUnique</a></span>()</code> |
| <div class="block">The unique flag.</div> |
| </td> |
| </tr> |
| <tr id="i57" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#lock--">lock</a></span>()</code> |
| <div class="block">Synchronize on the query's internal lock.</div> |
| </td> |
| </tr> |
| <tr id="i58" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#removeAggregateListener-org.apache.openjpa.kernel.exps.AggregateListener-">removeAggregateListener</a></span>(<a href="../../../../org/apache/openjpa/kernel/exps/AggregateListener.html" title="interface in org.apache.openjpa.kernel.exps">AggregateListener</a> listener)</code> |
| <div class="block">Remove an aggregate listener from the query.</div> |
| </td> |
| </tr> |
| <tr id="i59" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#removeFilterListener-org.apache.openjpa.kernel.exps.FilterListener-">removeFilterListener</a></span>(<a href="../../../../org/apache/openjpa/kernel/exps/FilterListener.html" title="interface in org.apache.openjpa.kernel.exps">FilterListener</a> listener)</code> |
| <div class="block">Remove a filter listener from the query.</div> |
| </td> |
| </tr> |
| <tr id="i60" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#setCandidateCollection-java.util.Collection-">setCandidateCollection</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> coll)</code> |
| <div class="block">Set a collection of candidates.</div> |
| </td> |
| </tr> |
| <tr id="i61" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#setCandidateExtent-org.apache.openjpa.kernel.Extent-">setCandidateExtent</a></span>(<a href="../../../../org/apache/openjpa/kernel/Extent.html" title="interface in org.apache.openjpa.kernel">Extent</a> extent)</code> |
| <div class="block">Set the candidate extent.</div> |
| </td> |
| </tr> |
| <tr id="i62" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#setCandidateType-java.lang.Class-boolean-">setCandidateType</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls, |
| boolean subs)</code> |
| <div class="block">Set the candidate type.</div> |
| </td> |
| </tr> |
| <tr id="i63" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#setIgnoreChanges-boolean-">setIgnoreChanges</a></span>(boolean ignore)</code> |
| <div class="block">Whether to ignore changes in the current transaction.</div> |
| </td> |
| </tr> |
| <tr id="i64" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#setQuery-java.lang.Object-">setQuery</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> query)</code> |
| <div class="block">The query string or template.</div> |
| </td> |
| </tr> |
| <tr id="i65" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#setRange-long-long-">setRange</a></span>(long start, |
| long end)</code> |
| <div class="block">Set the range of results to return.</div> |
| </td> |
| </tr> |
| <tr id="i66" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#setReadOnly-boolean-">setReadOnly</a></span>(boolean readOnly)</code> |
| <div class="block">Whether the query has been marked read-only.</div> |
| </td> |
| </tr> |
| <tr id="i67" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#setResultMapping-java.lang.Class-java.lang.String-">setResultMapping</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> scope, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Name and scope of a mapping from the result data to its object |
| representation.</div> |
| </td> |
| </tr> |
| <tr id="i68" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#setResultType-java.lang.Class-">setResultType</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls)</code> |
| <div class="block">Specify the type of object in which the result of evaluating this query.</div> |
| </td> |
| </tr> |
| <tr id="i69" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#setUnique-boolean-">setUnique</a></span>(boolean unique)</code> |
| <div class="block">Specify that the query will return only 1 |
| result, rather than a collection.</div> |
| </td> |
| </tr> |
| <tr id="i70" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#translate-java.lang.RuntimeException-">translate</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a> re)</code> |
| <div class="block">Translate the OpenJPA exception.</div> |
| </td> |
| </tr> |
| <tr id="i71" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#unlock--">unlock</a></span>()</code> |
| <div class="block">Unlock the query's internal lock.</div> |
| </td> |
| </tr> |
| <tr id="i72" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#updateAll--">updateAll</a></span>()</code> |
| <div class="block">Performs an update of the instances that are satisfied by the query.</div> |
| </td> |
| </tr> |
| <tr id="i73" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#updateAll-java.util.Map-">updateAll</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> parameterMap)</code> |
| <div class="block">Performs an update of the instances that are satisfied by the query.</div> |
| </td> |
| </tr> |
| <tr id="i74" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#updateAll-java.lang.Object:A-">updateAll</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[] parameters)</code> |
| <div class="block">Performs an update of the instances that are satisfied by the query.</div> |
| </td> |
| </tr> |
| <tr id="i75" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html#updateInMemory-org.apache.openjpa.kernel.StoreQuery-org.apache.openjpa.kernel.StoreQuery.Executor-java.lang.Object:A-">updateInMemory</a></span>(<a href="../../../../org/apache/openjpa/kernel/StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a> q, |
| <a href="../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel">StoreQuery.Executor</a> ex, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[] params)</code> |
| <div class="block">Helper method to update the objects found by executing a query on |
| the given executor.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="DelegatingQuery-org.apache.openjpa.kernel.Query-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DelegatingQuery</h4> |
| <pre>public DelegatingQuery(<a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a> query)</pre> |
| <div class="block">Constructor; supply delegate.</div> |
| </li> |
| </ul> |
| <a name="DelegatingQuery-org.apache.openjpa.kernel.Query-org.apache.openjpa.util.RuntimeExceptionTranslator-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DelegatingQuery</h4> |
| <pre>public DelegatingQuery(<a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a> query, |
| <a href="../../../../org/apache/openjpa/util/RuntimeExceptionTranslator.html" title="interface in org.apache.openjpa.util">RuntimeExceptionTranslator</a> trans)</pre> |
| <div class="block">Constructor; supply delegate and exception translator.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getDelegate--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDelegate</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a> getDelegate()</pre> |
| <div class="block">Return the direct delegate.</div> |
| </li> |
| </ul> |
| <a name="getInnermostDelegate--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInnermostDelegate</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a> getInnermostDelegate()</pre> |
| <div class="block">Return the native delegate.</div> |
| </li> |
| </ul> |
| <a name="hashCode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre>public int hashCode()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="equals-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre>public boolean equals(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> other)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="translate-java.lang.RuntimeException-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>translate</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a> translate(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a> re)</pre> |
| <div class="block">Translate the OpenJPA exception.</div> |
| </li> |
| </ul> |
| <a name="getBroker--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBroker</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a> getBroker()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#getBroker--">Query</a></code></span></div> |
| <div class="block">The broker that generated this query.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#getBroker--">getBroker</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQuery</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a> getQuery()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getQuery--">QueryContext</a></code></span></div> |
| <div class="block">Return the query for this context. Note that the query will be |
| unavailable in remote contexts, and this method may throw an exception |
| to that effect.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getQuery--">getQuery</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStoreContext--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStoreContext</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a> getStoreContext()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getStoreContext--">QueryContext</a></code></span></div> |
| <div class="block">The persistence context for the query.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getStoreContext--">getStoreContext</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOperation--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOperation</h4> |
| <pre>public int getOperation()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getOperation--">QueryContext</a></code></span></div> |
| <div class="block">Returns the operation that this query will be expected to perform.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getOperation--">getOperation</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/openjpa/kernel/QueryOperations.html" title="interface in org.apache.openjpa.kernel"><code>QueryOperations</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLanguage--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLanguage</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getLanguage()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getLanguage--">QueryContext</a></code></span></div> |
| <div class="block">The query language.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getLanguage--">getLanguage</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFetchConfiguration--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFetchConfiguration</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> getFetchConfiguration()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getFetchConfiguration--">QueryContext</a></code></span></div> |
| <div class="block">Return the fetch configuration for this query.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getFetchConfiguration--">getFetchConfiguration</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getQueryString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueryString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getQueryString()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getQueryString--">QueryContext</a></code></span></div> |
| <div class="block">The query string.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getQueryString--">getQueryString</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getIgnoreChanges--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIgnoreChanges</h4> |
| <pre>public boolean getIgnoreChanges()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getIgnoreChanges--">QueryContext</a></code></span></div> |
| <div class="block">Whether to ignore changes in the current transaction.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getIgnoreChanges--">getIgnoreChanges</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCompilation--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCompilation</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getCompilation()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getCompilation--">QueryContext</a></code></span></div> |
| <div class="block">Return the query's compilation state.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getCompilation--">getCompilation</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAlias--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAlias</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getAlias()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getAlias--">QueryContext</a></code></span></div> |
| <div class="block">If this query is not a projection but places candidate results into a |
| result class under an alias, return that alias.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getAlias--">getAlias</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getProjectionAliases--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProjectionAliases</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getProjectionAliases()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getProjectionAliases--">QueryContext</a></code></span></div> |
| <div class="block">If this query is a projection, return the projection aliases.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getProjectionAliases--">getProjectionAliases</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getProjectionTypes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProjectionTypes</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>[] getProjectionTypes()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getProjectionTypes--">QueryContext</a></code></span></div> |
| <div class="block">If this query is a projection, return the projection types.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getProjectionTypes--">getProjectionTypes</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isAggregate--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAggregate</h4> |
| <pre>public boolean isAggregate()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#isAggregate--">QueryContext</a></code></span></div> |
| <div class="block">Return true if the query is an aggregate.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#isAggregate--">isAggregate</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasGrouping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasGrouping</h4> |
| <pre>public boolean hasGrouping()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#hasGrouping--">QueryContext</a></code></span></div> |
| <div class="block">Return true if the query uses grouping.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#hasGrouping--">hasGrouping</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAccessPathMetaDatas--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAccessPathMetaDatas</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>[] getAccessPathMetaDatas()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getAccessPathMetaDatas--">QueryContext</a></code></span></div> |
| <div class="block">Return the classes that affect this query.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getAccessPathMetaDatas--">getAccessPathMetaDatas</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFilterListener-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFilterListener</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/exps/FilterListener.html" title="interface in org.apache.openjpa.kernel.exps">FilterListener</a> getFilterListener(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tag)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getFilterListener-java.lang.String-">QueryContext</a></code></span></div> |
| <div class="block">Return the filter listener for the given tag, or null.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getFilterListener-java.lang.String-">getFilterListener</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAggregateListener-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAggregateListener</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/exps/AggregateListener.html" title="interface in org.apache.openjpa.kernel.exps">AggregateListener</a> getAggregateListener(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tag)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getAggregateListener-java.lang.String-">QueryContext</a></code></span></div> |
| <div class="block">Return the filter listener for the given tag, or null.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getAggregateListener-java.lang.String-">getAggregateListener</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFilterListeners--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFilterListeners</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> getFilterListeners()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getFilterListeners--">QueryContext</a></code></span></div> |
| <div class="block">The set of filter listeners.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getFilterListeners--">getFilterListeners</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAggregateListeners--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAggregateListeners</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> getAggregateListeners()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getAggregateListeners--">QueryContext</a></code></span></div> |
| <div class="block">The set of aggregate listeners.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getAggregateListeners--">getAggregateListeners</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCandidateCollection--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCandidateCollection</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> getCandidateCollection()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getCandidateCollection--">QueryContext</a></code></span></div> |
| <div class="block">Return the candidate collection, or <code>null</code> if an |
| extent was specified instead of a collection.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getCandidateCollection--">getCandidateCollection</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCandidateType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCandidateType</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> getCandidateType()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getCandidateType--">QueryContext</a></code></span></div> |
| <div class="block">Return the class of the objects that this query will return, |
| or <code>null</code> if this information is not available / not relevant.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getCandidateType--">getCandidateType</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasSubclasses--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasSubclasses</h4> |
| <pre>public boolean hasSubclasses()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#hasSubclasses--">QueryContext</a></code></span></div> |
| <div class="block">Whether query results will include subclasses of the candidate class.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#hasSubclasses--">hasSubclasses</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCandidateType-java.lang.Class-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCandidateType</h4> |
| <pre>public void setCandidateType(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls, |
| boolean subs)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setCandidateType-java.lang.Class-boolean-">QueryContext</a></code></span></div> |
| <div class="block">Set the candidate type.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setCandidateType-java.lang.Class-boolean-">setCandidateType</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isReadOnly--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isReadOnly</h4> |
| <pre>public boolean isReadOnly()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#isReadOnly--">QueryContext</a></code></span></div> |
| <div class="block">Whether the query has been marked read-only.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#isReadOnly--">isReadOnly</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setReadOnly-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setReadOnly</h4> |
| <pre>public void setReadOnly(boolean readOnly)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setReadOnly-boolean-">QueryContext</a></code></span></div> |
| <div class="block">Whether the query has been marked read-only.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setReadOnly-boolean-">setReadOnly</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getResultMappingScope--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResultMappingScope</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> getResultMappingScope()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getResultMappingScope--">QueryContext</a></code></span></div> |
| <div class="block">Scope of a mapping from the result data to its object representation.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getResultMappingScope--">getResultMappingScope</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getResultMappingName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResultMappingName</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getResultMappingName()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getResultMappingName--">QueryContext</a></code></span></div> |
| <div class="block">Name of a mapping from the result data to its object representation.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getResultMappingName--">getResultMappingName</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setResultMapping-java.lang.Class-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setResultMapping</h4> |
| <pre>public void setResultMapping(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> scope, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setResultMapping-java.lang.Class-java.lang.String-">QueryContext</a></code></span></div> |
| <div class="block">Name and scope of a mapping from the result data to its object |
| representation.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setResultMapping-java.lang.Class-java.lang.String-">setResultMapping</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isUnique--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isUnique</h4> |
| <pre>public boolean isUnique()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#isUnique--">QueryContext</a></code></span></div> |
| <div class="block">The unique flag.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#isUnique--">isUnique</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setUnique-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUnique</h4> |
| <pre>public void setUnique(boolean unique)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setUnique-boolean-">QueryContext</a></code></span></div> |
| <div class="block">Specify that the query will return only 1 |
| result, rather than a collection. The execute method will return null |
| if the query result size is 0.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setUnique-boolean-">setUnique</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isDistinct--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDistinct</h4> |
| <pre>public boolean isDistinct()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#isDistinct--">QueryContext</a></code></span></div> |
| <div class="block">Affirms if this query results are distinct instance(s).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#isDistinct--">isDistinct</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getResultType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResultType</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> getResultType()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getResultType--">QueryContext</a></code></span></div> |
| <div class="block">Returns the result class that has been set through |
| <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setResultType-java.lang.Class-"><code>QueryContext.setResultType(java.lang.Class<?>)</code></a>, or null if none.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getResultType--">getResultType</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setResultType-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setResultType</h4> |
| <pre>public void setResultType(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setResultType-java.lang.Class-">QueryContext</a></code></span></div> |
| <div class="block">Specify the type of object in which the result of evaluating this query.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setResultType-java.lang.Class-">setResultType</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStartRange--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStartRange</h4> |
| <pre>public long getStartRange()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getStartRange--">QueryContext</a></code></span></div> |
| <div class="block">Return the 0-based start index for the returned results.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getStartRange--">getStartRange</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEndRange--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEndRange</h4> |
| <pre>public long getEndRange()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getEndRange--">QueryContext</a></code></span></div> |
| <div class="block">Return the 0-based exclusive end index for the returned results, |
| or <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true#MAX_VALUE" title="class or interface in java.lang"><code>Long.MAX_VALUE</code></a> for no limit.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getEndRange--">getEndRange</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRange-long-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRange</h4> |
| <pre>public void setRange(long start, |
| long end)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setRange-long-long-">QueryContext</a></code></span></div> |
| <div class="block">Set the range of results to return.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setRange-long-long-">setRange</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>start</code> - 0-based inclusive start index</dd> |
| <dd><code>end</code> - 0-based exclusive end index, or |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true#MAX_VALUE" title="class or interface in java.lang"><code>Long.MAX_VALUE</code></a> for no limit</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getParameterDeclaration--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParameterDeclaration</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getParameterDeclaration()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getParameterDeclaration--">QueryContext</a></code></span></div> |
| <div class="block">The parameter declaration.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getParameterDeclaration--">getParameterDeclaration</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOrderedParameterTypes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOrderedParameterTypes</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/lib/util/OrderedMap.html" title="class in org.apache.openjpa.lib.util">OrderedMap</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?>> getOrderedParameterTypes()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getOrderedParameterTypes--">QueryContext</a></code></span></div> |
| <div class="block">Return a map of parameter name to type for this query. The returned |
| map will iterate in the order that the parameters were declared or, |
| if they're implicit, used.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getOrderedParameterTypes--">getOrderedParameterTypes</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getParameterTypes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParameterTypes</h4> |
| <pre>public org.apache.commons.collections4.map.LinkedMap getParameterTypes()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getParameterTypes--">QueryContext</a></code></span></div> |
| <div class="block">Return a map of parameter name to type for this query. The returned |
| map will iterate in the order that the parameters were declared or, |
| if they're implicit, used.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getParameterTypes--">getParameterTypes</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getUpdates--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUpdates</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> getUpdates()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getUpdates--">QueryContext</a></code></span></div> |
| <div class="block">If this query is a bulk update, return a map of the |
| <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta"><code>FieldMetaData</code></a>s to <a href="../../../../org/apache/openjpa/kernel/exps/Constant.html" title="interface in org.apache.openjpa.kernel.exps"><code>Constant</code></a>s.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getUpdates--">getUpdates</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="declareParameters-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>declareParameters</h4> |
| <pre>public void declareParameters(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> params)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#declareParameters-java.lang.String-">QueryContext</a></code></span></div> |
| <div class="block">Declared parameters, for query languages that use them.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#declareParameters-java.lang.String-">declareParameters</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="deleteInMemory-org.apache.openjpa.kernel.StoreQuery-org.apache.openjpa.kernel.StoreQuery.Executor-java.lang.Object:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteInMemory</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a> deleteInMemory(<a href="../../../../org/apache/openjpa/kernel/StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a> q, |
| <a href="../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel">StoreQuery.Executor</a> ex, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[] params)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#deleteInMemory-org.apache.openjpa.kernel.StoreQuery-org.apache.openjpa.kernel.StoreQuery.Executor-java.lang.Object:A-">QueryContext</a></code></span></div> |
| <div class="block">Helper method to delete the objects found by executing a query on |
| the given executor.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#deleteInMemory-org.apache.openjpa.kernel.StoreQuery-org.apache.openjpa.kernel.StoreQuery.Executor-java.lang.Object:A-">deleteInMemory</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="updateInMemory-org.apache.openjpa.kernel.StoreQuery-org.apache.openjpa.kernel.StoreQuery.Executor-java.lang.Object:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateInMemory</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a> updateInMemory(<a href="../../../../org/apache/openjpa/kernel/StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a> q, |
| <a href="../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel">StoreQuery.Executor</a> ex, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[] params)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#updateInMemory-org.apache.openjpa.kernel.StoreQuery-org.apache.openjpa.kernel.StoreQuery.Executor-java.lang.Object:A-">QueryContext</a></code></span></div> |
| <div class="block">Helper method to update the objects found by executing a query on |
| the given executor.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#updateInMemory-org.apache.openjpa.kernel.StoreQuery-org.apache.openjpa.kernel.StoreQuery.Executor-java.lang.Object:A-">updateInMemory</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="classForName-java.lang.String-java.lang.String:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>classForName</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> classForName(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] imports)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#classForName-java.lang.String-java.lang.String:A-">QueryContext</a></code></span></div> |
| <div class="block">Helper method to instantiate the class with the given name, taking |
| into account the query's candidate package, automatic imports, and |
| the given imports (if any). Returns null if the type cannot be found.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#classForName-java.lang.String-java.lang.String:A-">classForName</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="lock--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lock</h4> |
| <pre>public void lock()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#lock--">QueryContext</a></code></span></div> |
| <div class="block">Synchronize on the query's internal lock.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#lock--">lock</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="unlock--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unlock</h4> |
| <pre>public void unlock()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#unlock--">QueryContext</a></code></span></div> |
| <div class="block">Unlock the query's internal lock.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#unlock--">unlock</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addFilterListener-org.apache.openjpa.kernel.exps.FilterListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFilterListener</h4> |
| <pre>public void addFilterListener(<a href="../../../../org/apache/openjpa/kernel/exps/FilterListener.html" title="interface in org.apache.openjpa.kernel.exps">FilterListener</a> listener)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#addFilterListener-org.apache.openjpa.kernel.exps.FilterListener-">Query</a></code></span></div> |
| <div class="block">Register a filter listener for the query.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#addFilterListener-org.apache.openjpa.kernel.exps.FilterListener-">addFilterListener</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeFilterListener-org.apache.openjpa.kernel.exps.FilterListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeFilterListener</h4> |
| <pre>public void removeFilterListener(<a href="../../../../org/apache/openjpa/kernel/exps/FilterListener.html" title="interface in org.apache.openjpa.kernel.exps">FilterListener</a> listener)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#removeFilterListener-org.apache.openjpa.kernel.exps.FilterListener-">Query</a></code></span></div> |
| <div class="block">Remove a filter listener from the query.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#removeFilterListener-org.apache.openjpa.kernel.exps.FilterListener-">removeFilterListener</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addAggregateListener-org.apache.openjpa.kernel.exps.AggregateListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addAggregateListener</h4> |
| <pre>public void addAggregateListener(<a href="../../../../org/apache/openjpa/kernel/exps/AggregateListener.html" title="interface in org.apache.openjpa.kernel.exps">AggregateListener</a> listener)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#addAggregateListener-org.apache.openjpa.kernel.exps.AggregateListener-">Query</a></code></span></div> |
| <div class="block">Register an aggregate listener for the query.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#addAggregateListener-org.apache.openjpa.kernel.exps.AggregateListener-">addAggregateListener</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeAggregateListener-org.apache.openjpa.kernel.exps.AggregateListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeAggregateListener</h4> |
| <pre>public void removeAggregateListener(<a href="../../../../org/apache/openjpa/kernel/exps/AggregateListener.html" title="interface in org.apache.openjpa.kernel.exps">AggregateListener</a> listener)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#removeAggregateListener-org.apache.openjpa.kernel.exps.AggregateListener-">Query</a></code></span></div> |
| <div class="block">Remove an aggregate listener from the query.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#removeAggregateListener-org.apache.openjpa.kernel.exps.AggregateListener-">removeAggregateListener</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCandidateExtent--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCandidateExtent</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/Extent.html" title="interface in org.apache.openjpa.kernel">Extent</a> getCandidateExtent()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#getCandidateExtent--">Query</a></code></span></div> |
| <div class="block">Return the candidate extent, or <code>null</code> if a |
| collection was specified instead of an extent.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#getCandidateExtent--">getCandidateExtent</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCandidateExtent-org.apache.openjpa.kernel.Extent-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCandidateExtent</h4> |
| <pre>public void setCandidateExtent(<a href="../../../../org/apache/openjpa/kernel/Extent.html" title="interface in org.apache.openjpa.kernel">Extent</a> extent)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#setCandidateExtent-org.apache.openjpa.kernel.Extent-">Query</a></code></span></div> |
| <div class="block">Set the candidate extent.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#setCandidateExtent-org.apache.openjpa.kernel.Extent-">setCandidateExtent</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCandidateCollection-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCandidateCollection</h4> |
| <pre>public void setCandidateCollection(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> coll)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#setCandidateCollection-java.util.Collection-">Query</a></code></span></div> |
| <div class="block">Set a collection of candidates.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#setCandidateCollection-java.util.Collection-">setCandidateCollection</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="compile--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>compile</h4> |
| <pre>public void compile()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#compile--">Query</a></code></span></div> |
| <div class="block">Compile the query.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#compile--">compile</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="execute--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> execute()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#execute--">Query</a></code></span></div> |
| <div class="block">Execute.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#execute--">execute</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="execute-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> execute(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> params)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#execute-java.util.Map-">Query</a></code></span></div> |
| <div class="block">Execute with parameter map.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#execute-java.util.Map-">execute</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="execute-java.lang.Object:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> execute(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[] params)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#execute-java.lang.Object:A-">Query</a></code></span></div> |
| <div class="block">Execute with parameter array.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#execute-java.lang.Object:A-">execute</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="deleteAll--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteAll</h4> |
| <pre>public long deleteAll()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#deleteAll--">Query</a></code></span></div> |
| <div class="block">Deletes all of the instances that are satisfied by the query.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#deleteAll--">deleteAll</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of instances that were deleted</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="deleteAll-java.lang.Object:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteAll</h4> |
| <pre>public long deleteAll(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[] parameters)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#deleteAll-java.lang.Object:A-">Query</a></code></span></div> |
| <div class="block">Deletes all of the instances that are satisfied by the query.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#deleteAll-java.lang.Object:A-">deleteAll</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| <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 name="deleteAll-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteAll</h4> |
| <pre>public long deleteAll(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> parameterMap)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#deleteAll-java.util.Map-">Query</a></code></span></div> |
| <div class="block">Deletes all of the instances that are satisfied by the query.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#deleteAll-java.util.Map-">deleteAll</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| <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 name="updateAll--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateAll</h4> |
| <pre>public long updateAll()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#updateAll--">Query</a></code></span></div> |
| <div class="block">Performs an update of the instances that are satisfied by the query.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#updateAll--">updateAll</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of instances that were update</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="updateAll-java.lang.Object:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateAll</h4> |
| <pre>public long updateAll(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[] parameters)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#updateAll-java.lang.Object:A-">Query</a></code></span></div> |
| <div class="block">Performs an update of the instances that are satisfied by the query.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#updateAll-java.lang.Object:A-">updateAll</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| <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 name="updateAll-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateAll</h4> |
| <pre>public long updateAll(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> parameterMap)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#updateAll-java.util.Map-">Query</a></code></span></div> |
| <div class="block">Performs an update of the instances that are satisfied by the query.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#updateAll-java.util.Map-">updateAll</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| <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 name="closeAll--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>closeAll</h4> |
| <pre>public void closeAll()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#closeAll--">Query</a></code></span></div> |
| <div class="block">Close all open query results.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#closeAll--">closeAll</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="closeResources--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>closeResources</h4> |
| <pre>public void closeResources()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#closeResources--">Query</a></code></span></div> |
| <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> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#closeResources--">closeResources</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDataStoreActions-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDataStoreActions</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getDataStoreActions(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> params)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#getDataStoreActions-java.util.Map-">Query</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#getDataStoreActions-java.util.Map-">getDataStoreActions</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>params</code> - the named parameter map for the query invocation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setQuery-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setQuery</h4> |
| <pre>public boolean setQuery(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> query)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#setQuery-java.lang.Object-">Query</a></code></span></div> |
| <div class="block">The query string or template.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#setQuery-java.lang.Object-">setQuery</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setIgnoreChanges-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIgnoreChanges</h4> |
| <pre>public void setIgnoreChanges(boolean ignore)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#setIgnoreChanges-boolean-">Query</a></code></span></div> |
| <div class="block">Whether to ignore changes in the current transaction.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#setIgnoreChanges-boolean-">setIgnoreChanges</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="assertOpen--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assertOpen</h4> |
| <pre>public void assertOpen()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#assertOpen--">Query</a></code></span></div> |
| <div class="block">Assert that the query's broker is still open.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#assertOpen--">assertOpen</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="assertNotReadOnly--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assertNotReadOnly</h4> |
| <pre>public void assertNotReadOnly()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#assertNotReadOnly--">Query</a></code></span></div> |
| <div class="block">Assert that the query is not read-only.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#assertNotReadOnly--">assertNotReadOnly</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="assertNotSerialized--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>assertNotSerialized</h4> |
| <pre>public void assertNotSerialized()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#assertNotSerialized--">Query</a></code></span></div> |
| <div class="block">Check that the query has not been serialized, which causes it to lose |
| its association with its Broker.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#assertNotSerialized--">assertNotSerialized</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/DelegatingQuery.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"> |
| <li><a href="../../../../org/apache/openjpa/kernel/DelegatingFetchConfiguration.html" title="class in org.apache.openjpa.kernel"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/kernel/DelegatingResultList.html" title="class in org.apache.openjpa.kernel"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/kernel/DelegatingQuery.html" target="_top">Frames</a></li> |
| <li><a href="DelegatingQuery.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2006–2020 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |