| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_79) on Mon Mar 21 21:59:41 CET 2016 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>QueryImpl (OpenJPA Parent POM 2.4.1 API)</title> |
| <meta name="date" content="2016-03-21"> |
| <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="QueryImpl (OpenJPA Parent POM 2.4.1 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/QueryImpl.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/QueryHints.html" title="interface in org.apache.openjpa.kernel"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/kernel/QueryImpl.Compilation.html" title="class 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/QueryImpl.html" target="_top">Frames</a></li> |
| <li><a href="QueryImpl.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><a href="#nested_class_summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.openjpa.kernel</div> |
| <h2 title="Class QueryImpl" class="title">Class QueryImpl</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.openjpa.kernel.QueryImpl</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="http://download.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/Query.html" title="interface in org.apache.openjpa.kernel">Query</a>, <a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a>, <a href="../../../../org/apache/openjpa/kernel/QueryFlushModes.html" title="interface in org.apache.openjpa.kernel">QueryFlushModes</a>, <a href="../../../../org/apache/openjpa/kernel/QueryOperations.html" title="interface in org.apache.openjpa.kernel">QueryOperations</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/apache/openjpa/slice/DistributedQueryImpl.html" title="class in org.apache.openjpa.slice">DistributedQueryImpl</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">QueryImpl</span> |
| extends <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></pre> |
| <div class="block">Implementation of the <a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel"><code>Query</code></a> interface.</div> |
| <dl><dt><span class="strong">Author:</span></dt> |
| <dd>Abe White</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#org.apache.openjpa.kernel.QueryImpl">Serialized Form</a></dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_class_summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.Compilation.html" title="class in org.apache.openjpa.kernel">QueryImpl.Compilation</a></strong></code> |
| <div class="block">Struct of compiled query properties.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.PackingResultObjectProvider.html" title="class in org.apache.openjpa.kernel">QueryImpl.PackingResultObjectProvider</a></strong></code> |
| <div class="block">Result object provider that packs results before returning them.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.RemoveOnCloseResultList.html" title="class in org.apache.openjpa.kernel">QueryImpl.RemoveOnCloseResultList</a></strong></code> |
| <div class="block">Result list that removes itself from the query's open result list |
| when it is closed.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields_inherited_from_class_org.apache.openjpa.kernel.QueryOperations"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.openjpa.kernel.<a href="../../../../org/apache/openjpa/kernel/QueryOperations.html" title="interface in org.apache.openjpa.kernel">QueryOperations</a></h3> |
| <code><a href="../../../../org/apache/openjpa/kernel/QueryOperations.html#OP_DELETE">OP_DELETE</a>, <a href="../../../../org/apache/openjpa/kernel/QueryOperations.html#OP_SELECT">OP_SELECT</a>, <a href="../../../../org/apache/openjpa/kernel/QueryOperations.html#OP_UPDATE">OP_UPDATE</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields_inherited_from_class_org.apache.openjpa.kernel.QueryFlushModes"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.openjpa.kernel.<a href="../../../../org/apache/openjpa/kernel/QueryFlushModes.html" title="interface in org.apache.openjpa.kernel">QueryFlushModes</a></h3> |
| <code><a href="../../../../org/apache/openjpa/kernel/QueryFlushModes.html#FLUSH_FALSE">FLUSH_FALSE</a>, <a href="../../../../org/apache/openjpa/kernel/QueryFlushModes.html#FLUSH_TRUE">FLUSH_TRUE</a>, <a href="../../../../org/apache/openjpa/kernel/QueryFlushModes.html#FLUSH_WITH_CONNECTION">FLUSH_WITH_CONNECTION</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#QueryImpl(org.apache.openjpa.kernel.Broker,%20java.lang.String,%20org.apache.openjpa.kernel.StoreQuery)">QueryImpl</a></strong>(<a href="../../../../org/apache/openjpa/kernel/Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a> broker, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> language, |
| <a href="../../../../org/apache/openjpa/kernel/StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a> storeQuery)</code> |
| <div class="block">Construct a query managed by the given broker.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="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/QueryImpl.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/QueryImpl.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/QueryImpl.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/QueryImpl.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/QueryImpl.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>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#assertParameters(org.apache.openjpa.kernel.StoreQuery,%20org.apache.openjpa.kernel.StoreQuery.Executor,%20java.util.Map)">assertParameters</a></strong>(<a href="../../../../org/apache/openjpa/kernel/StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a> q, |
| <a href="../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel">StoreQuery.Executor</a> ex, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> params)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#assertParameters(org.apache.openjpa.kernel.StoreQuery,%20org.apache.openjpa.kernel.StoreQuery.Executor,%20java.lang.Object[])">assertParameters</a></strong>(<a href="../../../../org/apache/openjpa/kernel/StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a> q, |
| <a href="../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel">StoreQuery.Executor</a> ex, |
| <a href="http://download.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">Checks that the passed parameters match the declarations.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#classForName(java.lang.String,%20java.lang.String[])">classForName</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] imports)</code> |
| <div class="block">Helper method to instantiate the class with the given name, taking |
| into account the query's candidate package, automatic imports, and |
| the given imports (if any).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#closeAll()">closeAll</a></strong>()</code> |
| <div class="block">Close all open query results.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#closeResources()">closeResources</a></strong>()</code> |
| <div class="block">Close query results that are consuming resources.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/openjpa/kernel/QueryImpl.Compilation.html" title="class in org.apache.openjpa.kernel">QueryImpl.Compilation</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#compilationFromCache()">compilationFromCache</a></strong>()</code> |
| <div class="block">Find the cached compilation for the current query, creating one if it |
| does not exist.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#compile()">compile</a></strong>()</code> |
| <div class="block">Compile 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/QueryImpl.html#declareParameters(java.lang.String)">declareParameters</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> params)</code> |
| <div class="block">Declared parameters, for query languages that use them.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/openjpa/kernel/QueryImpl.RemoveOnCloseResultList.html" title="class in org.apache.openjpa.kernel">QueryImpl.RemoveOnCloseResultList</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#decorateResultList(org.apache.openjpa.lib.rop.ResultList)">decorateResultList</a></strong>(<a href="../../../../org/apache/openjpa/lib/rop/ResultList.html" title="interface in org.apache.openjpa.lib.rop">ResultList</a><?> res)</code> |
| <div class="block">Optionally decorate the native result.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.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/QueryImpl.html#deleteAll(java.util.Map)">deleteAll</a></strong>(<a href="http://download.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">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/QueryImpl.html#deleteAll(java.lang.Object[])">deleteAll</a></strong>(<a href="http://download.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">Deletes all of the instances that are satisfied by the query.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#deleteInMemory(org.apache.openjpa.kernel.StoreQuery,%20org.apache.openjpa.kernel.StoreQuery.Executor,%20java.lang.Object[])">deleteInMemory</a></strong>(<a href="../../../../org/apache/openjpa/kernel/StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a> q, |
| <a href="../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel">StoreQuery.Executor</a> executor, |
| <a href="http://download.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">Helper method to delete the objects found by executing a query on |
| the given executor.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.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/QueryImpl.html#execute()">execute</a></strong>()</code> |
| <div class="block">Execute.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.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/QueryImpl.html#execute(java.util.Map)">execute</a></strong>(<a href="http://download.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="altColor"> |
| <td class="colFirst"><code><a href="http://download.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/QueryImpl.html#execute(java.lang.Object[])">execute</a></strong>(<a href="http://download.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="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#getAccessPathMetaDatas()">getAccessPathMetaDatas</a></strong>()</code> |
| <div class="block">Return the classes that affect this query.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/exps/AggregateListener.html" title="interface in org.apache.openjpa.kernel.exps">AggregateListener</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#getAggregateListener(java.lang.String)">getAggregateListener</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tag)</code> |
| <div class="block">Return the filter listener for the given tag, or null.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/openjpa/kernel/exps/AggregateListener.html" title="interface in org.apache.openjpa.kernel.exps">AggregateListener</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#getAggregateListeners()">getAggregateListeners</a></strong>()</code> |
| <div class="block">The set of aggregate listeners.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.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/QueryImpl.html#getAlias()">getAlias</a></strong>()</code> |
| <div class="block">If this query is not a projection but places candidate results into a |
| result class under an alias, return that alias.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <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/QueryImpl.html#getBroker()">getBroker</a></strong>()</code> |
| <div class="block">The broker that generated this query.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><?></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#getCandidateCollection()">getCandidateCollection</a></strong>()</code> |
| <div class="block">Return the candidate collection, or <code>null</code> if an |
| extent was specified instead of a collection.</div> |
| </td> |
| </tr> |
| <tr 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/QueryImpl.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://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#getCandidateType()">getCandidateType</a></strong>()</code> |
| <div class="block">Return the class of the objects that this query will return, |
| or <code>null</code> if this information is not available / not relevant.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.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/QueryImpl.html#getCompilation()">getCompilation</a></strong>()</code> |
| <div class="block">Return the query's compilation state.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.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/QueryImpl.html#getDataStoreActions(java.util.Map)">getDataStoreActions</a></strong>(<a href="http://download.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>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#getEndRange()">getEndRange</a></strong>()</code> |
| <div class="block">Return the 0-based exclusive end index for the returned results, |
| or <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Long.html?is-external=true#MAX_VALUE" title="class or interface in java.lang"><code>Long.MAX_VALUE</code></a> for no limit.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#getFetchConfiguration()">getFetchConfiguration</a></strong>()</code> |
| <div class="block">Return the fetch configuration for this query.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/exps/FilterListener.html" title="interface in org.apache.openjpa.kernel.exps">FilterListener</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#getFilterListener(java.lang.String)">getFilterListener</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tag)</code> |
| <div class="block">Return the filter listener for the given tag, or null.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/openjpa/kernel/exps/FilterListener.html" title="interface in org.apache.openjpa.kernel.exps">FilterListener</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#getFilterListeners()">getFilterListeners</a></strong>()</code> |
| <div class="block">The set of filter listeners.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#getIgnoreChanges()">getIgnoreChanges</a></strong>()</code> |
| <div class="block">Whether to ignore changes in the current transaction.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.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/QueryImpl.html#getLanguage()">getLanguage</a></strong>()</code> |
| <div class="block">The query language.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#getOperation()">getOperation</a></strong>()</code> |
| <div class="block">Returns the operation that this query will be expected to perform.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/lib/util/OrderedMap.html" title="class in org.apache.openjpa.lib.util">OrderedMap</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#getOrderedParameterTypes()">getOrderedParameterTypes</a></strong>()</code> |
| <div class="block">Return a map of parameter name to type for this query.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.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/QueryImpl.html#getParameterDeclaration()">getParameterDeclaration</a></strong>()</code> |
| <div class="block">The parameter declaration.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>org.apache.commons.collections.map.LinkedMap</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#getParameterTypes()">getParameterTypes</a></strong>()</code> |
| <div class="block">Return a map of parameter name to type for this query.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.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/QueryImpl.html#getProjectionAliases()">getProjectionAliases</a></strong>()</code> |
| <div class="block">If this query is a projection, return the projection aliases.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#getProjectionTypes()">getProjectionTypes</a></strong>()</code> |
| <div class="block">If this query is a projection, return the projection types.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#getQuery()">getQuery</a></strong>()</code> |
| <div class="block">Return the query for this context.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.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/QueryImpl.html#getQueryString()">getQueryString</a></strong>()</code> |
| <div class="block">The query string.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.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/QueryImpl.html#getResultMappingName()">getResultMappingName</a></strong>()</code> |
| <div class="block">Name of a mapping from the result data to its object representation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#getResultMappingScope()">getResultMappingScope</a></strong>()</code> |
| <div class="block">Scope of a mapping from the result data to its object representation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#getResultType()">getResultType</a></strong>()</code> |
| <div class="block">Returns the result class that has been set through |
| <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setResultType(java.lang.Class)"><code>QueryContext.setResultType(java.lang.Class<?>)</code></a>, or null if none.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#getStartRange()">getStartRange</a></strong>()</code> |
| <div class="block">Return the 0-based start index for the returned results.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#getStoreContext()">getStoreContext</a></strong>()</code> |
| <div class="block">The persistence context for the query.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#getStoreQuery()">getStoreQuery</a></strong>()</code> |
| <div class="block">Internal store query.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#getUpdates()">getUpdates</a></strong>()</code> |
| <div class="block">If this query is a bulk update, return a map of the |
| <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta"><code>FieldMetaData</code></a>s to <a href="../../../../org/apache/openjpa/kernel/exps/Constant.html" title="interface in org.apache.openjpa.kernel.exps"><code>Constant</code></a>s.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#hasGrouping()">hasGrouping</a></strong>()</code> |
| <div class="block">Return true if the query uses grouping.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#hasSubclasses()">hasSubclasses</a></strong>()</code> |
| <div class="block">Whether query results will include subclasses of the candidate class.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#isAccessPathDirty(org.apache.openjpa.kernel.Broker,%20org.apache.openjpa.meta.ClassMetaData[])">isAccessPathDirty</a></strong>(<a href="../../../../org/apache/openjpa/kernel/Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a> broker, |
| <a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>[] accessMetas)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#isAggregate()">isAggregate</a></strong>()</code> |
| <div class="block">Return true if the query is an aggregate.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#isDistinct()">isDistinct</a></strong>()</code> |
| <div class="block">Affirms if this query results are distinct instance(s).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#isParsedQuery()">isParsedQuery</a></strong>()</code> |
| <div class="block">Affirms if this query has originated by parsing a string-based query.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#isReadOnly()">isReadOnly</a></strong>()</code> |
| <div class="block">Whether the query has been marked read-only.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#isUnique()">isUnique</a></strong>()</code> |
| <div class="block">The unique flag.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#lock()">lock</a></strong>()</code> |
| <div class="block">Synchronize on the query's internal lock.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.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/QueryImpl.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/QueryImpl.html#setCandidateCollection(java.util.Collection)">setCandidateCollection</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><?> candidateCollection)</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/QueryImpl.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> candidateExtent)</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/QueryImpl.html#setCandidateType(java.lang.Class,%20boolean)">setCandidateType</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> candidateClass, |
| boolean subs)</code> |
| <div class="block">Set the candidate type.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#setIgnoreChanges(boolean)">setIgnoreChanges</a></strong>(boolean flag)</code> |
| <div class="block">Whether to ignore changes in the current transaction.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#setQuery(java.lang.Object)">setQuery</a></strong>(<a href="http://download.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="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#setRange(long,%20long)">setRange</a></strong>(long start, |
| long end)</code> |
| <div class="block">Set the range of results to return.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#setReadOnly(boolean)">setReadOnly</a></strong>(boolean flag)</code> |
| <div class="block">Whether the query has been marked read-only.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#setResultMapping(java.lang.Class,%20java.lang.String)">setResultMapping</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> scope, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Name and scope of a mapping from the result data to its object |
| representation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#setResultType(java.lang.Class)">setResultType</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls)</code> |
| <div class="block">Specify the type of object in which the result of evaluating this query.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#setUnique(boolean)">setUnique</a></strong>(boolean unique)</code> |
| <div class="block">Specify that the query will return only 1 |
| result, rather than a collection.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#startLocking()">startLocking</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#stopLocking()">stopLocking</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://download.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/QueryImpl.html#toResult(org.apache.openjpa.kernel.StoreQuery,%20org.apache.openjpa.kernel.StoreQuery.Executor,%20org.apache.openjpa.lib.rop.ResultObjectProvider,%20org.apache.openjpa.kernel.StoreQuery.Range)">toResult</a></strong>(<a href="../../../../org/apache/openjpa/kernel/StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a> q, |
| <a href="../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel">StoreQuery.Executor</a> ex, |
| <a href="../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html" title="interface in org.apache.openjpa.lib.rop">ResultObjectProvider</a> rop, |
| <a href="../../../../org/apache/openjpa/kernel/StoreQuery.Range.html" title="class in org.apache.openjpa.kernel">StoreQuery.Range</a> range)</code> |
| <div class="block">Return the query result for the given result object provider.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.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/QueryImpl.html#toString()">toString</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#unlock()">unlock</a></strong>()</code> |
| <div class="block">Unlock the query's internal lock.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.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="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#updateAll(java.util.Map)">updateAll</a></strong>(<a href="http://download.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">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/QueryImpl.html#updateAll(java.lang.Object[])">updateAll</a></strong>(<a href="http://download.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">Performs an update of the instances that are satisfied by the query.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/QueryImpl.html#updateInMemory(org.apache.openjpa.kernel.StoreQuery,%20org.apache.openjpa.kernel.StoreQuery.Executor,%20java.lang.Object[])">updateInMemory</a></strong>(<a href="../../../../org/apache/openjpa/kernel/StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a> q, |
| <a href="../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel">StoreQuery.Executor</a> executor, |
| <a href="http://download.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">Helper method to update the objects found by executing a query on |
| the given executor.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="QueryImpl(org.apache.openjpa.kernel.Broker, java.lang.String, org.apache.openjpa.kernel.StoreQuery)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>QueryImpl</h4> |
| <pre>public QueryImpl(<a href="../../../../org/apache/openjpa/kernel/Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a> broker, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> language, |
| <a href="../../../../org/apache/openjpa/kernel/StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a> storeQuery)</pre> |
| <div class="block">Construct a query managed by the given broker.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getStoreQuery()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStoreQuery</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a> getStoreQuery()</pre> |
| <div class="block">Internal store query.</div> |
| </li> |
| </ul> |
| <a name="getBroker()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBroker</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a> getBroker()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#getBroker()">Query</a></code></strong></div> |
| <div class="block">The broker that generated this query.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#getBroker()">getBroker</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getQuery()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQuery</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a> getQuery()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getQuery()">QueryContext</a></code></strong></div> |
| <div class="block">Return the query for this context. Note that the query will be |
| unavailable in remote contexts, and this method may throw an exception |
| to that effect.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getQuery()">getQuery</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStoreContext()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStoreContext</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a> getStoreContext()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getStoreContext()">QueryContext</a></code></strong></div> |
| <div class="block">The persistence context for the query.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getStoreContext()">getStoreContext</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLanguage()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLanguage</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getLanguage()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getLanguage()">QueryContext</a></code></strong></div> |
| <div class="block">The query language.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getLanguage()">getLanguage</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFetchConfiguration()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFetchConfiguration</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</a> getFetchConfiguration()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getFetchConfiguration()">QueryContext</a></code></strong></div> |
| <div class="block">Return the fetch configuration for this query.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getFetchConfiguration()">getFetchConfiguration</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getQueryString()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueryString</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getQueryString()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getQueryString()">QueryContext</a></code></strong></div> |
| <div class="block">The query string.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getQueryString()">getQueryString</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getIgnoreChanges()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIgnoreChanges</h4> |
| <pre>public boolean getIgnoreChanges()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getIgnoreChanges()">QueryContext</a></code></strong></div> |
| <div class="block">Whether to ignore changes in the current transaction.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getIgnoreChanges()">getIgnoreChanges</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setIgnoreChanges(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIgnoreChanges</h4> |
| <pre>public void setIgnoreChanges(boolean flag)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#setIgnoreChanges(boolean)">Query</a></code></strong></div> |
| <div class="block">Whether to ignore changes in the current transaction.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#setIgnoreChanges(boolean)">setIgnoreChanges</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isReadOnly()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isReadOnly</h4> |
| <pre>public boolean isReadOnly()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#isReadOnly()">QueryContext</a></code></strong></div> |
| <div class="block">Whether the query has been marked read-only.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#isReadOnly()">isReadOnly</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setReadOnly(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setReadOnly</h4> |
| <pre>public void setReadOnly(boolean flag)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setReadOnly(boolean)">QueryContext</a></code></strong></div> |
| <div class="block">Whether the query has been marked read-only.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setReadOnly(boolean)">setReadOnly</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addFilterListener(org.apache.openjpa.kernel.exps.FilterListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addFilterListener</h4> |
| <pre>public void addFilterListener(<a href="../../../../org/apache/openjpa/kernel/exps/FilterListener.html" title="interface in org.apache.openjpa.kernel.exps">FilterListener</a> listener)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#addFilterListener(org.apache.openjpa.kernel.exps.FilterListener)">Query</a></code></strong></div> |
| <div class="block">Register a filter listener for the query.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#addFilterListener(org.apache.openjpa.kernel.exps.FilterListener)">addFilterListener</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeFilterListener(org.apache.openjpa.kernel.exps.FilterListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeFilterListener</h4> |
| <pre>public void removeFilterListener(<a href="../../../../org/apache/openjpa/kernel/exps/FilterListener.html" title="interface in org.apache.openjpa.kernel.exps">FilterListener</a> listener)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#removeFilterListener(org.apache.openjpa.kernel.exps.FilterListener)">Query</a></code></strong></div> |
| <div class="block">Remove a filter listener from the query.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#removeFilterListener(org.apache.openjpa.kernel.exps.FilterListener)">removeFilterListener</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFilterListeners()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFilterListeners</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/openjpa/kernel/exps/FilterListener.html" title="interface in org.apache.openjpa.kernel.exps">FilterListener</a>> getFilterListeners()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getFilterListeners()">QueryContext</a></code></strong></div> |
| <div class="block">The set of filter listeners.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getFilterListeners()">getFilterListeners</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFilterListener(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFilterListener</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/exps/FilterListener.html" title="interface in org.apache.openjpa.kernel.exps">FilterListener</a> getFilterListener(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tag)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getFilterListener(java.lang.String)">QueryContext</a></code></strong></div> |
| <div class="block">Return the filter listener for the given tag, or null.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getFilterListener(java.lang.String)">getFilterListener</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addAggregateListener(org.apache.openjpa.kernel.exps.AggregateListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addAggregateListener</h4> |
| <pre>public void addAggregateListener(<a href="../../../../org/apache/openjpa/kernel/exps/AggregateListener.html" title="interface in org.apache.openjpa.kernel.exps">AggregateListener</a> listener)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#addAggregateListener(org.apache.openjpa.kernel.exps.AggregateListener)">Query</a></code></strong></div> |
| <div class="block">Register an aggregate listener for the query.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#addAggregateListener(org.apache.openjpa.kernel.exps.AggregateListener)">addAggregateListener</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeAggregateListener(org.apache.openjpa.kernel.exps.AggregateListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeAggregateListener</h4> |
| <pre>public void removeAggregateListener(<a href="../../../../org/apache/openjpa/kernel/exps/AggregateListener.html" title="interface in org.apache.openjpa.kernel.exps">AggregateListener</a> listener)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#removeAggregateListener(org.apache.openjpa.kernel.exps.AggregateListener)">Query</a></code></strong></div> |
| <div class="block">Remove an aggregate listener from the query.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#removeAggregateListener(org.apache.openjpa.kernel.exps.AggregateListener)">removeAggregateListener</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAggregateListeners()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAggregateListeners</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/openjpa/kernel/exps/AggregateListener.html" title="interface in org.apache.openjpa.kernel.exps">AggregateListener</a>> getAggregateListeners()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getAggregateListeners()">QueryContext</a></code></strong></div> |
| <div class="block">The set of aggregate listeners.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getAggregateListeners()">getAggregateListeners</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAggregateListener(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAggregateListener</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/exps/AggregateListener.html" title="interface in org.apache.openjpa.kernel.exps">AggregateListener</a> getAggregateListener(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tag)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getAggregateListener(java.lang.String)">QueryContext</a></code></strong></div> |
| <div class="block">Return the filter listener for the given tag, or null.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getAggregateListener(java.lang.String)">getAggregateListener</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCandidateExtent()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCandidateExtent</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/kernel/Extent.html" title="interface in org.apache.openjpa.kernel">Extent</a> getCandidateExtent()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#getCandidateExtent()">Query</a></code></strong></div> |
| <div class="block">Return the candidate extent, or <code>null</code> if a |
| collection was specified instead of an extent.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#getCandidateExtent()">getCandidateExtent</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCandidateExtent(org.apache.openjpa.kernel.Extent)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCandidateExtent</h4> |
| <pre>public void setCandidateExtent(<a href="../../../../org/apache/openjpa/kernel/Extent.html" title="interface in org.apache.openjpa.kernel">Extent</a> candidateExtent)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#setCandidateExtent(org.apache.openjpa.kernel.Extent)">Query</a></code></strong></div> |
| <div class="block">Set the candidate extent.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#setCandidateExtent(org.apache.openjpa.kernel.Extent)">setCandidateExtent</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCandidateCollection()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCandidateCollection</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><?> getCandidateCollection()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getCandidateCollection()">QueryContext</a></code></strong></div> |
| <div class="block">Return the candidate collection, or <code>null</code> if an |
| extent was specified instead of a collection.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getCandidateCollection()">getCandidateCollection</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCandidateCollection(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCandidateCollection</h4> |
| <pre>public void setCandidateCollection(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><?> candidateCollection)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#setCandidateCollection(java.util.Collection)">Query</a></code></strong></div> |
| <div class="block">Set a collection of candidates.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#setCandidateCollection(java.util.Collection)">setCandidateCollection</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCandidateType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCandidateType</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> getCandidateType()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getCandidateType()">QueryContext</a></code></strong></div> |
| <div class="block">Return the class of the objects that this query will return, |
| or <code>null</code> if this information is not available / not relevant.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getCandidateType()">getCandidateType</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCandidateType(java.lang.Class, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCandidateType</h4> |
| <pre>public void setCandidateType(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> candidateClass, |
| boolean subs)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setCandidateType(java.lang.Class,%20boolean)">QueryContext</a></code></strong></div> |
| <div class="block">Set the candidate type.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setCandidateType(java.lang.Class,%20boolean)">setCandidateType</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasSubclasses()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasSubclasses</h4> |
| <pre>public boolean hasSubclasses()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#hasSubclasses()">QueryContext</a></code></strong></div> |
| <div class="block">Whether query results will include subclasses of the candidate class.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#hasSubclasses()">hasSubclasses</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getResultMappingName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResultMappingName</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getResultMappingName()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getResultMappingName()">QueryContext</a></code></strong></div> |
| <div class="block">Name of a mapping from the result data to its object representation.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getResultMappingName()">getResultMappingName</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getResultMappingScope()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResultMappingScope</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> getResultMappingScope()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getResultMappingScope()">QueryContext</a></code></strong></div> |
| <div class="block">Scope of a mapping from the result data to its object representation.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getResultMappingScope()">getResultMappingScope</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setResultMapping(java.lang.Class, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setResultMapping</h4> |
| <pre>public void setResultMapping(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> scope, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setResultMapping(java.lang.Class,%20java.lang.String)">QueryContext</a></code></strong></div> |
| <div class="block">Name and scope of a mapping from the result data to its object |
| representation.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setResultMapping(java.lang.Class,%20java.lang.String)">setResultMapping</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isUnique()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isUnique</h4> |
| <pre>public boolean isUnique()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#isUnique()">QueryContext</a></code></strong></div> |
| <div class="block">The unique flag.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#isUnique()">isUnique</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isParsedQuery()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isParsedQuery</h4> |
| <pre>public boolean isParsedQuery()</pre> |
| <div class="block">Affirms if this query has originated by parsing a string-based query.</div> |
| </li> |
| </ul> |
| <a name="setUnique(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUnique</h4> |
| <pre>public void setUnique(boolean unique)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setUnique(boolean)">QueryContext</a></code></strong></div> |
| <div class="block">Specify that the query will return only 1 |
| result, rather than a collection. The execute method will return null |
| if the query result size is 0.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setUnique(boolean)">setUnique</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getResultType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResultType</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> getResultType()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getResultType()">QueryContext</a></code></strong></div> |
| <div class="block">Returns the result class that has been set through |
| <a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setResultType(java.lang.Class)"><code>QueryContext.setResultType(java.lang.Class<?>)</code></a>, or null if none.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getResultType()">getResultType</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setResultType(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setResultType</h4> |
| <pre>public void setResultType(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> cls)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setResultType(java.lang.Class)">QueryContext</a></code></strong></div> |
| <div class="block">Specify the type of object in which the result of evaluating this query.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setResultType(java.lang.Class)">setResultType</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStartRange()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStartRange</h4> |
| <pre>public long getStartRange()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getStartRange()">QueryContext</a></code></strong></div> |
| <div class="block">Return the 0-based start index for the returned results.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getStartRange()">getStartRange</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEndRange()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEndRange</h4> |
| <pre>public long getEndRange()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getEndRange()">QueryContext</a></code></strong></div> |
| <div class="block">Return the 0-based exclusive end index for the returned results, |
| or <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Long.html?is-external=true#MAX_VALUE" title="class or interface in java.lang"><code>Long.MAX_VALUE</code></a> for no limit.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getEndRange()">getEndRange</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRange(long, long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRange</h4> |
| <pre>public void setRange(long start, |
| long end)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setRange(long,%20long)">QueryContext</a></code></strong></div> |
| <div class="block">Set the range of results to return.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#setRange(long,%20long)">setRange</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| <dt><span class="strong">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="http://download.oracle.com/javase/6/docs/api/java/lang/Long.html?is-external=true#MAX_VALUE" title="class or interface in java.lang"><code>Long.MAX_VALUE</code></a> for no limit</dd></dl> |
| </li> |
| </ul> |
| <a name="getParameterDeclaration()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParameterDeclaration</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getParameterDeclaration()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getParameterDeclaration()">QueryContext</a></code></strong></div> |
| <div class="block">The parameter declaration.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getParameterDeclaration()">getParameterDeclaration</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="declareParameters(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>declareParameters</h4> |
| <pre>public void declareParameters(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> params)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#declareParameters(java.lang.String)">QueryContext</a></code></strong></div> |
| <div class="block">Declared parameters, for query languages that use them.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#declareParameters(java.lang.String)">declareParameters</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="compile()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>compile</h4> |
| <pre>public void compile()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#compile()">Query</a></code></strong></div> |
| <div class="block">Compile the query.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#compile()">compile</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCompilation()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCompilation</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getCompilation()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getCompilation()">QueryContext</a></code></strong></div> |
| <div class="block">Return the query's compilation state.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getCompilation()">getCompilation</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="compilationFromCache()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>compilationFromCache</h4> |
| <pre>protected <a href="../../../../org/apache/openjpa/kernel/QueryImpl.Compilation.html" title="class in org.apache.openjpa.kernel">QueryImpl.Compilation</a> compilationFromCache()</pre> |
| <div class="block">Find the cached compilation for the current query, creating one if it |
| does not exist.</div> |
| </li> |
| </ul> |
| <a name="execute()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre>public <a href="http://download.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"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#execute()">Query</a></code></strong></div> |
| <div class="block">Execute.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#execute()">execute</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="execute(java.lang.Object[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre>public <a href="http://download.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://download.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"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#execute(java.lang.Object[])">Query</a></code></strong></div> |
| <div class="block">Execute with parameter array.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#execute(java.lang.Object[])">execute</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="execute(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre>public <a href="http://download.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://download.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"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#execute(java.util.Map)">Query</a></code></strong></div> |
| <div class="block">Execute with parameter map.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#execute(java.util.Map)">execute</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="deleteAll()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteAll</h4> |
| <pre>public long deleteAll()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#deleteAll()">Query</a></code></strong></div> |
| <div class="block">Deletes all of the instances that are satisfied by the query.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#deleteAll()">deleteAll</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| <dt><span class="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>public long deleteAll(<a href="http://download.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"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#deleteAll(java.lang.Object[])">Query</a></code></strong></div> |
| <div class="block">Deletes all of the instances that are satisfied by the query.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#deleteAll(java.lang.Object[])">deleteAll</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>params</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>public long deleteAll(<a href="http://download.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"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#deleteAll(java.util.Map)">Query</a></code></strong></div> |
| <div class="block">Deletes all of the instances that are satisfied by the query.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#deleteAll(java.util.Map)">deleteAll</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>params</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>public long updateAll()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#updateAll()">Query</a></code></strong></div> |
| <div class="block">Performs an update of the instances that are satisfied by the query.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#updateAll()">updateAll</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| <dt><span class="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>public long updateAll(<a href="http://download.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"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#updateAll(java.lang.Object[])">Query</a></code></strong></div> |
| <div class="block">Performs an update of the instances that are satisfied by the query.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#updateAll(java.lang.Object[])">updateAll</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>params</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>public long updateAll(<a href="http://download.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"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#updateAll(java.util.Map)">Query</a></code></strong></div> |
| <div class="block">Performs an update of the instances that are satisfied by the query.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#updateAll(java.util.Map)">updateAll</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>params</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="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>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a> deleteInMemory(<a href="../../../../org/apache/openjpa/kernel/StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a> q, |
| <a href="../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel">StoreQuery.Executor</a> executor, |
| <a href="http://download.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"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#deleteInMemory(org.apache.openjpa.kernel.StoreQuery,%20org.apache.openjpa.kernel.StoreQuery.Executor,%20java.lang.Object[])">QueryContext</a></code></strong></div> |
| <div class="block">Helper method to delete the objects found by executing a query on |
| the given executor.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><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></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="updateInMemory(org.apache.openjpa.kernel.StoreQuery, org.apache.openjpa.kernel.StoreQuery.Executor, java.lang.Object[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateInMemory</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a> updateInMemory(<a href="../../../../org/apache/openjpa/kernel/StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a> q, |
| <a href="../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel">StoreQuery.Executor</a> executor, |
| <a href="http://download.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"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#updateInMemory(org.apache.openjpa.kernel.StoreQuery,%20org.apache.openjpa.kernel.StoreQuery.Executor,%20java.lang.Object[])">QueryContext</a></code></strong></div> |
| <div class="block">Helper method to update the objects found by executing a query on |
| the given executor.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><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> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toResult(org.apache.openjpa.kernel.StoreQuery, org.apache.openjpa.kernel.StoreQuery.Executor, org.apache.openjpa.lib.rop.ResultObjectProvider, org.apache.openjpa.kernel.StoreQuery.Range)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toResult</h4> |
| <pre>protected <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> toResult(<a href="../../../../org/apache/openjpa/kernel/StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a> q, |
| <a href="../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel">StoreQuery.Executor</a> ex, |
| <a href="../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html" title="interface in org.apache.openjpa.lib.rop">ResultObjectProvider</a> rop, |
| <a href="../../../../org/apache/openjpa/kernel/StoreQuery.Range.html" title="class in org.apache.openjpa.kernel">StoreQuery.Range</a> range) |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Return the query result for the given result object provider.</div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="decorateResultList(org.apache.openjpa.lib.rop.ResultList)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>decorateResultList</h4> |
| <pre>protected <a href="../../../../org/apache/openjpa/kernel/QueryImpl.RemoveOnCloseResultList.html" title="class in org.apache.openjpa.kernel">QueryImpl.RemoveOnCloseResultList</a> decorateResultList(<a href="../../../../org/apache/openjpa/lib/rop/ResultList.html" title="interface in org.apache.openjpa.lib.rop">ResultList</a><?> res)</pre> |
| <div class="block">Optionally decorate the native result.</div> |
| </li> |
| </ul> |
| <a name="isAccessPathDirty(org.apache.openjpa.kernel.Broker, org.apache.openjpa.meta.ClassMetaData[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAccessPathDirty</h4> |
| <pre>public static boolean isAccessPathDirty(<a href="../../../../org/apache/openjpa/kernel/Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a> broker, |
| <a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>[] accessMetas)</pre> |
| </li> |
| </ul> |
| <a name="closeAll()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>closeAll</h4> |
| <pre>public void closeAll()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#closeAll()">Query</a></code></strong></div> |
| <div class="block">Close all open query results.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#closeAll()">closeAll</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="closeResources()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>closeResources</h4> |
| <pre>public void closeResources()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#closeResources()">Query</a></code></strong></div> |
| <div class="block">Close query results that are consuming resources. Allow results that |
| are not consuming resources to remain open so that they continue to |
| function normally.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#closeResources()">closeResources</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDataStoreActions(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDataStoreActions</h4> |
| <pre>public <a href="http://download.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://download.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"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#getDataStoreActions(java.util.Map)">Query</a></code></strong></div> |
| <div class="block">Returns a description of the commands that will be sent to |
| the datastore in order to execute this query. This will |
| typically be in the native query language of the database (e.g., SQL).</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#getDataStoreActions(java.util.Map)">getDataStoreActions</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>params</code> - the named parameter map for the query invocation</dd></dl> |
| </li> |
| </ul> |
| <a name="setQuery(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setQuery</h4> |
| <pre>public boolean setQuery(<a href="http://download.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"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#setQuery(java.lang.Object)">Query</a></code></strong></div> |
| <div class="block">The query string or template.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#setQuery(java.lang.Object)">setQuery</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAlias()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAlias</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getAlias()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getAlias()">QueryContext</a></code></strong></div> |
| <div class="block">If this query is not a projection but places candidate results into a |
| result class under an alias, return that alias.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getAlias()">getAlias</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getProjectionAliases()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProjectionAliases</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getProjectionAliases()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getProjectionAliases()">QueryContext</a></code></strong></div> |
| <div class="block">If this query is a projection, return the projection aliases.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getProjectionAliases()">getProjectionAliases</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getProjectionTypes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProjectionTypes</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?>[] getProjectionTypes()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getProjectionTypes()">QueryContext</a></code></strong></div> |
| <div class="block">If this query is a projection, return the projection types.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getProjectionTypes()">getProjectionTypes</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOperation()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOperation</h4> |
| <pre>public int getOperation()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getOperation()">QueryContext</a></code></strong></div> |
| <div class="block">Returns the operation that this query will be expected to perform.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getOperation()">getOperation</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/openjpa/kernel/QueryOperations.html" title="interface in org.apache.openjpa.kernel"><code>QueryOperations</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="isAggregate()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAggregate</h4> |
| <pre>public boolean isAggregate()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#isAggregate()">QueryContext</a></code></strong></div> |
| <div class="block">Return true if the query is an aggregate.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#isAggregate()">isAggregate</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isDistinct()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDistinct</h4> |
| <pre>public boolean isDistinct()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#isDistinct()">QueryContext</a></code></strong></div> |
| <div class="block">Affirms if this query results are distinct instance(s).</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#isDistinct()">isDistinct</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasGrouping()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasGrouping</h4> |
| <pre>public boolean hasGrouping()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#hasGrouping()">QueryContext</a></code></strong></div> |
| <div class="block">Return true if the query uses grouping.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#hasGrouping()">hasGrouping</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAccessPathMetaDatas()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAccessPathMetaDatas</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>[] getAccessPathMetaDatas()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getAccessPathMetaDatas()">QueryContext</a></code></strong></div> |
| <div class="block">Return the classes that affect this query.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getAccessPathMetaDatas()">getAccessPathMetaDatas</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOrderedParameterTypes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOrderedParameterTypes</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/lib/util/OrderedMap.html" title="class in org.apache.openjpa.lib.util">OrderedMap</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?>> getOrderedParameterTypes()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getOrderedParameterTypes()">QueryContext</a></code></strong></div> |
| <div class="block">Return a map of parameter name to type for this query. The returned |
| map will iterate in the order that the parameters were declared or, |
| if they're implicit, used.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getOrderedParameterTypes()">getOrderedParameterTypes</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getParameterTypes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParameterTypes</h4> |
| <pre>public org.apache.commons.collections.map.LinkedMap getParameterTypes()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getParameterTypes()">QueryContext</a></code></strong></div> |
| <div class="block">Return a map of parameter name to type for this query. The returned |
| map will iterate in the order that the parameters were declared or, |
| if they're implicit, used.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getParameterTypes()">getParameterTypes</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getUpdates()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUpdates</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> getUpdates()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getUpdates()">QueryContext</a></code></strong></div> |
| <div class="block">If this query is a bulk update, return a map of the |
| <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta"><code>FieldMetaData</code></a>s to <a href="../../../../org/apache/openjpa/kernel/exps/Constant.html" title="interface in org.apache.openjpa.kernel.exps"><code>Constant</code></a>s.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#getUpdates()">getUpdates</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="lock()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lock</h4> |
| <pre>public void lock()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#lock()">QueryContext</a></code></strong></div> |
| <div class="block">Synchronize on the query's internal lock.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#lock()">lock</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="unlock()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unlock</h4> |
| <pre>public void unlock()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#unlock()">QueryContext</a></code></strong></div> |
| <div class="block">Unlock the query's internal lock.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#unlock()">unlock</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="startLocking()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startLocking</h4> |
| <pre>public void startLocking()</pre> |
| </li> |
| </ul> |
| <a name="stopLocking()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stopLocking</h4> |
| <pre>public void stopLocking()</pre> |
| </li> |
| </ul> |
| <a name="classForName(java.lang.String, java.lang.String[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>classForName</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> classForName(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] imports)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#classForName(java.lang.String,%20java.lang.String[])">QueryContext</a></code></strong></div> |
| <div class="block">Helper method to instantiate the class with the given name, taking |
| into account the query's candidate package, automatic imports, and |
| the given imports (if any). Returns null if the type cannot be found.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html#classForName(java.lang.String,%20java.lang.String[])">classForName</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="assertOpen()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assertOpen</h4> |
| <pre>public void assertOpen()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#assertOpen()">Query</a></code></strong></div> |
| <div class="block">Assert that the query's broker is still open.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#assertOpen()">assertOpen</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="assertNotReadOnly()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assertNotReadOnly</h4> |
| <pre>public void assertNotReadOnly()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#assertNotReadOnly()">Query</a></code></strong></div> |
| <div class="block">Assert that the query is not read-only.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#assertNotReadOnly()">assertNotReadOnly</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="assertNotSerialized()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assertNotSerialized</h4> |
| <pre>public void assertNotSerialized()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/kernel/Query.html#assertNotSerialized()">Query</a></code></strong></div> |
| <div class="block">Check that the query has not been serialized, which causes it to lose |
| its association with its Broker.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/kernel/Query.html#assertNotSerialized()">assertNotSerialized</a></code> in interface <code><a href="../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="assertParameters(org.apache.openjpa.kernel.StoreQuery, org.apache.openjpa.kernel.StoreQuery.Executor, java.lang.Object[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assertParameters</h4> |
| <pre>protected void assertParameters(<a href="../../../../org/apache/openjpa/kernel/StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a> q, |
| <a href="../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel">StoreQuery.Executor</a> ex, |
| <a href="http://download.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">Checks that the passed parameters match the declarations.</div> |
| </li> |
| </ul> |
| <a name="assertParameters(org.apache.openjpa.kernel.StoreQuery, org.apache.openjpa.kernel.StoreQuery.Executor, java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assertParameters</h4> |
| <pre>protected void assertParameters(<a href="../../../../org/apache/openjpa/kernel/StoreQuery.html" title="interface in org.apache.openjpa.kernel">StoreQuery</a> q, |
| <a href="../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel">StoreQuery.Executor</a> ex, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> params)</pre> |
| </li> |
| </ul> |
| <a name="toString()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><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/QueryImpl.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/QueryHints.html" title="interface in org.apache.openjpa.kernel"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/kernel/QueryImpl.Compilation.html" title="class 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/QueryImpl.html" target="_top">Frames</a></li> |
| <li><a href="QueryImpl.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><a href="#nested_class_summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2006–2016 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |