blob: a9c078eab7c4547795da4662cfa506d982569057 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="it">
<head>
<!-- Generated by javadoc (1.8.0_171) on Thu Jun 14 10:06:05 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>StoreQuery (OpenJPA Parent POM 3.0.0 API)</title>
<meta name="date" content="2018-06-14">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="StoreQuery (OpenJPA Parent POM 3.0.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/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="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel"><span class="typeNameLink">Next&nbsp;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&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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://docs.oracle.com/javase/8/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>, <a href="../../../../org/apache/openjpa/jdbc/kernel/StoredProcedureQuery.html" title="class in org.apache.openjpa.jdbc.kernel">StoredProcedureQuery</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">StoreQuery</span>
extends <a href="../../../../org/apache/openjpa/kernel/QueryOperations.html" title="interface in org.apache.openjpa.kernel">QueryOperations</a>, <a href="http://docs.oracle.com/javase/8/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="simpleTagLabel">Since:</span></dt>
<dd>0.4.0</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Abe White</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" 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">&nbsp;</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&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel">StoreQuery.Executor</a></span></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&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/StoreQuery.Range.html" title="class in org.apache.openjpa.kernel">StoreQuery.Range</a></span></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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#EMPTY_BOOLEANS">EMPTY_BOOLEANS</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#EMPTY_CLASSES">EMPTY_CLASSES</a></span></code>&nbsp;</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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#EMPTY_METAS">EMPTY_METAS</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#EMPTY_OBJECTS">EMPTY_OBJECTS</a></span></code>&nbsp;</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>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#EMPTY_ORDERED_PARAMS">EMPTY_ORDERED_PARAMS</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static org.apache.commons.collections.map.LinkedMap</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#EMPTY_PARAMS">EMPTY_PARAMS</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#EMPTY_STRINGS">EMPTY_STRINGS</a></span></code>&nbsp;</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&nbsp;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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#evaluate-java.lang.Object-java.lang.Object-java.lang.Object:A-org.apache.openjpa.kernel.OpenJPAStateManager-">evaluate</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;ob,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[]&nbsp;params,
<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/exps/AggregateListener.html" title="interface in org.apache.openjpa.kernel.exps">AggregateListener</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#getAggregateListener-java.lang.String-">getAggregateListener</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;tag)</code>
<div class="block">Return the standard filter listener for the given tag, or null.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#getCompilation--">getCompilation</a></span>()</code>
<div class="block">Get the current compilation for this query.</div>
</td>
</tr>
<tr id="i3" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#getContext--">getContext</a></span>()</code>
<div class="block">Return the query context that has been set.</div>
</td>
</tr>
<tr id="i4" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#getFilterListener-java.lang.String-">getFilterListener</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;tag)</code>
<div class="block">Return the standard filter listener for the given tag, or null.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#invalidateCompilation--">invalidateCompilation</a></span>()</code>
<div class="block">Invalidate any internal compilation state.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#newCompilation--">newCompilation</a></span>()</code>
<div class="block">Create a new compilation for this query.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#newCompilationKey--">newCompilationKey</a></span>()</code>
<div class="block">Create a new key for caching compiled query information.</div>
</td>
</tr>
<tr id="i8" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#newDataStoreExecutor-org.apache.openjpa.meta.ClassMetaData-boolean-">newDataStoreExecutor</a></span>(<a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>&nbsp;meta,
boolean&nbsp;subs)</code>
<div class="block">Return an executor for datastore execution of this query.</div>
</td>
</tr>
<tr id="i9" 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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#newInMemoryExecutor-org.apache.openjpa.meta.ClassMetaData-boolean-">newInMemoryExecutor</a></span>(<a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>&nbsp;meta,
boolean&nbsp;subs)</code>
<div class="block">Return an executor for in-memory execution of this query.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#populateFromCompilation-java.lang.Object-">populateFromCompilation</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;comp)</code>
<div class="block">Populate internal data from compilation.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#requiresCandidateType--">requiresCandidateType</a></span>()</code>
<div class="block">Whether this query requires a candidate class.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#requiresParameterDeclarations--">requiresParameterDeclarations</a></span>()</code>
<div class="block">Whether this query requires parameters to be declared.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#setContext-org.apache.openjpa.kernel.QueryContext-">setContext</a></span>(<a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a>&nbsp;ctx)</code>
<div class="block">Set the current query context.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#setQuery-java.lang.Object-">setQuery</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;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 id="i15" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#supportsAbstractExecutors--">supportsAbstractExecutors</a></span>()</code>
<div class="block">Return true if this query supports execution against abstract or
interface types.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#supportsDataStoreExecution--">supportsDataStoreExecution</a></span>()</code>
<div class="block">True if this query supports datastore execution, false if it
can only run in memory.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#supportsInMemoryExecution--">supportsInMemoryExecution</a></span>()</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 id="i18" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/StoreQuery.html#supportsParameterDeclarations--">supportsParameterDeclarations</a></span>()</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&nbsp;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&nbsp;<a href="../../../../org/apache/openjpa/lib/util/OrderedMap.html" title="class in org.apache.openjpa.lib.util">OrderedMap</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&gt; EMPTY_ORDERED_PARAMS</pre>
</li>
</ul>
<a name="EMPTY_METAS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EMPTY_METAS</h4>
<pre>static final&nbsp;<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&nbsp;<a href="http://docs.oracle.com/javase/8/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&nbsp;<a href="http://docs.oracle.com/javase/8/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&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;[] EMPTY_CLASSES</pre>
</li>
</ul>
<a name="EMPTY_BOOLEANS">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>EMPTY_BOOLEANS</h4>
<pre>static final&nbsp;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>&nbsp;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&nbsp;setContext(<a href="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</a>&nbsp;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&nbsp;setQuery(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;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>&nbsp;getFilterListener(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;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>&nbsp;getAggregateListener(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;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://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;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://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;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://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;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&nbsp;populateFromCompilation(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;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&nbsp;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&nbsp;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&nbsp;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>&nbsp;newInMemoryExecutor(<a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>&nbsp;meta,
boolean&nbsp;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="paramLabel">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>&nbsp;newDataStoreExecutor(<a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>&nbsp;meta,
boolean&nbsp;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="paramLabel">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&nbsp;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&nbsp;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&nbsp;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&nbsp;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:A-org.apache.openjpa.kernel.OpenJPAStateManager-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>evaluate</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;evaluate(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;ob,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[]&nbsp;params,
<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/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="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel"><span class="typeNameLink">Next&nbsp;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&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 2006&#x2013;2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>