Google Git
Sign in
apache / cayenne-website / 626d8c1d90628349118d991467d8b423be9e228e / . / src / main / site / static / docs / 4.2 / api / org / apache / cayenne / query / EJBQLQuery.html
blob: 20bb3f47c7c2acd554490554e61c284174add3d1 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.10) on Mon Dec 05 10:27:04 MSK 2022 -->
<title>EJBQLQuery (cayenne-doc: Cayenne Documentation 4.2.RC2 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-12-05">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="EJBQLQuery (cayenne-doc: Cayenne Documentation 4.2.RC2 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = false;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/EJBQLQuery.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 class="aboutLanguage"><a href="http://cayenne.apache.org" target="top">Apache Cayenne</a></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.cayenne.query</a></div>
<h2 title="Class EJBQLQuery" class="title">Class EJBQLQuery</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="CacheableQuery.html" title="class in org.apache.cayenne.query">org.apache.cayenne.query.CacheableQuery</a></li>
<li>
<ul class="inheritance">
<li>org.apache.cayenne.query.EJBQLQuery</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code>, <code><a href="Query.html" title="interface in org.apache.cayenne.query">Query</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">EJBQLQuery</span>
extends <a href="CacheableQuery.html" title="class in org.apache.cayenne.query">CacheableQuery</a></pre>
<div class="block">An EJBQL query representation in Cayenne.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../serialized-form.html#org.apache.cayenne.query.EJBQLQuery">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ejbqlStatement">ejbqlStatement</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../ejbql/EJBQLCompiledExpression.html" title="interface in org.apache.cayenne.ejbql">EJBQLCompiledExpression</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#expression">expression</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#namedParameters">namedParameters</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#positionalParameters">positionalParameters</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.apache.cayenne.query.CacheableQuery">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.cayenne.query.<a href="CacheableQuery.html" title="class in org.apache.cayenne.query">CacheableQuery</a></h3>
<code><a href="CacheableQuery.html#logger">logger</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">EJBQLQuery</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String)">EJBQLQuery</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;ejbqlStatement)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createSQLAction(org.apache.cayenne.query.SQLActionVisitor)">createSQLAction</a></span>&#8203;(<a href="SQLActionVisitor.html" title="interface in org.apache.cayenne.query">SQLActionVisitor</a>&nbsp;visitor)</code></th>
<td class="colLast">
<div class="block">A callback method invoked by Cayenne during the final execution phase of the query
run.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected org.apache.cayenne.query.BaseQueryMetadata</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBaseMetaData()">getBaseMetaData</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEjbqlStatement()">getEjbqlStatement</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns an unparsed EJB QL statement used to initialize this query.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../ejbql/EJBQLCompiledExpression.html" title="interface in org.apache.cayenne.ejbql">EJBQLCompiledExpression</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExpression(org.apache.cayenne.map.EntityResolver)">getExpression</a></span>&#8203;(<a href="../map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a>&nbsp;resolver)</code></th>
<td class="colLast">
<div class="block">Returns lazily initialized EJBQLCompiledExpression for this query EJBQL.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFetchLimit()">getFetchLimit</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the fetchLimit property indicating the maximum number of rows this query
would return.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFetchOffset()">getFetchOffset</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="QueryMetadata.html" title="interface in org.apache.cayenne.query">QueryMetadata</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMetaData(org.apache.cayenne.map.EntityResolver)">getMetaData</a></span>&#8203;(<a href="../map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a>&nbsp;resolver)</code></th>
<td class="colLast">
<div class="block">Returns query runtime parameters.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNamedParameters()">getNamedParameters</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns unmodifiable map of combined named and positional parameters.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPageSize()">getPageSize</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPositionalParameters()">getPositionalParameters</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQueryTimeout()">getQueryTimeout</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStatementFetchSize()">getStatementFetchSize</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#initWithProperties(java.util.Map)">initWithProperties</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;?&gt;&nbsp;properties)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isFetchingDataRows()">isFetchingDataRows</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#route(org.apache.cayenne.query.QueryRouter,org.apache.cayenne.map.EntityResolver,org.apache.cayenne.query.Query)">route</a></span>&#8203;(<a href="QueryRouter.html" title="interface in org.apache.cayenne.query">QueryRouter</a>&nbsp;router,
<a href="../map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a>&nbsp;resolver,
<a href="Query.html" title="interface in org.apache.cayenne.query">Query</a>&nbsp;substitutedQuery)</code></th>
<td class="colLast">
<div class="block">A callback method invoked by Cayenne during the routing phase of the query
execution.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setEjbqlStatement(java.lang.String)">setEjbqlStatement</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;text)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setFetchingDataRows(boolean)">setFetchingDataRows</a></span>&#8203;(boolean&nbsp;flag)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setFetchLimit(int)">setFetchLimit</a></span>&#8203;(int&nbsp;fetchLimit)</code></th>
<td class="colLast">
<div class="block">Sets the fetchLimit property indicating the maximum number of rows this query would
return.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setFetchOffset(int)">setFetchOffset</a></span>&#8203;(int&nbsp;fetchOffset)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPageSize(int)">setPageSize</a></span>&#8203;(int&nbsp;pageSize)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setParameter(int,java.lang.Object)">setParameter</a></span>&#8203;(int&nbsp;position,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;object)</code></th>
<td class="colLast">
<div class="block">Sets a positional query parameter value.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setParameter(java.lang.String,java.lang.Object)">setParameter</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;object)</code></th>
<td class="colLast">
<div class="block">Sets a named query parameter value.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setQueryTimeout(int)">setQueryTimeout</a></span>&#8203;(int&nbsp;queryTimeout)</code></th>
<td class="colLast">
<div class="block">Sets query timeout.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setStatementFetchSize(int)">setStatementFetchSize</a></span>&#8203;(int&nbsp;size)</code></th>
<td class="colLast">
<div class="block">Sets statement's fetch size (0 for no default size)</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.cayenne.query.CacheableQuery">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.cayenne.query.<a href="CacheableQuery.html" title="class in org.apache.cayenne.query">CacheableQuery</a></h3>
<code><a href="CacheableQuery.html#getCacheGroup()">getCacheGroup</a>, <a href="CacheableQuery.html#getCacheStrategy()">getCacheStrategy</a>, <a href="CacheableQuery.html#setCacheGroup(java.lang.String)">setCacheGroup</a>, <a href="CacheableQuery.html#setCacheStrategy(org.apache.cayenne.query.QueryCacheStrategy)">setCacheStrategy</a>, <a href="CacheableQuery.html#useLocalCache()">useLocalCache</a>, <a href="CacheableQuery.html#useLocalCache(java.lang.String)">useLocalCache</a>, <a href="CacheableQuery.html#useSharedCache()">useSharedCache</a>, <a href="CacheableQuery.html#useSharedCache(java.lang.String)">useSharedCache</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="ejbqlStatement">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ejbqlStatement</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> ejbqlStatement</pre>
</li>
</ul>
<a id="namedParameters">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>namedParameters</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt; namedParameters</pre>
</li>
</ul>
<a id="positionalParameters">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>positionalParameters</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt; positionalParameters</pre>
</li>
</ul>
<a id="expression">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>expression</h4>
<pre>protected transient&nbsp;<a href="../ejbql/EJBQLCompiledExpression.html" title="interface in org.apache.cayenne.ejbql">EJBQLCompiledExpression</a> expression</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EJBQLQuery</h4>
<pre>public&nbsp;EJBQLQuery&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;ejbqlStatement)</pre>
</li>
</ul>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>EJBQLQuery</h4>
<pre>public&nbsp;EJBQLQuery()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="initWithProperties(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initWithProperties</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;initWithProperties&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;?&gt;&nbsp;properties)</pre>
</li>
</ul>
<a id="getMetaData(org.apache.cayenne.map.EntityResolver)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetaData</h4>
<pre class="methodSignature">public&nbsp;<a href="QueryMetadata.html" title="interface in org.apache.cayenne.query">QueryMetadata</a>&nbsp;getMetaData&#8203;(<a href="../map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a>&nbsp;resolver)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="Query.html#getMetaData(org.apache.cayenne.map.EntityResolver)">Query</a></code></span></div>
<div class="block">Returns query runtime parameters. The method is called at various stages of the
execution by Cayenne access stack to retrieve query parameters. EntityResolver
instance is passed to this method, meaning that the query doesn't need to store
direct references to Cayenne mapping objects and can resolve them at runtime.</div>
</li>
</ul>
<a id="isFetchingDataRows()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFetchingDataRows</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isFetchingDataRows()</pre>
</li>
</ul>
<a id="setFetchingDataRows(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFetchingDataRows</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setFetchingDataRows&#8203;(boolean&nbsp;flag)</pre>
</li>
</ul>
<a id="getBaseMetaData()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBaseMetaData</h4>
<pre class="methodSignature">protected&nbsp;org.apache.cayenne.query.BaseQueryMetadata&nbsp;getBaseMetaData()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="CacheableQuery.html#getBaseMetaData()">getBaseMetaData</a></code>&nbsp;in class&nbsp;<code><a href="CacheableQuery.html" title="class in org.apache.cayenne.query">CacheableQuery</a></code></dd>
</dl>
</li>
</ul>
<a id="route(org.apache.cayenne.query.QueryRouter,org.apache.cayenne.map.EntityResolver,org.apache.cayenne.query.Query)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>route</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;route&#8203;(<a href="QueryRouter.html" title="interface in org.apache.cayenne.query">QueryRouter</a>&nbsp;router,
<a href="../map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a>&nbsp;resolver,
<a href="Query.html" title="interface in org.apache.cayenne.query">Query</a>&nbsp;substitutedQuery)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="Query.html#route(org.apache.cayenne.query.QueryRouter,org.apache.cayenne.map.EntityResolver,org.apache.cayenne.query.Query)">Query</a></code></span></div>
<div class="block">A callback method invoked by Cayenne during the routing phase of the query
execution. Mapping of DataNodes is provided by QueryRouter. Query should use a
<a href="QueryRouter.html#route(org.apache.cayenne.access.QueryEngine,org.apache.cayenne.query.Query,org.apache.cayenne.query.Query)"><code>QueryRouter.route(QueryEngine, Query, Query)</code></a> callback method to route
itself. Query can create one or more substitute queries or even provide its own
QueryEngine to execute itself.</div>
</li>
</ul>
<a id="createSQLAction(org.apache.cayenne.query.SQLActionVisitor)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSQLAction</h4>
<pre class="methodSignature">public&nbsp;<a href="SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</a>&nbsp;createSQLAction&#8203;(<a href="SQLActionVisitor.html" title="interface in org.apache.cayenne.query">SQLActionVisitor</a>&nbsp;visitor)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="Query.html#createSQLAction(org.apache.cayenne.query.SQLActionVisitor)">Query</a></code></span></div>
<div class="block">A callback method invoked by Cayenne during the final execution phase of the query
run. A concrete query implementation is given a chance to decide how it should be
handled. Implementors can pick an appropriate method of the SQLActionVisitor to
handle itself, create a custom SQLAction of its own, or substitute itself with
another query that should be used for SQLAction construction.</div>
</li>
</ul>
<a id="getEjbqlStatement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEjbqlStatement</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;getEjbqlStatement()</pre>
<div class="block">Returns an unparsed EJB QL statement used to initialize this query.</div>
</li>
</ul>
<a id="getExpression(org.apache.cayenne.map.EntityResolver)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExpression</h4>
<pre class="methodSignature">public&nbsp;<a href="../ejbql/EJBQLCompiledExpression.html" title="interface in org.apache.cayenne.ejbql">EJBQLCompiledExpression</a>&nbsp;getExpression&#8203;(<a href="../map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a>&nbsp;resolver)
throws <a href="../ejbql/EJBQLException.html" title="class in org.apache.cayenne.ejbql">EJBQLException</a></pre>
<div class="block">Returns lazily initialized EJBQLCompiledExpression for this query EJBQL.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../ejbql/EJBQLException.html" title="class in org.apache.cayenne.ejbql">EJBQLException</a></code></dd>
</dl>
</li>
</ul>
<a id="getNamedParameters()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNamedParameters</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;&nbsp;getNamedParameters()</pre>
<div class="block">Returns unmodifiable map of combined named and positional parameters. Positional
parameter keys are Integers, while named parameter keys are strings.</div>
</li>
</ul>
<a id="getPositionalParameters()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPositionalParameters</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;&nbsp;getPositionalParameters()</pre>
</li>
</ul>
<a id="setParameter(java.lang.String,java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setParameter</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setParameter&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;object)</pre>
<div class="block">Sets a named query parameter value.</div>
</li>
</ul>
<a id="setParameter(int,java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setParameter</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setParameter&#8203;(int&nbsp;position,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;object)</pre>
<div class="block">Sets a positional query parameter value. Note that parameter indexes are starting from 1.</div>
</li>
</ul>
<a id="getFetchLimit()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFetchLimit</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getFetchLimit()</pre>
<div class="block">Returns the fetchLimit property indicating the maximum number of rows this query
would return.</div>
</li>
</ul>
<a id="setFetchLimit(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFetchLimit</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setFetchLimit&#8203;(int&nbsp;fetchLimit)</pre>
<div class="block">Sets the fetchLimit property indicating the maximum number of rows this query would
return.</div>
</li>
</ul>
<a id="getFetchOffset()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFetchOffset</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getFetchOffset()</pre>
</li>
</ul>
<a id="setFetchOffset(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFetchOffset</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setFetchOffset&#8203;(int&nbsp;fetchOffset)</pre>
</li>
</ul>
<a id="setEjbqlStatement(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEjbqlStatement</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setEjbqlStatement&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;text)</pre>
</li>
</ul>
<a id="getPageSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPageSize</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getPageSize()</pre>
</li>
</ul>
<a id="setPageSize(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPageSize</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setPageSize&#8203;(int&nbsp;pageSize)</pre>
</li>
</ul>
<a id="setStatementFetchSize(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStatementFetchSize</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setStatementFetchSize&#8203;(int&nbsp;size)</pre>
<div class="block">Sets statement's fetch size (0 for no default size)</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a id="getStatementFetchSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStatementFetchSize</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getStatementFetchSize()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>statement's fetch size</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a id="setQueryTimeout(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setQueryTimeout</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setQueryTimeout&#8203;(int&nbsp;queryTimeout)</pre>
<div class="block">Sets query timeout.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.2</dd>
</dl>
</li>
</ul>
<a id="getQueryTimeout()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getQueryTimeout</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getQueryTimeout()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>query timeout</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.2</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/EJBQLQuery.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 class="aboutLanguage"><a href="http://cayenne.apache.org" target="top">Apache Cayenne</a></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2001&#x2013;2022 <a href="https://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p>
</footer>
</body>
</html>