| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="it"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_80) on Thu Jun 14 10:03:59 CEST 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Query (OpenJPA Parent POM 2.4.3 API)</title> |
| <meta name="date" content="2018-06-14"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Query (OpenJPA Parent POM 2.4.3 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/Query.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/openjpa/kernel/PreparedQueryCache.Exclusion.html" title="interface in org.apache.openjpa.kernel"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/kernel/Query.html" target="_top">Frames</a></li> |
| <li><a href="Query.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>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 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="Interface Query" class="title">Interface Query</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><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>, <a href="http://docs.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/openjpa/kernel/DelegatingQuery.html" title="class in org.apache.openjpa.kernel">DelegatingQuery</a>, <a href="../../../../org/apache/openjpa/slice/DistributedQueryImpl.html" title="class in org.apache.openjpa.slice">DistributedQueryImpl</a>, <a href="../../../../org/apache/openjpa/kernel/QueryImpl.html" title="class in org.apache.openjpa.kernel">QueryImpl</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">Query</span> |
| extends <a href="http://docs.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a>, <a href="../../../../org/apache/openjpa/kernel/QueryOperations.html" title="interface in org.apache.openjpa.kernel">QueryOperations</a>, <a href="../../../../org/apache/openjpa/kernel/QueryFlushModes.html" title="interface in org.apache.openjpa.kernel">QueryFlushModes</a></pre> |
| <div class="block">OpenJPA query interface.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>0.3.0</dd> |
| <dt><span class="strong">Author:</span></dt> |
| <dd>Patrick Linskey, Abe White</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> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/Query.html#addAggregateListener(org.apache.openjpa.kernel.exps.AggregateListener)">addAggregateListener</a></strong>(<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 class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/Query.html#addFilterListener(org.apache.openjpa.kernel.exps.FilterListener)">addFilterListener</a></strong>(<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 class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/Query.html#assertNotReadOnly()">assertNotReadOnly</a></strong>()</code> |
| <div class="block">Assert that the query is not read-only.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/Query.html#assertNotSerialized()">assertNotSerialized</a></strong>()</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 class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/Query.html#assertOpen()">assertOpen</a></strong>()</code> |
| <div class="block">Assert that the query's broker is still open.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/Query.html#closeAll()">closeAll</a></strong>()</code> |
| <div class="block">Close all open query results.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/Query.html#closeResources()">closeResources</a></strong>()</code> |
| <div class="block">Close query results that are consuming resources.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/Query.html#compile()">compile</a></strong>()</code> |
| <div class="block">Compile the query.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/Query.html#deleteAll()">deleteAll</a></strong>()</code> |
| <div class="block">Deletes all of the instances that are satisfied by the query.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/Query.html#deleteAll(java.util.Map)">deleteAll</a></strong>(<a href="http://docs.oracle.com/javase/6/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 class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/Query.html#deleteAll(java.lang.Object[])">deleteAll</a></strong>(<a href="http://docs.oracle.com/javase/6/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 class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/Query.html#execute()">execute</a></strong>()</code> |
| <div class="block">Execute.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/Query.html#execute(java.util.Map)">execute</a></strong>(<a href="http://docs.oracle.com/javase/6/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 class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/Query.html#execute(java.lang.Object[])">execute</a></strong>(<a href="http://docs.oracle.com/javase/6/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 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><strong><a href="../../../../org/apache/openjpa/kernel/Query.html#getBroker()">getBroker</a></strong>()</code> |
| <div class="block">The broker that generated this query.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <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><strong><a href="../../../../org/apache/openjpa/kernel/Query.html#getCandidateExtent()">getCandidateExtent</a></strong>()</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 class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/Query.html#getDataStoreActions(java.util.Map)">getDataStoreActions</a></strong>(<a href="http://docs.oracle.com/javase/6/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 class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/Query.html#removeAggregateListener(org.apache.openjpa.kernel.exps.AggregateListener)">removeAggregateListener</a></strong>(<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 class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/Query.html#removeFilterListener(org.apache.openjpa.kernel.exps.FilterListener)">removeFilterListener</a></strong>(<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 class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/Query.html#setCandidateCollection(java.util.Collection)">setCandidateCollection</a></strong>(<a href="http://docs.oracle.com/javase/6/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 class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/Query.html#setCandidateExtent(org.apache.openjpa.kernel.Extent)">setCandidateExtent</a></strong>(<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 class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/Query.html#setIgnoreChanges(boolean)">setIgnoreChanges</a></strong>(boolean ignore)</code> |
| <div class="block">Whether to ignore changes in the current transaction.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/Query.html#setQuery(java.lang.Object)">setQuery</a></strong>(<a href="http://docs.oracle.com/javase/6/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 class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/Query.html#updateAll()">updateAll</a></strong>()</code> |
| <div class="block">Performs an update of the instances that are satisfied by the query.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/Query.html#updateAll(java.util.Map)">updateAll</a></strong>(<a href="http://docs.oracle.com/javase/6/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 class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/Query.html#updateAll(java.lang.Object[])">updateAll</a></strong>(<a href="http://docs.oracle.com/javase/6/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> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.openjpa.kernel.QueryContext"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.openjpa.kernel.<a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></h3> |
| <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#classForName(java.lang.String,%20java.lang.String[])">classForName</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#declareParameters(java.lang.String)">declareParameters</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#deleteInMemory(org.apache.openjpa.kernel.StoreQuery,%20org.apache.openjpa.kernel.StoreQuery.Executor,%20java.lang.Object[])">deleteInMemory</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getAccessPathMetaDatas()">getAccessPathMetaDatas</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getAggregateListener(java.lang.String)">getAggregateListener</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getAggregateListeners()">getAggregateListeners</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getAlias()">getAlias</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getCandidateCollection()">getCandidateCollection</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getCandidateType()">getCandidateType</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getCompilation()">getCompilation</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getEndRange()">getEndRange</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getFetchConfiguration()">getFetchConfiguration</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getFilterListener(java.lang.String)">getFilterListener</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getFilterListeners()">getFilterListeners</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getIgnoreChanges()">getIgnoreChanges</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getLanguage()">getLanguage</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getOperation()">getOperation</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getOrderedParameterTypes()">getOrderedParameterTypes</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getParameterDeclaration()">getParameterDeclaration</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getParameterTypes()">getParameterTypes</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getProjectionAliases()">getProjectionAliases</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getProjectionTypes()">getProjectionTypes</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getQuery()">getQuery</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getQueryString()">getQueryString</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getResultMappingName()">getResultMappingName</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getResultMappingScope()">getResultMappingScope</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getResultType()">getResultType</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getStartRange()">getStartRange</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getStoreContext()">getStoreContext</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getUpdates()">getUpdates</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#hasGrouping()">hasGrouping</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#hasSubclasses()">hasSubclasses</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#isAggregate()">isAggregate</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#isDistinct()">isDistinct</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#isReadOnly()">isReadOnly</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#isUnique()">isUnique</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#lock()">lock</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setCandidateType(java.lang.Class,%20boolean)">setCandidateType</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setRange(long,%20long)">setRange</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setReadOnly(boolean)">setReadOnly</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setResultMapping(java.lang.Class,%20java.lang.String)">setResultMapping</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setResultType(java.lang.Class)">setResultType</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setUnique(boolean)">setUnique</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#unlock()">unlock</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#updateInMemory(org.apache.openjpa.kernel.StoreQuery,%20org.apache.openjpa.kernel.StoreQuery.Executor,%20java.lang.Object[])">updateInMemory</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getBroker()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBroker</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a> getBroker()</pre> |
| <div class="block">The broker that generated this query.</div> |
| </li> |
| </ul> |
| <a name="setQuery(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setQuery</h4> |
| <pre>boolean setQuery(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> query)</pre> |
| <div class="block">The query string or template.</div> |
| </li> |
| </ul> |
| <a name="setIgnoreChanges(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIgnoreChanges</h4> |
| <pre>void setIgnoreChanges(boolean ignore)</pre> |
| <div class="block">Whether to ignore changes in the current transaction.</div> |
| </li> |
| </ul> |
| <a name="addFilterListener(org.apache.openjpa.kernel.exps.FilterListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFilterListener</h4> |
| <pre>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">Register a filter listener for the query.</div> |
| </li> |
| </ul> |
| <a name="removeFilterListener(org.apache.openjpa.kernel.exps.FilterListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeFilterListener</h4> |
| <pre>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">Remove a filter listener from the query.</div> |
| </li> |
| </ul> |
| <a name="addAggregateListener(org.apache.openjpa.kernel.exps.AggregateListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addAggregateListener</h4> |
| <pre>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">Register an aggregate listener for the query.</div> |
| </li> |
| </ul> |
| <a name="removeAggregateListener(org.apache.openjpa.kernel.exps.AggregateListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeAggregateListener</h4> |
| <pre>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">Remove an aggregate listener from the query.</div> |
| </li> |
| </ul> |
| <a name="getCandidateExtent()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCandidateExtent</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/Extent.html" title="interface in org.apache.openjpa.kernel">Extent</a> getCandidateExtent()</pre> |
| <div class="block">Return the candidate extent, or <code>null</code> if a |
| collection was specified instead of an extent.</div> |
| </li> |
| </ul> |
| <a name="setCandidateExtent(org.apache.openjpa.kernel.Extent)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCandidateExtent</h4> |
| <pre>void setCandidateExtent(<a href="../../../../org/apache/openjpa/kernel/Extent.html" title="interface in org.apache.openjpa.kernel">Extent</a> extent)</pre> |
| <div class="block">Set the candidate extent.</div> |
| </li> |
| </ul> |
| <a name="setCandidateCollection(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCandidateCollection</h4> |
| <pre>void setCandidateCollection(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><?> coll)</pre> |
| <div class="block">Set a collection of candidates.</div> |
| </li> |
| </ul> |
| <a name="compile()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>compile</h4> |
| <pre>void compile()</pre> |
| <div class="block">Compile the query.</div> |
| </li> |
| </ul> |
| <a name="execute()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> execute()</pre> |
| <div class="block">Execute.</div> |
| </li> |
| </ul> |
| <a name="execute(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> execute(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><?,?> params)</pre> |
| <div class="block">Execute with parameter map.</div> |
| </li> |
| </ul> |
| <a name="execute(java.lang.Object[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> execute(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[] params)</pre> |
| <div class="block">Execute with parameter array.</div> |
| </li> |
| </ul> |
| <a name="deleteAll()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteAll</h4> |
| <pre>long deleteAll()</pre> |
| <div class="block">Deletes all of the instances that are satisfied by the query.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the number of instances that were deleted</dd></dl> |
| </li> |
| </ul> |
| <a name="deleteAll(java.lang.Object[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteAll</h4> |
| <pre>long deleteAll(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[] parameters)</pre> |
| <div class="block">Deletes all of the instances that are satisfied by the query.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>parameters</code> - the positional parameters for the query</dd> |
| <dt><span class="strong">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>long deleteAll(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><?,?> parameterMap)</pre> |
| <div class="block">Deletes all of the instances that are satisfied by the query.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>parameterMap</code> - the named parameter map</dd> |
| <dt><span class="strong">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>long updateAll()</pre> |
| <div class="block">Performs an update of the instances that are satisfied by the query.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the number of instances that were update</dd></dl> |
| </li> |
| </ul> |
| <a name="updateAll(java.lang.Object[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateAll</h4> |
| <pre>long updateAll(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[] parameters)</pre> |
| <div class="block">Performs an update of the instances that are satisfied by the query.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>parameters</code> - the positional parameter array</dd> |
| <dt><span class="strong">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>long updateAll(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><?,?> parameterMap)</pre> |
| <div class="block">Performs an update of the instances that are satisfied by the query.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>parameterMap</code> - the named parameter map</dd> |
| <dt><span class="strong">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>void closeAll()</pre> |
| <div class="block">Close all open query results.</div> |
| </li> |
| </ul> |
| <a name="closeResources()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>closeResources</h4> |
| <pre>void closeResources()</pre> |
| <div class="block">Close query results that are consuming resources. Allow results that |
| are not consuming resources to remain open so that they continue to |
| function normally.</div> |
| </li> |
| </ul> |
| <a name="getDataStoreActions(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDataStoreActions</h4> |
| <pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getDataStoreActions(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><?,?> params)</pre> |
| <div class="block">Returns a description of the commands that will be sent to |
| the datastore in order to execute this query. This will |
| typically be in the native query language of the database (e.g., SQL).</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>params</code> - the named parameter map for the query invocation</dd><dt><span class="strong">Since:</span></dt> |
| <dd>0.3.2</dd></dl> |
| </li> |
| </ul> |
| <a name="assertOpen()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assertOpen</h4> |
| <pre>void assertOpen()</pre> |
| <div class="block">Assert that the query's broker is still open.</div> |
| </li> |
| </ul> |
| <a name="assertNotReadOnly()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assertNotReadOnly</h4> |
| <pre>void assertNotReadOnly()</pre> |
| <div class="block">Assert that the query is not read-only.</div> |
| </li> |
| </ul> |
| <a name="assertNotSerialized()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>assertNotSerialized</h4> |
| <pre>void assertNotSerialized()</pre> |
| <div class="block">Check that the query has not been serialized, which causes it to lose |
| its association with its Broker.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/Query.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/openjpa/kernel/PreparedQueryCache.Exclusion.html" title="interface in org.apache.openjpa.kernel"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/kernel/Query.html" target="_top">Frames</a></li> |
| <li><a href="Query.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>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 name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2006–2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |