Google Git
Sign in
apache / cayenne-website / 626d8c1d90628349118d991467d8b423be9e228e / . / src / main / site / static / docs / 4.2 / api / org / apache / cayenne / query / ProcedureQuery.html
blob: fc3dbc2e395c9e6464c5ed9489c735a3d3f5627d [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>ProcedureQuery (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="ProcedureQuery (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,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":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/ProcedureQuery.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 ProcedureQuery" class="title">Class ProcedureQuery</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><a href="AbstractQuery.html" title="class in org.apache.cayenne.query">org.apache.cayenne.query.AbstractQuery</a></li>
<li>
<ul class="inheritance">
<li>org.apache.cayenne.query.ProcedureQuery</li>
</ul>
</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="ParameterizedQuery.html" title="interface in org.apache.cayenne.query">ParameterizedQuery</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">ProcedureQuery</span>
extends <a href="AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</a>
implements <a href="ParameterizedQuery.html" title="interface in org.apache.cayenne.query">ParameterizedQuery</a></pre>
<div class="block">A query based on Procedure. Can be used as a select query, or as a query of an
arbitrary complexity, performing data modification, selecting data (possibly with
multiple result sets per call), returning values via OUT parameters.
<h3>Execution with DataContext</h3>
<h4>Reading OUT parameters</h4>
<p>
If a ProcedureQuery has OUT parameters, they are wrapped in a separate List in the
query result. Such list will contain a single Map with OUT parameter values.
</p>
<h4>Using ProcedureQuery as a GenericSelectQuery</h4>
<p>
Executing ProcedureQuery via
<a href="../access/DataContext.html#performQuery(org.apache.cayenne.query.Query)"><code>DataContext.performQuery(Query)</code></a> makes sense only if
the stored procedure returns a single result set (or alternatively returns a result via
OUT parameters and no other result sets). It is still OK if data modification occurs as
a side effect. However if the query returns more then one result set, a more generic
form should be used:
<a href="../access/DataContext.html#performGenericQuery(org.apache.cayenne.query.Query)"><code>DataContext.performGenericQuery(Query)</code></a>.
</p></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../serialized-form.html#org.apache.cayenne.query.ProcedureQuery">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>static <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="#COLUMN_NAME_CAPITALIZATION_PROPERTY">COLUMN_NAME_CAPITALIZATION_PROPERTY</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="CapsStrategy.html" title="enum in org.apache.cayenne.query">CapsStrategy</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#columnNamesCapitalization">columnNamesCapitalization</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="#parameters">parameters</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/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;?&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resultClass">resultClass</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/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="../access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</a>[]&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resultDescriptors">resultDescriptors</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/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="#resultEntityName">resultEntityName</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.AbstractQuery">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.cayenne.query.<a href="AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</a></h3>
<code><a href="AbstractQuery.html#root">root</a></code></li>
</ul>
<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()">ProcedureQuery</a></span>()</code></th>
<td class="colLast">
<div class="block">Creates an empty procedure query.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String)">ProcedureQuery</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;procedureName)</code></th>
<td class="colLast">
<div class="block">Creates a ProcedureQuery based on a stored procedure.</div>
</td>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,java.lang.Class)">ProcedureQuery</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;procedureName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;?&gt;&nbsp;resultType)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.cayenne.map.Procedure)">ProcedureQuery</a></span>&#8203;(<a href="../map/Procedure.html" title="class in org.apache.cayenne.map">Procedure</a>&nbsp;procedure)</code></th>
<td class="colLast">
<div class="block">Creates a ProcedureQuery based on a Procedure object.</div>
</td>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.cayenne.map.Procedure,java.lang.Class)">ProcedureQuery</a></span>&#8203;(<a href="../map/Procedure.html" title="class in org.apache.cayenne.map">Procedure</a>&nbsp;procedure,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;?&gt;&nbsp;resultType)</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>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addParameter(java.lang.String,java.lang.Object)">addParameter</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;value)</code></th>
<td class="colLast">
<div class="block">Adds a named parameter to the internal map of parameters.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addPrefetch(java.lang.String)">addPrefetch</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;prefetchPath)</code></th>
<td class="colLast">
<div class="block">Adds a prefetch.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addPrefetches(java.util.Collection)">addPrefetches</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</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>&gt;&nbsp;prefetches)</code></th>
<td class="colLast">
<div class="block">Adds all prefetches from a provided collection.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addResultDescriptor(org.apache.cayenne.access.jdbc.ColumnDescriptor%5B%5D)">addResultDescriptor</a></span>&#8203;(<a href="../access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</a>[]&nbsp;descriptor)</code></th>
<td class="colLast">
<div class="block">Adds a descriptor for a single ResultSet.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clearParameters()">clearParameters</a></span>()</code></th>
<td class="colLast">
<div class="block">Cleans up all configured parameters.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clearPrefetches()">clearPrefetches</a></span>()</code></th>
<td class="colLast">
<div class="block">Clears all prefetches.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="Query.html" title="interface in org.apache.cayenne.query">Query</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createQuery(java.util.Map)">createQuery</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;parameters)</code></th>
<td class="colLast">
<div class="block">Creates and returns a new ProcedureQuery built using this query as a prototype and
substituting template parameters with the values from the map.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<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">Calls "makeProcedure" on the visitor.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<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="i9" class="rowColor">
<td class="colFirst"><code><a href="CapsStrategy.html" title="enum in org.apache.cayenne.query">CapsStrategy</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getColumnNamesCapitalization()">getColumnNamesCapitalization</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="#getFetchLimit()">getFetchLimit</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="#getFetchOffset()">getFetchOffset</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" 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 default select parameters.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<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="i14" class="altColor">
<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;?&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParameters()">getParameters</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a map of procedure parameters.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPrefetchTree()">getPrefetchTree</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i16" 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="i17" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="../access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</a>[]&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResultDescriptors()">getResultDescriptors</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a List of descriptors for query ResultSets in the order they are returned
by the stored procedure.</div>
</td>
</tr>
<tr id="i18" 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="#getResultEntityName()">getResultEntityName</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i19" 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="i20" 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">
<div class="block">Initializes query parameters using a set of properties.</div>
</td>
</tr>
<tr id="i21" 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="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeParameter(java.lang.String)">removeParameter</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)</code></th>
<td class="colLast">&nbsp;</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="#removePrefetch(java.lang.String)">removePrefetch</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;prefetch)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeResultDescriptor(org.apache.cayenne.access.jdbc.ColumnDescriptor%5B%5D)">removeResultDescriptor</a></span>&#8203;(<a href="../access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</a>[]&nbsp;descriptor)</code></th>
<td class="colLast">
<div class="block">Removes result descriptor from the list of descriptors.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setColumnNamesCapitalization(org.apache.cayenne.query.CapsStrategy)">setColumnNamesCapitalization</a></span>&#8203;(<a href="CapsStrategy.html" title="enum in org.apache.cayenne.query">CapsStrategy</a>&nbsp;columnNameCapitalization)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i26" 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="i27" 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">&nbsp;</td>
</tr>
<tr id="i28" 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="i29" 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="i30" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setParameters(java.util.Map)">setParameters</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;parameters)</code></th>
<td class="colLast">
<div class="block">Sets a map of parameters.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<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;timeout)</code></th>
<td class="colLast">
<div class="block">Set's query timeout</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setResultEntityName(java.lang.String)">setResultEntityName</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;resultEntityName)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i33" 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.AbstractQuery">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.cayenne.query.<a href="AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</a></h3>
<code><a href="AbstractQuery.html#getRoot()">getRoot</a>, <a href="AbstractQuery.html#route(org.apache.cayenne.query.QueryRouter,org.apache.cayenne.map.EntityResolver,org.apache.cayenne.query.Query)">route</a>, <a href="AbstractQuery.html#setRoot(java.lang.Object)">setRoot</a>, <a href="AbstractQuery.html#toString()">toString</a></code></li>
</ul>
<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#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>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.cayenne.query.Query">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.cayenne.query.<a href="Query.html" title="interface in org.apache.cayenne.query">Query</a></h3>
<code><a href="Query.html#route(org.apache.cayenne.query.QueryRouter,org.apache.cayenne.map.EntityResolver,org.apache.cayenne.query.Query)">route</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="COLUMN_NAME_CAPITALIZATION_PROPERTY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>COLUMN_NAME_CAPITALIZATION_PROPERTY</h4>
<pre>public static final&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> COLUMN_NAME_CAPITALIZATION_PROPERTY</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.cayenne.query.ProcedureQuery.COLUMN_NAME_CAPITALIZATION_PROPERTY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="resultEntityName">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resultEntityName</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> resultEntityName</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a id="resultClass">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resultClass</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;?&gt; resultClass</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a id="columnNamesCapitalization">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>columnNamesCapitalization</h4>
<pre>protected&nbsp;<a href="CapsStrategy.html" title="enum in org.apache.cayenne.query">CapsStrategy</a> columnNamesCapitalization</pre>
</li>
</ul>
<a id="parameters">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parameters</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; parameters</pre>
</li>
</ul>
<a id="resultDescriptors">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>resultDescriptors</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="../access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</a>[]&gt; resultDescriptors</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</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;()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ProcedureQuery</h4>
<pre>public&nbsp;ProcedureQuery()</pre>
<div class="block">Creates an empty procedure query. The query would fetch DataRows. Fetching
Persistent objects can be achieved either by using
<a href="#%3Cinit%3E(java.lang.String,java.lang.Class)"><code>ProcedureQuery(String, Class)</code></a> constructor or by calling
<a href="#setFetchingDataRows(boolean)"><code>setFetchingDataRows(boolean)</code></a> and <a href="#setResultEntityName(java.lang.String)"><code>setResultEntityName(String)</code></a>
methods.</div>
</li>
</ul>
<a id="&lt;init&gt;(org.apache.cayenne.map.Procedure)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ProcedureQuery</h4>
<pre>public&nbsp;ProcedureQuery&#8203;(<a href="../map/Procedure.html" title="class in org.apache.cayenne.map">Procedure</a>&nbsp;procedure)</pre>
<div class="block">Creates a ProcedureQuery based on a Procedure object. The query would fetch
DataRows. Fetching Persistent objects can be achieved either by using
<a href="#%3Cinit%3E(java.lang.String,java.lang.Class)"><code>ProcedureQuery(String, Class)</code></a> constructor or by calling
<a href="#setFetchingDataRows(boolean)"><code>setFetchingDataRows(boolean)</code></a> and <a href="#setResultEntityName(java.lang.String)"><code>setResultEntityName(String)</code></a>
methods.</div>
</li>
</ul>
<a id="&lt;init&gt;(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ProcedureQuery</h4>
<pre>public&nbsp;ProcedureQuery&#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;procedureName)</pre>
<div class="block">Creates a ProcedureQuery based on a stored procedure. The query would fetch
DataRows. Fetching Persistent objects can be achieved either by using
<a href="#%3Cinit%3E(java.lang.String,java.lang.Class)"><code>ProcedureQuery(String, Class)</code></a> constructor or by calling
<a href="#setFetchingDataRows(boolean)"><code>setFetchingDataRows(boolean)</code></a> and <a href="#setResultEntityName(java.lang.String)"><code>setResultEntityName(String)</code></a>
methods.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>procedureName</code> - A name of the stored procedure. For this query to work, a
procedure with this name must be mapped in Cayenne.</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(org.apache.cayenne.map.Procedure,java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ProcedureQuery</h4>
<pre>public&nbsp;ProcedureQuery&#8203;(<a href="../map/Procedure.html" title="class in org.apache.cayenne.map">Procedure</a>&nbsp;procedure,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;?&gt;&nbsp;resultType)</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(java.lang.String,java.lang.Class)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ProcedureQuery</h4>
<pre>public&nbsp;ProcedureQuery&#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;procedureName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;?&gt;&nbsp;resultType)</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</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="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 class:&nbsp;<code><a href="AbstractQuery.html#getMetaData(org.apache.cayenne.map.EntityResolver)">AbstractQuery</a></code></span></div>
<div class="block">Returns default select parameters.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Query.html#getMetaData(org.apache.cayenne.map.EntityResolver)">getMetaData</a></code>&nbsp;in interface&nbsp;<code><a href="Query.html" title="interface in org.apache.cayenne.query">Query</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="AbstractQuery.html#getMetaData(org.apache.cayenne.map.EntityResolver)">getMetaData</a></code>&nbsp;in class&nbsp;<code><a href="AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</a></code></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a id="getResultDescriptors()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResultDescriptors</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="../access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</a>[]&gt;&nbsp;getResultDescriptors()</pre>
<div class="block">Returns a List of descriptors for query ResultSets in the order they are returned
by the stored procedure.
<p>
<i>Note that if a procedure returns ResultSet in an OUT parameter, it is returned
prior to any other result sets (though in practice database engines usually support
only one mechanism for returning result sets. </i>
</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a id="addResultDescriptor(org.apache.cayenne.access.jdbc.ColumnDescriptor[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addResultDescriptor</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;addResultDescriptor&#8203;(<a href="../access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</a>[]&nbsp;descriptor)</pre>
<div class="block">Adds a descriptor for a single ResultSet. More than one descriptor can be added by
calling this method multiple times in the order of described ResultSet appearance
in the procedure results.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a id="removeResultDescriptor(org.apache.cayenne.access.jdbc.ColumnDescriptor[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeResultDescriptor</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;removeResultDescriptor&#8203;(<a href="../access/jdbc/ColumnDescriptor.html" title="class in org.apache.cayenne.access.jdbc">ColumnDescriptor</a>[]&nbsp;descriptor)</pre>
<div class="block">Removes result descriptor from the list of descriptors.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</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">Calls "makeProcedure" on the visitor.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Query.html#createSQLAction(org.apache.cayenne.query.SQLActionVisitor)">createSQLAction</a></code>&nbsp;in interface&nbsp;<code><a href="Query.html" title="interface in org.apache.cayenne.query">Query</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="AbstractQuery.html#createSQLAction(org.apache.cayenne.query.SQLActionVisitor)">createSQLAction</a></code>&nbsp;in class&nbsp;<code><a href="AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</a></code></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<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>
<div class="block">Initializes query parameters using a set of properties.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a id="createQuery(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createQuery</h4>
<pre class="methodSignature">public&nbsp;<a href="Query.html" title="interface in org.apache.cayenne.query">Query</a>&nbsp;createQuery&#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;parameters)</pre>
<div class="block">Creates and returns a new ProcedureQuery built using this query as a prototype and
substituting template parameters with the values from the map.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ParameterizedQuery.html#createQuery(java.util.Map)">createQuery</a></code>&nbsp;in interface&nbsp;<code><a href="ParameterizedQuery.html" title="interface in org.apache.cayenne.query">ParameterizedQuery</a></code></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</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="getFetchLimit()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFetchLimit</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getFetchLimit()</pre>
</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>
</li>
</ul>
<a id="getFetchOffset()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFetchOffset</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getFetchOffset()</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</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>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</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="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="isFetchingDataRows()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFetchingDataRows</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isFetchingDataRows()</pre>
</li>
</ul>
<a id="addParameter(java.lang.String,java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addParameter</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;addParameter&#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;value)</pre>
<div class="block">Adds a named parameter to the internal map of parameters.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a id="removeParameter(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeParameter</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;removeParameter&#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)</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a id="getParameters()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParameters</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;?&gt;&nbsp;getParameters()</pre>
<div class="block">Returns a map of procedure parameters.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a id="setParameters(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setParameters</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setParameters&#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;parameters)</pre>
<div class="block">Sets a map of parameters.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a id="clearParameters()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearParameters</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;clearParameters()</pre>
<div class="block">Cleans up all configured parameters.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a id="getPrefetchTree()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPrefetchTree</h4>
<pre class="methodSignature">public&nbsp;<a href="PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a>&nbsp;getPrefetchTree()</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a id="addPrefetch(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPrefetch</h4>
<pre class="methodSignature">public&nbsp;<a href="PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</a>&nbsp;addPrefetch&#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;prefetchPath)</pre>
<div class="block">Adds a prefetch.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a id="removePrefetch(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removePrefetch</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;removePrefetch&#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;prefetch)</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a id="addPrefetches(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPrefetches</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;addPrefetches&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</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>&gt;&nbsp;prefetches)</pre>
<div class="block">Adds all prefetches from a provided collection.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a id="clearPrefetches()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearPrefetches</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;clearPrefetches()</pre>
<div class="block">Clears all prefetches.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a id="getResultEntityName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResultEntityName</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;getResultEntityName()</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a id="setResultEntityName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setResultEntityName</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setResultEntityName&#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;resultEntityName)</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
<a id="getColumnNamesCapitalization()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColumnNamesCapitalization</h4>
<pre class="methodSignature">public&nbsp;<a href="CapsStrategy.html" title="enum in org.apache.cayenne.query">CapsStrategy</a>&nbsp;getColumnNamesCapitalization()</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a id="setColumnNamesCapitalization(org.apache.cayenne.query.CapsStrategy)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setColumnNamesCapitalization</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setColumnNamesCapitalization&#8203;(<a href="CapsStrategy.html" title="enum in org.apache.cayenne.query">CapsStrategy</a>&nbsp;columnNameCapitalization)</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</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="getQueryTimeout()">
<!-- -->
</a>
<ul class="blockList">
<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>
<a id="setQueryTimeout(int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setQueryTimeout</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setQueryTimeout&#8203;(int&nbsp;timeout)</pre>
<div class="block">Set's query timeout</div>
<dl>
<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/ProcedureQuery.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>