| <!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>StoreQuery (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="StoreQuery (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/StoreQuery.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/StoreManager.html" title="interface in org.apache.openjpa.kernel"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/kernel/StoreQuery.html" target="_top">Frames</a></li> |
| <li><a href="StoreQuery.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><a href="#field_summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.openjpa.kernel</div> |
| <h2 title="Interface StoreQuery" class="title">Interface StoreQuery</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../org/apache/openjpa/kernel/QueryOperations.html" title="interface in org.apache.openjpa.kernel">QueryOperations</a>, <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></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html" title="class in org.apache.openjpa.kernel">AbstractStoreQuery</a>, <a href="../../../../org/apache/openjpa/kernel/ExpressionStoreQuery.html" title="class in org.apache.openjpa.kernel">ExpressionStoreQuery</a>, <a href="../../../../org/apache/openjpa/jdbc/kernel/JDBCStoreQuery.html" title="class in org.apache.openjpa.jdbc.kernel">JDBCStoreQuery</a>, <a href="../../../../org/apache/openjpa/kernel/MethodStoreQuery.html" title="class in org.apache.openjpa.kernel">MethodStoreQuery</a>, <a href="../../../../org/apache/openjpa/jdbc/kernel/PreparedSQLStoreQuery.html" title="class in org.apache.openjpa.jdbc.kernel">PreparedSQLStoreQuery</a>, <a href="../../../../org/apache/openjpa/datacache/QueryCacheStoreQuery.html" title="class in org.apache.openjpa.datacache">QueryCacheStoreQuery</a>, <a href="../../../../org/apache/openjpa/jdbc/kernel/SQLStoreQuery.html" title="class in org.apache.openjpa.jdbc.kernel">SQLStoreQuery</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">StoreQuery</span> |
| extends <a href="../../../../org/apache/openjpa/kernel/QueryOperations.html" title="interface in org.apache.openjpa.kernel">QueryOperations</a>, <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></pre> |
| <div class="block">Component that executes queries against the datastore. For |
| expression-based queries, consider subclassing |
| <code>ExpressionStoreManagerQuery</code>.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>0.4.0</dd> |
| <dt><span class="strong">Author:</span></dt> |
| <dd>Abe White</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">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel">StoreQuery.Executor</a></strong></code> |
| <div class="block">An executor provides a uniform interface to the mechanism for executing |
| either an in-memory or datastore query.</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/StoreQuery.Range.html" title="class in org.apache.openjpa.kernel">StoreQuery.Range</a></strong></code> |
| <div class="block">A query result range.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static boolean[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#EMPTY_BOOLEANS">EMPTY_BOOLEANS</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/StoreQuery.html#EMPTY_CLASSES">EMPTY_CLASSES</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/StoreQuery.html#EMPTY_METAS">EMPTY_METAS</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/StoreQuery.html#EMPTY_OBJECTS">EMPTY_OBJECTS</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/StoreQuery.html#EMPTY_ORDERED_PARAMS">EMPTY_ORDERED_PARAMS</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static org.apache.commons.collections.map.LinkedMap</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#EMPTY_PARAMS">EMPTY_PARAMS</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/StoreQuery.html#EMPTY_STRINGS">EMPTY_STRINGS</a></strong></code> </td> |
| </tr> |
| </table> |
| <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> |
| </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><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/StoreQuery.html#evaluate(java.lang.Object,%20java.lang.Object,%20java.lang.Object[],%20org.apache.openjpa.kernel.OpenJPAStateManager)">evaluate</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> value, |
| <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> ob, |
| <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, |
| <a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/exps/AggregateListener.html" title="interface in org.apache.openjpa.kernel.exps">AggregateListener</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/StoreQuery.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 standard 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/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/StoreQuery.html#getCompilation()">getCompilation</a></strong>()</code> |
| <div class="block">Get the current compilation for this query.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#getContext()">getContext</a></strong>()</code> |
| <div class="block">Return the query context that has been set.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <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/StoreQuery.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 standard filter listener for the given tag, or null.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#invalidateCompilation()">invalidateCompilation</a></strong>()</code> |
| <div class="block">Invalidate any internal compilation state.</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/StoreQuery.html#newCompilation()">newCompilation</a></strong>()</code> |
| <div class="block">Create a new compilation 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/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/StoreQuery.html#newCompilationKey()">newCompilationKey</a></strong>()</code> |
| <div class="block">Create a new key for caching compiled query information.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel">StoreQuery.Executor</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#newDataStoreExecutor(org.apache.openjpa.meta.ClassMetaData,%20boolean)">newDataStoreExecutor</a></strong>(<a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> meta, |
| boolean subs)</code> |
| <div class="block">Return an executor for datastore execution of this query.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel">StoreQuery.Executor</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#newInMemoryExecutor(org.apache.openjpa.meta.ClassMetaData,%20boolean)">newInMemoryExecutor</a></strong>(<a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> meta, |
| boolean subs)</code> |
| <div class="block">Return an executor for in-memory execution of 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/StoreQuery.html#populateFromCompilation(java.lang.Object)">populateFromCompilation</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> comp)</code> |
| <div class="block">Populate internal data from compilation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#requiresCandidateType()">requiresCandidateType</a></strong>()</code> |
| <div class="block">Whether this query requires a candidate class.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#requiresParameterDeclarations()">requiresParameterDeclarations</a></strong>()</code> |
| <div class="block">Whether this query requires parameters to be declared.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#setContext(org.apache.openjpa.kernel.QueryContext)">setContext</a></strong>(<a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a> ctx)</code> |
| <div class="block">Set the current query context.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/StoreQuery.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">This is invoked when the user or a facade creates a new query with |
| an object that the system does not recognize.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#supportsAbstractExecutors()">supportsAbstractExecutors</a></strong>()</code> |
| <div class="block">Return true if this query supports execution against abstract or |
| interface types.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#supportsDataStoreExecution()">supportsDataStoreExecution</a></strong>()</code> |
| <div class="block">True if this query supports datastore execution, false if it |
| can only run in memory.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#supportsInMemoryExecution()">supportsInMemoryExecution</a></strong>()</code> |
| <div class="block">True if this query supports in-memory execution, false if it |
| can only run against the datastore.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#supportsParameterDeclarations()">supportsParameterDeclarations</a></strong>()</code> |
| <div class="block">Whether this query supports declared parameters.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="EMPTY_PARAMS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>EMPTY_PARAMS</h4> |
| <pre>static final org.apache.commons.collections.map.LinkedMap EMPTY_PARAMS</pre> |
| </li> |
| </ul> |
| <a name="EMPTY_ORDERED_PARAMS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>EMPTY_ORDERED_PARAMS</h4> |
| <pre>static final <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><?>> EMPTY_ORDERED_PARAMS</pre> |
| </li> |
| </ul> |
| <a name="EMPTY_METAS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>EMPTY_METAS</h4> |
| <pre>static final <a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>[] EMPTY_METAS</pre> |
| </li> |
| </ul> |
| <a name="EMPTY_STRINGS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>EMPTY_STRINGS</h4> |
| <pre>static final <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>[] EMPTY_STRINGS</pre> |
| </li> |
| </ul> |
| <a name="EMPTY_OBJECTS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>EMPTY_OBJECTS</h4> |
| <pre>static final <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>[] EMPTY_OBJECTS</pre> |
| </li> |
| </ul> |
| <a name="EMPTY_CLASSES"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>EMPTY_CLASSES</h4> |
| <pre>static final <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><?>[] EMPTY_CLASSES</pre> |
| </li> |
| </ul> |
| <a name="EMPTY_BOOLEANS"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>EMPTY_BOOLEANS</h4> |
| <pre>static final boolean[] EMPTY_BOOLEANS</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getContext()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContext</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a> getContext()</pre> |
| <div class="block">Return the query context that has been set.</div> |
| </li> |
| </ul> |
| <a name="setContext(org.apache.openjpa.kernel.QueryContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setContext</h4> |
| <pre>void setContext(<a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a> ctx)</pre> |
| <div class="block">Set the current query context. This will be called before use.</div> |
| </li> |
| </ul> |
| <a name="setQuery(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setQuery</h4> |
| <pre>boolean setQuery(<a href="http://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">This is invoked when the user or a facade creates a new query with |
| an object that the system does not recognize. Return true if |
| the object is recognized by the store, false otherwise.</div> |
| </li> |
| </ul> |
| <a name="getFilterListener(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFilterListener</h4> |
| <pre><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">Return the standard filter listener for the given tag, or null.</div> |
| </li> |
| </ul> |
| <a name="getAggregateListener(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAggregateListener</h4> |
| <pre><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">Return the standard filter listener for the given tag, or null.</div> |
| </li> |
| </ul> |
| <a name="newCompilationKey()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newCompilationKey</h4> |
| <pre><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> newCompilationKey()</pre> |
| <div class="block">Create a new key for caching compiled query information. May be null.</div> |
| </li> |
| </ul> |
| <a name="newCompilation()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newCompilation</h4> |
| <pre><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> newCompilation()</pre> |
| <div class="block">Create a new compilation for this query. May be null.</div> |
| </li> |
| </ul> |
| <a name="getCompilation()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCompilation</h4> |
| <pre><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">Get the current compilation for this query. If it is null, do not create.</div> |
| </li> |
| </ul> |
| <a name="populateFromCompilation(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>populateFromCompilation</h4> |
| <pre>void populateFromCompilation(<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> comp)</pre> |
| <div class="block">Populate internal data from compilation.</div> |
| </li> |
| </ul> |
| <a name="invalidateCompilation()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invalidateCompilation</h4> |
| <pre>void invalidateCompilation()</pre> |
| <div class="block">Invalidate any internal compilation state.</div> |
| </li> |
| </ul> |
| <a name="supportsDataStoreExecution()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>supportsDataStoreExecution</h4> |
| <pre>boolean supportsDataStoreExecution()</pre> |
| <div class="block">True if this query supports datastore execution, false if it |
| can only run in memory.</div> |
| </li> |
| </ul> |
| <a name="supportsInMemoryExecution()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>supportsInMemoryExecution</h4> |
| <pre>boolean supportsInMemoryExecution()</pre> |
| <div class="block">True if this query supports in-memory execution, false if it |
| can only run against the datastore.</div> |
| </li> |
| </ul> |
| <a name="newInMemoryExecutor(org.apache.openjpa.meta.ClassMetaData, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newInMemoryExecutor</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel">StoreQuery.Executor</a> newInMemoryExecutor(<a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> meta, |
| boolean subs)</pre> |
| <div class="block">Return an executor for in-memory execution of this query. |
| Executors must be cachable and thread safe. If this class returns |
| true from <a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#supportsAbstractExecutors()"><code>supportsAbstractExecutors()</code></a>, the given metadata |
| will always be for the candidate class of this query, or possibly |
| null if the candidate class is not itself persistence capable (like |
| an interface or abstract base class). Otherwise, the given type will |
| be a mapped class.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>subs</code> - whether to include dependent mapped subclasses in the |
| results; independent subclasses should never be included</dd></dl> |
| </li> |
| </ul> |
| <a name="newDataStoreExecutor(org.apache.openjpa.meta.ClassMetaData, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newDataStoreExecutor</h4> |
| <pre><a href="../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel">StoreQuery.Executor</a> newDataStoreExecutor(<a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> meta, |
| boolean subs)</pre> |
| <div class="block">Return an executor for datastore execution of this query. |
| Executors must be cachable and thread safe. If this class returns |
| true from <a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#supportsAbstractExecutors()"><code>supportsAbstractExecutors()</code></a>, the given metadata |
| will always be for the candidate class of this query, or possibly |
| null if the candidate class is not itself persistence capable (like |
| an interface or abstract base class). Otherwise, the given type will |
| be a mapped class.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>subs</code> - whether to include dependent mapped subclasses in the |
| results; independent subclasses should never be included</dd></dl> |
| </li> |
| </ul> |
| <a name="supportsAbstractExecutors()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>supportsAbstractExecutors</h4> |
| <pre>boolean supportsAbstractExecutors()</pre> |
| <div class="block">Return true if this query supports execution against abstract or |
| interface types. Returns false by default, meaning we will only |
| request executors for persistent classes. In this case, we will |
| automatically combine the results of the executors for all |
| implementing classes if we execute a query for an interface for |
| abstract type.</div> |
| </li> |
| </ul> |
| <a name="requiresCandidateType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>requiresCandidateType</h4> |
| <pre>boolean requiresCandidateType()</pre> |
| <div class="block">Whether this query requires a candidate class.</div> |
| </li> |
| </ul> |
| <a name="requiresParameterDeclarations()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>requiresParameterDeclarations</h4> |
| <pre>boolean requiresParameterDeclarations()</pre> |
| <div class="block">Whether this query requires parameters to be declared.</div> |
| </li> |
| </ul> |
| <a name="supportsParameterDeclarations()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>supportsParameterDeclarations</h4> |
| <pre>boolean supportsParameterDeclarations()</pre> |
| <div class="block">Whether this query supports declared parameters.</div> |
| </li> |
| </ul> |
| <a name="evaluate(java.lang.Object, java.lang.Object, java.lang.Object[], org.apache.openjpa.kernel.OpenJPAStateManager)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>evaluate</h4> |
| <pre><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> evaluate(<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> value, |
| <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> ob, |
| <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, |
| <a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm)</pre> |
| </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/StoreQuery.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/StoreManager.html" title="interface in org.apache.openjpa.kernel"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/kernel/StoreQuery.html" target="_top">Frames</a></li> |
| <li><a href="StoreQuery.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><a href="#field_summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2006–2016 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |