| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>QueryContext (OpenJPA Parent POM 4.1.1 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.7.1.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="QueryContext (OpenJPA Parent POM 4.1.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":38,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6,"i37":6,"i38":6,"i39":6,"i40":6,"i41":6,"i42":6,"i43":6,"i44":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/QueryContext.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.openjpa.kernel</a></div> |
| <h2 title="Interface QueryContext" class="title">Interface QueryContext</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="DelegatingQuery.html" title="class in org.apache.openjpa.kernel">DelegatingQuery</a></code>, <code><a href="../slice/DistributedQueryImpl.html" title="class in org.apache.openjpa.slice">DistributedQueryImpl</a></code>, <code><a href="QueryImpl.html" title="class in org.apache.openjpa.kernel">QueryImpl</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">QueryContext</span></pre> |
| <div class="block">A query execution context.</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> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#classForName(java.lang.String,java.lang.String%5B%5D)">classForName</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[] imports)</code></th> |
| <td class="colLast"> |
| <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="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#declareParameters(java.lang.String)">declareParameters</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> params)</code></th> |
| <td class="colLast"> |
| <div class="block">Declared parameters, for query languages that use them.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Number.html?is-external=true" title="class or interface in java.lang" class="externalLink">Number</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteInMemory(org.apache.openjpa.kernel.StoreQuery,org.apache.openjpa.kernel.StoreQuery.Executor,java.lang.Object%5B%5D)">deleteInMemory</a></span>​(<a href="StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a> q, |
| <a href="StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel">StoreQuery.Executor</a> ex, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>[] params)</code></th> |
| <td class="colLast"> |
| <div class="block">Helper method to delete the objects found by executing a query on |
| the given executor.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAccessPathMetaDatas()">getAccessPathMetaDatas</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the classes that affect this query.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="exps/AggregateListener.html" title="interface in org.apache.openjpa.kernel.exps">AggregateListener</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAggregateListener(java.lang.String)">getAggregateListener</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> tag)</code></th> |
| <td class="colLast"> |
| <div class="block">Return the filter listener for the given tag, or null.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="exps/AggregateListener.html" title="interface in org.apache.openjpa.kernel.exps">AggregateListener</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAggregateListeners()">getAggregateListeners</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The set of aggregate listeners.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAlias()">getAlias</a></span>()</code></th> |
| <td class="colLast"> |
| <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="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><?></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCandidateCollection()">getCandidateCollection</a></span>()</code></th> |
| <td class="colLast"> |
| <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="i8" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCandidateType()">getCandidateType</a></span>()</code></th> |
| <td class="colLast"> |
| <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="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCompilation()">getCompilation</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the query's compilation state.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEndRange()">getEndRange</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the 0-based exclusive end index for the returned results, |
| or <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Long.html?is-external=true#MAX_VALUE" title="class or interface in java.lang" class="externalLink"><code>Long.MAX_VALUE</code></a> for no limit.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFetchConfiguration()">getFetchConfiguration</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the fetch configuration for this query.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="exps/FilterListener.html" title="interface in org.apache.openjpa.kernel.exps">FilterListener</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFilterListener(java.lang.String)">getFilterListener</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> tag)</code></th> |
| <td class="colLast"> |
| <div class="block">Return the filter listener for the given tag, or null.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="exps/FilterListener.html" title="interface in org.apache.openjpa.kernel.exps">FilterListener</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFilterListeners()">getFilterListeners</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The set of filter listeners.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIgnoreChanges()">getIgnoreChanges</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Whether to ignore changes in the current transaction.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLanguage()">getLanguage</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The query language.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOperation()">getOperation</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the operation that this query will be expected to perform.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="../lib/util/OrderedMap.html" title="class in org.apache.openjpa.lib.util">OrderedMap</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>,​<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOrderedParameterTypes()">getOrderedParameterTypes</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return a map of parameter name to type for this query.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParameterDeclaration()">getParameterDeclaration</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The parameter declaration.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../lib/util/collections/LinkedMap.html" title="class in org.apache.openjpa.lib.util.collections">LinkedMap</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParameterTypes()">getParameterTypes</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProjectionAliases()">getProjectionAliases</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">If this query is a projection, return the projection aliases.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProjectionTypes()">getProjectionTypes</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">If this query is a projection, return the projection types.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQuery()">getQuery</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the query for this context.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQueryString()">getQueryString</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The query string.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResultMappingName()">getResultMappingName</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Name of a mapping from the result data to its object representation.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResultMappingScope()">getResultMappingScope</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Scope of a mapping from the result data to its object representation.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResultType()">getResultType</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the result class that has been set through |
| <a href="#setResultType(java.lang.Class)"><code>setResultType(java.lang.Class<?>)</code></a>, or null if none.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStartRange()">getStartRange</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the 0-based start index for the returned results.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStoreContext()">getStoreContext</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The persistence context for the query.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="../meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>,​<a href="exps/Value.html" title="interface in org.apache.openjpa.kernel.exps">Value</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUpdates()">getUpdates</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">If this query is a bulk update, return a map of the |
| <a href="../meta/FieldMetaData.html" title="class in org.apache.openjpa.meta"><code>FieldMetaData</code></a>s to <a href="exps/Constant.html" title="interface in org.apache.openjpa.kernel.exps"><code>Constant</code></a>s.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasGrouping()">hasGrouping</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return true if the query uses grouping.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasSubclasses()">hasSubclasses</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Whether query results will include subclasses of the candidate class.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAggregate()">isAggregate</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return true if the query is an aggregate.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isDistinct()">isDistinct</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Affirms if this query results are distinct instance(s).</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isReadOnly()">isReadOnly</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Whether the query has been marked read-only.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isUnique()">isUnique</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The unique flag.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#lock()">lock</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Synchronize on the query's internal lock.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCandidateType(java.lang.Class,boolean)">setCandidateType</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> cls, |
| boolean subs)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the candidate type.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRange(long,long)">setRange</a></span>​(long start, |
| long end)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the range of results to return.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setReadOnly(boolean)">setReadOnly</a></span>​(boolean readOnly)</code></th> |
| <td class="colLast"> |
| <div class="block">Whether the query has been marked read-only.</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setResultMapping(java.lang.Class,java.lang.String)">setResultMapping</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> scope, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Name and scope of a mapping from the result data to its object |
| representation.</div> |
| </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setResultType(java.lang.Class)">setResultType</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> cls)</code></th> |
| <td class="colLast"> |
| <div class="block">Specify the type of object in which the result of evaluating this query.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setUnique(boolean)">setUnique</a></span>​(boolean unique)</code></th> |
| <td class="colLast"> |
| <div class="block">Specify that the query will return only 1 |
| result, rather than a collection.</div> |
| </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unlock()">unlock</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Unlock the query's internal lock.</div> |
| </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Number.html?is-external=true" title="class or interface in java.lang" class="externalLink">Number</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateInMemory(org.apache.openjpa.kernel.StoreQuery,org.apache.openjpa.kernel.StoreQuery.Executor,java.lang.Object%5B%5D)">updateInMemory</a></span>​(<a href="StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a> q, |
| <a href="StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel">StoreQuery.Executor</a> ex, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>[] params)</code></th> |
| <td class="colLast"> |
| <div class="block">Helper method to update the objects found by executing a query on |
| the given executor.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getQuery()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQuery</h4> |
| <pre class="methodSignature"><a href="Query.html" title="interface in org.apache.openjpa.kernel">Query</a> getQuery()</pre> |
| <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> |
| </li> |
| </ul> |
| <a id="getStoreContext()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStoreContext</h4> |
| <pre class="methodSignature"><a href="StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a> getStoreContext()</pre> |
| <div class="block">The persistence context for the query.</div> |
| </li> |
| </ul> |
| <a id="getFetchConfiguration()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFetchConfiguration</h4> |
| <pre class="methodSignature"><a href="FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> getFetchConfiguration()</pre> |
| <div class="block">Return the fetch configuration for this query.</div> |
| </li> |
| </ul> |
| <a id="getOperation()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOperation</h4> |
| <pre class="methodSignature">int getOperation()</pre> |
| <div class="block">Returns the operation that this query will be expected to perform.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.4.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="QueryOperations.html" title="interface in org.apache.openjpa.kernel"><code>QueryOperations</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getLanguage()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLanguage</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getLanguage()</pre> |
| <div class="block">The query language.</div> |
| </li> |
| </ul> |
| <a id="getQueryString()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueryString</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getQueryString()</pre> |
| <div class="block">The query string.</div> |
| </li> |
| </ul> |
| <a id="getCandidateCollection()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCandidateCollection</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><?> getCandidateCollection()</pre> |
| <div class="block">Return the candidate collection, or <code>null</code> if an |
| extent was specified instead of a collection.</div> |
| </li> |
| </ul> |
| <a id="getCandidateType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCandidateType</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> getCandidateType()</pre> |
| <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> |
| </li> |
| </ul> |
| <a id="hasSubclasses()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasSubclasses</h4> |
| <pre class="methodSignature">boolean hasSubclasses()</pre> |
| <div class="block">Whether query results will include subclasses of the candidate class.</div> |
| </li> |
| </ul> |
| <a id="setCandidateType(java.lang.Class,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCandidateType</h4> |
| <pre class="methodSignature">void setCandidateType​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> cls, |
| boolean subs)</pre> |
| <div class="block">Set the candidate type.</div> |
| </li> |
| </ul> |
| <a id="isReadOnly()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isReadOnly</h4> |
| <pre class="methodSignature">boolean isReadOnly()</pre> |
| <div class="block">Whether the query has been marked read-only.</div> |
| </li> |
| </ul> |
| <a id="setReadOnly(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setReadOnly</h4> |
| <pre class="methodSignature">void setReadOnly​(boolean readOnly)</pre> |
| <div class="block">Whether the query has been marked read-only.</div> |
| </li> |
| </ul> |
| <a id="isUnique()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isUnique</h4> |
| <pre class="methodSignature">boolean isUnique()</pre> |
| <div class="block">The unique flag.</div> |
| </li> |
| </ul> |
| <a id="setUnique(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUnique</h4> |
| <pre class="methodSignature">void setUnique​(boolean unique)</pre> |
| <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="simpleTagLabel">Since:</span></dt> |
| <dd>0.3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isDistinct()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDistinct</h4> |
| <pre class="methodSignature">boolean isDistinct()</pre> |
| <div class="block">Affirms if this query results are distinct instance(s).</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getResultMappingScope()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResultMappingScope</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> getResultMappingScope()</pre> |
| <div class="block">Scope of a mapping from the result data to its object representation.</div> |
| </li> |
| </ul> |
| <a id="getResultMappingName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResultMappingName</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getResultMappingName()</pre> |
| <div class="block">Name of a mapping from the result data to its object representation.</div> |
| </li> |
| </ul> |
| <a id="setResultMapping(java.lang.Class,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setResultMapping</h4> |
| <pre class="methodSignature">void setResultMapping​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> scope, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</pre> |
| <div class="block">Name and scope of a mapping from the result data to its object |
| representation.</div> |
| </li> |
| </ul> |
| <a id="getResultType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResultType</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> getResultType()</pre> |
| <div class="block">Returns the result class that has been set through |
| <a href="#setResultType(java.lang.Class)"><code>setResultType(java.lang.Class<?>)</code></a>, or null if none.</div> |
| </li> |
| </ul> |
| <a id="setResultType(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setResultType</h4> |
| <pre class="methodSignature">void setResultType​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> cls)</pre> |
| <div class="block">Specify the type of object in which the result of evaluating this query.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getStartRange()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStartRange</h4> |
| <pre class="methodSignature">long getStartRange()</pre> |
| <div class="block">Return the 0-based start index for the returned results.</div> |
| </li> |
| </ul> |
| <a id="getEndRange()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEndRange</h4> |
| <pre class="methodSignature">long getEndRange()</pre> |
| <div class="block">Return the 0-based exclusive end index for the returned results, |
| or <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Long.html?is-external=true#MAX_VALUE" title="class or interface in java.lang" class="externalLink"><code>Long.MAX_VALUE</code></a> for no limit.</div> |
| </li> |
| </ul> |
| <a id="setRange(long,long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRange</h4> |
| <pre class="methodSignature">void setRange​(long start, |
| long end)</pre> |
| <div class="block">Set the range of results to return.</div> |
| <dl> |
| <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/en/java/javase/11/docs/api/java.base/java/lang/Long.html?is-external=true#MAX_VALUE" title="class or interface in java.lang" class="externalLink"><code>Long.MAX_VALUE</code></a> for no limit</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.3.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getParameterDeclaration()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParameterDeclaration</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getParameterDeclaration()</pre> |
| <div class="block">The parameter declaration.</div> |
| </li> |
| </ul> |
| <a id="declareParameters(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>declareParameters</h4> |
| <pre class="methodSignature">void declareParameters​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> params)</pre> |
| <div class="block">Declared parameters, for query languages that use them.</div> |
| </li> |
| </ul> |
| <a id="getOrderedParameterTypes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOrderedParameterTypes</h4> |
| <pre class="methodSignature"><a href="../lib/util/OrderedMap.html" title="class in org.apache.openjpa.lib.util">OrderedMap</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>,​<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?>> getOrderedParameterTypes()</pre> |
| <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> |
| </li> |
| </ul> |
| <a id="getParameterTypes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParameterTypes</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| <a href="../lib/util/collections/LinkedMap.html" title="class in org.apache.openjpa.lib.util.collections">LinkedMap</a> getParameterTypes()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</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> |
| </li> |
| </ul> |
| <a id="getUpdates()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUpdates</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="../meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>,​<a href="exps/Value.html" title="interface in org.apache.openjpa.kernel.exps">Value</a>> getUpdates()</pre> |
| <div class="block">If this query is a bulk update, return a map of the |
| <a href="../meta/FieldMetaData.html" title="class in org.apache.openjpa.meta"><code>FieldMetaData</code></a>s to <a href="exps/Constant.html" title="interface in org.apache.openjpa.kernel.exps"><code>Constant</code></a>s.</div> |
| </li> |
| </ul> |
| <a id="getIgnoreChanges()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIgnoreChanges</h4> |
| <pre class="methodSignature">boolean getIgnoreChanges()</pre> |
| <div class="block">Whether to ignore changes in the current transaction.</div> |
| </li> |
| </ul> |
| <a id="getCompilation()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCompilation</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> getCompilation()</pre> |
| <div class="block">Return the query's compilation state.</div> |
| </li> |
| </ul> |
| <a id="getAlias()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAlias</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getAlias()</pre> |
| <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> |
| </li> |
| </ul> |
| <a id="getProjectionAliases()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProjectionAliases</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[] getProjectionAliases()</pre> |
| <div class="block">If this query is a projection, return the projection aliases.</div> |
| </li> |
| </ul> |
| <a id="getProjectionTypes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProjectionTypes</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?>[] getProjectionTypes()</pre> |
| <div class="block">If this query is a projection, return the projection types.</div> |
| </li> |
| </ul> |
| <a id="isAggregate()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAggregate</h4> |
| <pre class="methodSignature">boolean isAggregate()</pre> |
| <div class="block">Return true if the query is an aggregate.</div> |
| </li> |
| </ul> |
| <a id="hasGrouping()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasGrouping</h4> |
| <pre class="methodSignature">boolean hasGrouping()</pre> |
| <div class="block">Return true if the query uses grouping.</div> |
| </li> |
| </ul> |
| <a id="getAccessPathMetaDatas()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAccessPathMetaDatas</h4> |
| <pre class="methodSignature"><a href="../meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>[] getAccessPathMetaDatas()</pre> |
| <div class="block">Return the classes that affect this query.</div> |
| </li> |
| </ul> |
| <a id="getFilterListener(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFilterListener</h4> |
| <pre class="methodSignature"><a href="exps/FilterListener.html" title="interface in org.apache.openjpa.kernel.exps">FilterListener</a> getFilterListener​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> tag)</pre> |
| <div class="block">Return the filter listener for the given tag, or null.</div> |
| </li> |
| </ul> |
| <a id="getAggregateListener(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAggregateListener</h4> |
| <pre class="methodSignature"><a href="exps/AggregateListener.html" title="interface in org.apache.openjpa.kernel.exps">AggregateListener</a> getAggregateListener​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> tag)</pre> |
| <div class="block">Return the filter listener for the given tag, or null.</div> |
| </li> |
| </ul> |
| <a id="getFilterListeners()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFilterListeners</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="exps/FilterListener.html" title="interface in org.apache.openjpa.kernel.exps">FilterListener</a>> getFilterListeners()</pre> |
| <div class="block">The set of filter listeners.</div> |
| </li> |
| </ul> |
| <a id="getAggregateListeners()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAggregateListeners</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="exps/AggregateListener.html" title="interface in org.apache.openjpa.kernel.exps">AggregateListener</a>> getAggregateListeners()</pre> |
| <div class="block">The set of aggregate listeners.</div> |
| </li> |
| </ul> |
| <a id="deleteInMemory(org.apache.openjpa.kernel.StoreQuery,org.apache.openjpa.kernel.StoreQuery.Executor,java.lang.Object[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteInMemory</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Number.html?is-external=true" title="class or interface in java.lang" class="externalLink">Number</a> deleteInMemory​(<a href="StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a> q, |
| <a href="StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel">StoreQuery.Executor</a> ex, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>[] params)</pre> |
| <div class="block">Helper method to delete the objects found by executing a query on |
| the given executor.</div> |
| </li> |
| </ul> |
| <a id="updateInMemory(org.apache.openjpa.kernel.StoreQuery,org.apache.openjpa.kernel.StoreQuery.Executor,java.lang.Object[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateInMemory</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Number.html?is-external=true" title="class or interface in java.lang" class="externalLink">Number</a> updateInMemory​(<a href="StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a> q, |
| <a href="StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel">StoreQuery.Executor</a> ex, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>[] params)</pre> |
| <div class="block">Helper method to update the objects found by executing a query on |
| the given executor.</div> |
| </li> |
| </ul> |
| <a id="classForName(java.lang.String,java.lang.String[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>classForName</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> classForName​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[] imports)</pre> |
| <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> |
| </li> |
| </ul> |
| <a id="lock()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lock</h4> |
| <pre class="methodSignature">void lock()</pre> |
| <div class="block">Synchronize on the query's internal lock.</div> |
| </li> |
| </ul> |
| <a id="unlock()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>unlock</h4> |
| <pre class="methodSignature">void unlock()</pre> |
| <div class="block">Unlock the query's internal lock.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/QueryContext.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2006–2025 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
