blob: 0001ba4ce5741fa78c32b7bada4f6fdfb20f7964 [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>MappedSelect (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="MappedSelect (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":9,"i11":9,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/MappedSelect.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 MappedSelect" class="title">Class MappedSelect&lt;T&gt;</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="IndirectQuery.html" title="class in org.apache.cayenne.query">org.apache.cayenne.query.IndirectQuery</a></li>
<li>
<ul class="inheritance">
<li><a href="AbstractMappedQuery.html" title="class in org.apache.cayenne.query">org.apache.cayenne.query.AbstractMappedQuery</a></li>
<li>
<ul class="inheritance">
<li>org.apache.cayenne.query.MappedSelect&lt;T&gt;</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="Query.html" title="interface in org.apache.cayenne.query">Query</a></code>, <code><a href="Select.html" title="interface in org.apache.cayenne.query">Select</a>&lt;T&gt;</code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">MappedSelect&lt;T&gt;</span>
extends <a href="AbstractMappedQuery.html" title="class in org.apache.cayenne.query">AbstractMappedQuery</a>
implements <a href="Select.html" title="interface in org.apache.cayenne.query">Select</a>&lt;T&gt;</pre>
<div class="block">A query that represents a named parameterized selecting query stored in the mapping. The
actual query is resolved during execution.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../serialized-form.html#org.apache.cayenne.query.MappedSelect">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/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fetchLimit">fetchLimit</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/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fetchOffset">fetchOffset</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#forceNoCache">forceNoCache</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/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#pageSize">pageSize</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/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#queryTimeout">queryTimeout</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;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&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/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#statementFetchSize">statementFetchSize</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.AbstractMappedQuery">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.cayenne.query.<a href="AbstractMappedQuery.html" title="class in org.apache.cayenne.query">AbstractMappedQuery</a></h3>
<code><a href="AbstractMappedQuery.html#params">params</a>, <a href="AbstractMappedQuery.html#queryName">queryName</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.apache.cayenne.query.IndirectQuery">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.cayenne.query.<a href="IndirectQuery.html" title="class in org.apache.cayenne.query">IndirectQuery</a></h3>
<code><a href="IndirectQuery.html#dataMap">dataMap</a>, <a href="IndirectQuery.html#lastResolver">lastResolver</a>, <a href="IndirectQuery.html#name">name</a>, <a href="IndirectQuery.html#replacementQuery">replacementQuery</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">Modifier</th>
<th class="colSecond" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String)">MappedSelect</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;queryName)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,java.lang.Class)">MappedSelect</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;queryName,
<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;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt;&nbsp;resultClass)</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="../ResultBatchIterator.html" title="class in org.apache.cayenne">ResultBatchIterator</a>&lt;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#batchIterator(org.apache.cayenne.ObjectContext,int)">batchIterator</a></span>&#8203;(<a href="../ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a>&nbsp;context,
int&nbsp;size)</code></th>
<td class="colLast">
<div class="block">Creates a ResultBatchIterator based on the provided context and batch
size.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected <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="#createReplacementQuery(org.apache.cayenne.map.EntityResolver)">createReplacementQuery</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">Creates a substitute query.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a>&lt;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#forceNoCache()">forceNoCache</a></span>()</code></th>
<td class="colLast">
<div class="block">Forces query cache to be refreshed during the execution of this query.</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="#iterate(org.apache.cayenne.ObjectContext,org.apache.cayenne.ResultIteratorCallback)">iterate</a></span>&#8203;(<a href="../ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a>&nbsp;context,
<a href="../ResultIteratorCallback.html" title="interface in org.apache.cayenne">ResultIteratorCallback</a>&lt;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt;&nbsp;callback)</code></th>
<td class="colLast">
<div class="block">Creates a ResultIterator based on the provided context and passes it to a
callback for processing.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../ResultIterator.html" title="interface in org.apache.cayenne">ResultIterator</a>&lt;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#iterator(org.apache.cayenne.ObjectContext)">iterator</a></span>&#8203;(<a href="../ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block">Creates a ResultIterator based on the provided context.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a>&lt;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#limit(int)">limit</a></span>&#8203;(int&nbsp;fetchLimit)</code></th>
<td class="colLast">
<div class="block">Resets query fetch limit - a parameter that defines max number of objects
that should be ever be fetched from the database.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a>&lt;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#offset(int)">offset</a></span>&#8203;(int&nbsp;fetchOffset)</code></th>
<td class="colLast">
<div class="block">Resets query fetch offset - a parameter that defines how many objects
should be skipped when reading data from the database.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a>&lt;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#pageSize(int)">pageSize</a></span>&#8203;(int&nbsp;pageSize)</code></th>
<td class="colLast">
<div class="block">Resets query page size.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a>&lt;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#param(java.lang.String,java.lang.Object)">param</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">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a>&lt;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#params(java.util.Map)">params</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">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static <a href="MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a>&lt;?&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#query(java.lang.String)">query</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;queryName)</code></th>
<td class="colLast">
<div class="block">Loads query with the given name from the mapping configuration.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;<a href="MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a>&lt;T&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#query(java.lang.String,java.lang.Class)">query</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;queryName,
<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;T&gt;&nbsp;rootClass)</code></th>
<td class="colLast">
<div class="block">Loads query with the given name, which selects objects of a given persistent class,
from the mapping configuration.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a>&lt;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#queryTimeout(int)">queryTimeout</a></span>&#8203;(int&nbsp;timeout)</code></th>
<td class="colLast">
<div class="block">Sets query timeout for the PreparedStatement generated for this query.</div>
</td>
</tr>
<tr id="i13" 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="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#select(org.apache.cayenne.ObjectContext)">select</a></span>&#8203;(<a href="../ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block">Selects objects using provided context.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="MappedSelect.html" title="type parameter in MappedSelect">T</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#selectFirst(org.apache.cayenne.ObjectContext)">selectFirst</a></span>&#8203;(<a href="../ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block">Selects a single object using provided context.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="MappedSelect.html" title="type parameter in MappedSelect">T</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#selectOne(org.apache.cayenne.ObjectContext)">selectOne</a></span>&#8203;(<a href="../ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block">Selects a single object using provided context.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a>&lt;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#statementFetchSize(int)">statementFetchSize</a></span>&#8203;(int&nbsp;statementFetchSize)</code></th>
<td class="colLast">
<div class="block">Sets fetch size of the PreparedStatement generated for this query.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.cayenne.query.AbstractMappedQuery">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.cayenne.query.<a href="AbstractMappedQuery.html" title="class in org.apache.cayenne.query">AbstractMappedQuery</a></h3>
<code><a href="AbstractMappedQuery.html#name(java.lang.String)">name</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.cayenne.query.IndirectQuery">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.cayenne.query.<a href="IndirectQuery.html" title="class in org.apache.cayenne.query">IndirectQuery</a></h3>
<code><a href="IndirectQuery.html#createSQLAction(org.apache.cayenne.query.SQLActionVisitor)">createSQLAction</a>, <a href="IndirectQuery.html#getMetaData(org.apache.cayenne.map.EntityResolver)">getMetaData</a>, <a href="IndirectQuery.html#getReplacementQuery(org.apache.cayenne.map.EntityResolver)">getReplacementQuery</a>, <a href="IndirectQuery.html#route(org.apache.cayenne.query.QueryRouter,org.apache.cayenne.map.EntityResolver,org.apache.cayenne.query.Query)">route</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>
<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#createSQLAction(org.apache.cayenne.query.SQLActionVisitor)">createSQLAction</a>, <a href="Query.html#getMetaData(org.apache.cayenne.map.EntityResolver)">getMetaData</a>, <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="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;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt; resultClass</pre>
</li>
</ul>
<a id="fetchLimit">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchLimit</h4>
<pre>protected&nbsp;<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> fetchLimit</pre>
</li>
</ul>
<a id="fetchOffset">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchOffset</h4>
<pre>protected&nbsp;<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> fetchOffset</pre>
</li>
</ul>
<a id="statementFetchSize">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>statementFetchSize</h4>
<pre>protected&nbsp;<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> statementFetchSize</pre>
</li>
</ul>
<a id="queryTimeout">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>queryTimeout</h4>
<pre>protected&nbsp;<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> queryTimeout</pre>
</li>
</ul>
<a id="pageSize">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pageSize</h4>
<pre>protected&nbsp;<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> pageSize</pre>
</li>
</ul>
<a id="forceNoCache">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>forceNoCache</h4>
<pre>protected&nbsp;boolean forceNoCache</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>MappedSelect</h4>
<pre>protected&nbsp;MappedSelect&#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;queryName)</pre>
</li>
</ul>
<a id="&lt;init&gt;(java.lang.String,java.lang.Class)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MappedSelect</h4>
<pre>protected&nbsp;MappedSelect&#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;queryName,
<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;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt;&nbsp;resultClass)</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="query(java.lang.String,java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>query</h4>
<pre class="methodSignature">public static&nbsp;&lt;T&gt;&nbsp;<a href="MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a>&lt;T&gt;&nbsp;query&#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;queryName,
<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;T&gt;&nbsp;rootClass)</pre>
<div class="block">Loads query with the given name, which selects objects of a given persistent class,
from the mapping configuration.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>queryName</code> - name of the mapped query</dd>
<dd><code>rootClass</code> - the Class of objects fetched by this query</dd>
</dl>
</li>
</ul>
<a id="query(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>query</h4>
<pre class="methodSignature">public static&nbsp;<a href="MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a>&lt;?&gt;&nbsp;query&#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;queryName)</pre>
<div class="block">Loads query with the given name from the mapping configuration.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>queryName</code> - name of the mapped query</dd>
</dl>
</li>
</ul>
<a id="limit(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>limit</h4>
<pre class="methodSignature">public&nbsp;<a href="MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a>&lt;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt;&nbsp;limit&#8203;(int&nbsp;fetchLimit)</pre>
<div class="block">Resets query fetch limit - a parameter that defines max number of objects
that should be ever be fetched from the database.</div>
</li>
</ul>
<a id="offset(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>offset</h4>
<pre class="methodSignature">public&nbsp;<a href="MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a>&lt;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt;&nbsp;offset&#8203;(int&nbsp;fetchOffset)</pre>
<div class="block">Resets query fetch offset - a parameter that defines how many objects
should be skipped when reading data from the database.</div>
</li>
</ul>
<a id="statementFetchSize(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>statementFetchSize</h4>
<pre class="methodSignature">public&nbsp;<a href="MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a>&lt;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt;&nbsp;statementFetchSize&#8203;(int&nbsp;statementFetchSize)</pre>
<div class="block">Sets fetch size of the PreparedStatement generated for this query. Only
non-negative values would change the default size.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Statement.html?is-external=true#setFetchSize(int)" title="class or interface in java.sql" class="externalLink"><code>Statement.setFetchSize(int)</code></a></dd>
</dl>
</li>
</ul>
<a id="queryTimeout(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>queryTimeout</h4>
<pre class="methodSignature">public&nbsp;<a href="MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a>&lt;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt;&nbsp;queryTimeout&#8203;(int&nbsp;timeout)</pre>
<div class="block">Sets query timeout for the PreparedStatement generated for this query.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.2</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Statement.html?is-external=true#setQueryTimeout(int)" title="class or interface in java.sql" class="externalLink"><code>Statement.setQueryTimeout(int)</code></a></dd>
</dl>
</li>
</ul>
<a id="pageSize(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pageSize</h4>
<pre class="methodSignature">public&nbsp;<a href="MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a>&lt;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt;&nbsp;pageSize&#8203;(int&nbsp;pageSize)</pre>
<div class="block">Resets query page size. A non-negative page size enables query result
pagination that saves memory and processing time for large lists if only
parts of the result are ever going to be accessed.</div>
</li>
</ul>
<a id="forceNoCache()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forceNoCache</h4>
<pre class="methodSignature">public&nbsp;<a href="MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a>&lt;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt;&nbsp;forceNoCache()</pre>
<div class="block">Forces query cache to be refreshed during the execution of this query.</div>
</li>
</ul>
<a id="params(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>params</h4>
<pre class="methodSignature">public&nbsp;<a href="MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a>&lt;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt;&nbsp;params&#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>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="AbstractMappedQuery.html#params(java.util.Map)">params</a></code>&nbsp;in class&nbsp;<code><a href="AbstractMappedQuery.html" title="class in org.apache.cayenne.query">AbstractMappedQuery</a></code></dd>
</dl>
</li>
</ul>
<a id="param(java.lang.String,java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>param</h4>
<pre class="methodSignature">public&nbsp;<a href="MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a>&lt;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt;&nbsp;param&#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>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="AbstractMappedQuery.html#param(java.lang.String,java.lang.Object)">param</a></code>&nbsp;in class&nbsp;<code><a href="AbstractMappedQuery.html" title="class in org.apache.cayenne.query">AbstractMappedQuery</a></code></dd>
</dl>
</li>
</ul>
<a id="select(org.apache.cayenne.ObjectContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>select</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="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt;&nbsp;select&#8203;(<a href="../ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a>&nbsp;context)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="Select.html#select(org.apache.cayenne.ObjectContext)">Select</a></code></span></div>
<div class="block">Selects objects using provided context.
<p>
Essentially the inversion of "ObjectContext.select(Select)".</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Select.html#select(org.apache.cayenne.ObjectContext)">select</a></code>&nbsp;in interface&nbsp;<code><a href="Select.html" title="interface in org.apache.cayenne.query">Select</a>&lt;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a id="selectOne(org.apache.cayenne.ObjectContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectOne</h4>
<pre class="methodSignature">public&nbsp;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&nbsp;selectOne&#8203;(<a href="../ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a>&nbsp;context)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="Select.html#selectOne(org.apache.cayenne.ObjectContext)">Select</a></code></span></div>
<div class="block">Selects a single object using provided context. The query is expected to
match zero or one object. It returns null if no objects were matched. If
query matched more than one object,
<a href="../CayenneRuntimeException.html" title="class in org.apache.cayenne"><code>CayenneRuntimeException</code></a> is thrown.
<p>
Essentially the inversion of "ObjectContext.selectOne(Select)".</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Select.html#selectOne(org.apache.cayenne.ObjectContext)">selectOne</a></code>&nbsp;in interface&nbsp;<code><a href="Select.html" title="interface in org.apache.cayenne.query">Select</a>&lt;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a id="selectFirst(org.apache.cayenne.ObjectContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectFirst</h4>
<pre class="methodSignature">public&nbsp;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&nbsp;selectFirst&#8203;(<a href="../ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a>&nbsp;context)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="Select.html#selectFirst(org.apache.cayenne.ObjectContext)">Select</a></code></span></div>
<div class="block">Selects a single object using provided context. The query itself can
match any number of objects, but will return only the first one. It
returns null if no objects were matched.
<p>
If it matched more than one object, the first object from the list is
returned. This makes 'selectFirst' different from
<a href="Select.html#selectOne(org.apache.cayenne.ObjectContext)"><code>Select.selectOne(ObjectContext)</code></a>, which would throw in this situation.
'selectFirst' is useful e.g. when the query is ordered and we only want
to see the first object (e.g. "most recent news article"), etc.
<p>
Selecting the first object via "Select.selectFirst(ObjectContext)" is
more comprehensible than selecting via
"ObjectContext.selectFirst(Select)", because implementations of "Select"
set fetch size limit to one.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Select.html#selectFirst(org.apache.cayenne.ObjectContext)">selectFirst</a></code>&nbsp;in interface&nbsp;<code><a href="Select.html" title="interface in org.apache.cayenne.query">Select</a>&lt;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a id="iterate(org.apache.cayenne.ObjectContext,org.apache.cayenne.ResultIteratorCallback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>iterate</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;iterate&#8203;(<a href="../ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a>&nbsp;context,
<a href="../ResultIteratorCallback.html" title="interface in org.apache.cayenne">ResultIteratorCallback</a>&lt;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt;&nbsp;callback)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="Select.html#iterate(org.apache.cayenne.ObjectContext,org.apache.cayenne.ResultIteratorCallback)">Select</a></code></span></div>
<div class="block">Creates a ResultIterator based on the provided context and passes it to a
callback for processing. The caller does not need to worry about closing
the iterator. This method takes care of it.
<p>
Essentially the inversion of
"ObjectContext.iterate(Select, ResultIteratorCallback)".</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Select.html#iterate(org.apache.cayenne.ObjectContext,org.apache.cayenne.ResultIteratorCallback)">iterate</a></code>&nbsp;in interface&nbsp;<code><a href="Select.html" title="interface in org.apache.cayenne.query">Select</a>&lt;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a id="iterator(org.apache.cayenne.ObjectContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>iterator</h4>
<pre class="methodSignature">public&nbsp;<a href="../ResultIterator.html" title="interface in org.apache.cayenne">ResultIterator</a>&lt;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt;&nbsp;iterator&#8203;(<a href="../ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a>&nbsp;context)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="Select.html#iterator(org.apache.cayenne.ObjectContext)">Select</a></code></span></div>
<div class="block">Creates a ResultIterator based on the provided context. It is usually
backed by an open result set and is useful for processing of large data
sets, preserving a constant memory footprint. The caller must wrap
iteration in try/finally (or try-with-resources for Java 1.7 and higher)
and close the ResultIterator explicitly. Or use
<a href="Select.html#iterate(org.apache.cayenne.ObjectContext,org.apache.cayenne.ResultIteratorCallback)"><code>Select.iterate(ObjectContext, ResultIteratorCallback)</code></a> as an
alternative.
<p>
Essentially the inversion of "ObjectContext.iterator(Select)".</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Select.html#iterator(org.apache.cayenne.ObjectContext)">iterator</a></code>&nbsp;in interface&nbsp;<code><a href="Select.html" title="interface in org.apache.cayenne.query">Select</a>&lt;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a id="batchIterator(org.apache.cayenne.ObjectContext,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>batchIterator</h4>
<pre class="methodSignature">public&nbsp;<a href="../ResultBatchIterator.html" title="class in org.apache.cayenne">ResultBatchIterator</a>&lt;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt;&nbsp;batchIterator&#8203;(<a href="../ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a>&nbsp;context,
int&nbsp;size)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="Select.html#batchIterator(org.apache.cayenne.ObjectContext,int)">Select</a></code></span></div>
<div class="block">Creates a ResultBatchIterator based on the provided context and batch
size. It is usually backed by an open result set and is useful for
processing of large data sets, preserving a constant memory footprint.
The caller must wrap iteration in try/finally (or try-with-resources for
Java 1.7 and higher) and close the ResultBatchIterator explicitly.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Select.html#batchIterator(org.apache.cayenne.ObjectContext,int)">batchIterator</a></code>&nbsp;in interface&nbsp;<code><a href="Select.html" title="interface in org.apache.cayenne.query">Select</a>&lt;<a href="MappedSelect.html" title="type parameter in MappedSelect">T</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a id="createReplacementQuery(org.apache.cayenne.map.EntityResolver)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>createReplacementQuery</h4>
<pre class="methodSignature">protected&nbsp;<a href="Query.html" title="interface in org.apache.cayenne.query">Query</a>&nbsp;createReplacementQuery&#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="IndirectQuery.html#createReplacementQuery(org.apache.cayenne.map.EntityResolver)">IndirectQuery</a></code></span></div>
<div class="block">Creates a substitute query. An implementor is free to provide an
arbitrary replacement query.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="AbstractMappedQuery.html#createReplacementQuery(org.apache.cayenne.map.EntityResolver)">createReplacementQuery</a></code>&nbsp;in class&nbsp;<code><a href="AbstractMappedQuery.html" title="class in org.apache.cayenne.query">AbstractMappedQuery</a></code></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/MappedSelect.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>