Added: cayenne/site/cms/trunk/content/docs/4.0/api/org/apache/cayenne/query/MappedSelect.html URL: http://svn.apache.org/viewvc/cayenne/site/cms/trunk/content/docs/4.0/api/org/apache/cayenne/query/MappedSelect.html?rev=1774214&view=auto ============================================================================== --- cayenne/site/cms/trunk/content/docs/4.0/api/org/apache/cayenne/query/MappedSelect.html (added) +++ cayenne/site/cms/trunk/content/docs/4.0/api/org/apache/cayenne/query/MappedSelect.html Wed Dec 14 13:19:08 2016 @@ -0,0 +1,799 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_91) on Wed Dec 14 15:21:45 MSK 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>MappedSelect (cayenne-doc: Cayenne Documentation 4.0.M5-SNAPSHOT API)</title> +<meta name="date" content="2016-12-14"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="MappedSelect (cayenne-doc: Cayenne Documentation 4.0.M5-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"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}; +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"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/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> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/cayenne/query/MappedExec.html" title="class in org.apache.cayenne.query"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/cayenne/query/NamedQuery.html" title="class in org.apache.cayenne.query"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/cayenne/query/MappedSelect.html" target="_top">Frames</a></li> +<li><a href="MappedSelect.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.cayenne.query</div> +<h2 title="Class MappedSelect" class="title">Class MappedSelect<T></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../org/apache/cayenne/query/IndirectQuery.html" title="class in org.apache.cayenne.query">org.apache.cayenne.query.IndirectQuery</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../org/apache/cayenne/query/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<T></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a>, <a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a>, <a href="../../../../org/apache/cayenne/query/Select.html" title="interface in org.apache.cayenne.query">Select</a><T></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">MappedSelect<T></span> +extends <a href="../../../../org/apache/cayenne/query/AbstractMappedQuery.html" title="class in org.apache.cayenne.query">AbstractMappedQuery</a> +implements <a href="../../../../org/apache/cayenne/query/Select.html" title="interface in org.apache.cayenne.query">Select</a><T></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 =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/MappedSelect.html#fetchLimit">fetchLimit</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/MappedSelect.html#fetchOffset">fetchOffset</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/MappedSelect.html#forceNoCache">forceNoCache</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/MappedSelect.html#pageSize">pageSize</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><<a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/MappedSelect.html#resultClass">resultClass</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/MappedSelect.html#statementFetchSize">statementFetchSize</a></span></code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.cayenne.query.AbstractMappedQuery"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.cayenne.query.<a href="../../../../org/apache/cayenne/query/AbstractMappedQuery.html" title="class in org.apache.cayenne.query">AbstractMappedQuery</a></h3> +<code><a href="../../../../org/apache/cayenne/query/AbstractMappedQuery.html#params">params</a>, <a href="../../../../org/apache/cayenne/query/AbstractMappedQuery.html#queryName">queryName</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.cayenne.query.IndirectQuery"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.cayenne.query.<a href="../../../../org/apache/cayenne/query/IndirectQuery.html" title="class in org.apache.cayenne.query">IndirectQuery</a></h3> +<code><a href="../../../../org/apache/cayenne/query/IndirectQuery.html#dataMap">dataMap</a>, <a href="../../../../org/apache/cayenne/query/IndirectQuery.html#lastResolver">lastResolver</a>, <a href="../../../../org/apache/cayenne/query/IndirectQuery.html#name">name</a>, <a href="../../../../org/apache/cayenne/query/IndirectQuery.html#replacementQuery">replacementQuery</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/MappedSelect.html#MappedSelect-java.lang.String-">MappedSelect</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> queryName)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/MappedSelect.html#MappedSelect-java.lang.String-java.lang.Class-">MappedSelect</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> queryName, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><<a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a>> resultClass)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/cayenne/ResultBatchIterator.html" title="class in org.apache.cayenne">ResultBatchIterator</a><<a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/MappedSelect.html#batchIterator-org.apache.cayenne.ObjectContext-int-">batchIterator</a></span>(<a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context, + int size)</code> +<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="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/MappedSelect.html#createReplacementQuery-org.apache.cayenne.map.EntityResolver-">createReplacementQuery</a></span>(<a href="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a> resolver)</code> +<div class="block">Creates a substitute query.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a><<a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/MappedSelect.html#forceNoCache--">forceNoCache</a></span>()</code> +<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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/MappedSelect.html#iterate-org.apache.cayenne.ObjectContext-org.apache.cayenne.ResultIteratorCallback-">iterate</a></span>(<a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context, + <a href="../../../../org/apache/cayenne/ResultIteratorCallback.html" title="interface in org.apache.cayenne">ResultIteratorCallback</a><<a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a>> callback)</code> +<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="../../../../org/apache/cayenne/ResultIterator.html" title="interface in org.apache.cayenne">ResultIterator</a><<a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/MappedSelect.html#iterator-org.apache.cayenne.ObjectContext-">iterator</a></span>(<a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context)</code> +<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="../../../../org/apache/cayenne/query/MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a><<a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/MappedSelect.html#limit-int-">limit</a></span>(int fetchLimit)</code> +<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="../../../../org/apache/cayenne/query/MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a><<a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/MappedSelect.html#offset-int-">offset</a></span>(int fetchOffset)</code> +<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="../../../../org/apache/cayenne/query/MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a><<a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/MappedSelect.html#pageSize-int-">pageSize</a></span>(int pageSize)</code> +<div class="block">Resets query page size.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a><<a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/MappedSelect.html#param-java.lang.String-java.lang.Object-">param</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</code> </td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a><<a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/MappedSelect.html#params-java.util.Map-">params</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,?> parameters)</code> </td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a><?></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/MappedSelect.html#query-java.lang.String-">query</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> queryName)</code> +<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 <T> <a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/MappedSelect.html#query-java.lang.String-java.lang.Class-">query</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> queryName, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> rootClass)</code> +<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="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/MappedSelect.html#select-org.apache.cayenne.ObjectContext-">select</a></span>(<a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context)</code> +<div class="block">Selects objects using provided context.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/MappedSelect.html#selectFirst-org.apache.cayenne.ObjectContext-">selectFirst</a></span>(<a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context)</code> +<div class="block">Selects a single object using provided context.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/MappedSelect.html#selectOne-org.apache.cayenne.ObjectContext-">selectOne</a></span>(<a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context)</code> +<div class="block">Selects a single object using provided context.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a><<a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/query/MappedSelect.html#statementFetchSize-int-">statementFetchSize</a></span>(int statementFetchSize)</code> +<div class="block">Sets fetch size of the PreparedStatement generated for this query.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.cayenne.query.AbstractMappedQuery"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.cayenne.query.<a href="../../../../org/apache/cayenne/query/AbstractMappedQuery.html" title="class in org.apache.cayenne.query">AbstractMappedQuery</a></h3> +<code><a href="../../../../org/apache/cayenne/query/AbstractMappedQuery.html#name-java.lang.String-">name</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.cayenne.query.IndirectQuery"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.cayenne.query.<a href="../../../../org/apache/cayenne/query/IndirectQuery.html" title="class in org.apache.cayenne.query">IndirectQuery</a></h3> +<code><a href="../../../../org/apache/cayenne/query/IndirectQuery.html#createSQLAction-org.apache.cayenne.query.SQLActionVisitor-">createSQLAction</a>, <a href="../../../../org/apache/cayenne/query/IndirectQuery.html#getDataMap--">getDataMap</a>, <a href="../../../../org/apache/cayenne/query/IndirectQuery.html#getMetaData-org.apache.cayenne.map.EntityResolver-">getMetaData</a>, <a href="../../../../org/apache/cayenne/query/IndirectQuery.html#getName--">getName</a>, <a href="../../../../org/apache/cayenne/query/IndirectQuery.html#getReplacementQuery-org.apache.cayenne.map.EntityResolver-">getReplacementQuery</a>, <a href="../../../../org/apache/cayenne/query/IndirectQuery.html#route-org.apache.cayenne.query.QueryRouter-org.apache.cayenne.map.EntityResolver-org.apache.cayenne.query.Query-">route</a>, <a href="../../../../org/apache/cayenne/query/IndirectQuery.html#setDataMap-org.apache.cayenne.map.DataMap-">setDataMap</a>, <a href="../../../../org/apache/cayenne/query/IndirectQuery.ht ml#setName-java.lang.String-">setName</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.cayenne.query.Query"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.cayenne.query.<a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a></h3> +<code><a href="../../../../org/apache/cayenne/query/Query.html#createSQLAction-org.apache.cayenne.query.SQLActionVisitor-">createSQLAction</a>, <a href="../../../../org/apache/cayenne/query/Query.html#getDataMap--">getDataMap</a>, <a href="../../../../org/apache/cayenne/query/Query.html#getMetaData-org.apache.cayenne.map.EntityResolver-">getMetaData</a>, <a href="../../../../org/apache/cayenne/query/Query.html#getName--">getName</a>, <a href="../../../../org/apache/cayenne/query/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> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="resultClass"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>resultClass</h4> +<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><<a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a>> resultClass</pre> +</li> +</ul> +<a name="fetchLimit"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchLimit</h4> +<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a> fetchLimit</pre> +</li> +</ul> +<a name="fetchOffset"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchOffset</h4> +<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a> fetchOffset</pre> +</li> +</ul> +<a name="statementFetchSize"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>statementFetchSize</h4> +<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a> statementFetchSize</pre> +</li> +</ul> +<a name="pageSize"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>pageSize</h4> +<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a> pageSize</pre> +</li> +</ul> +<a name="forceNoCache"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>forceNoCache</h4> +<pre>protected boolean forceNoCache</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="MappedSelect-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MappedSelect</h4> +<pre>protected MappedSelect(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> queryName)</pre> +</li> +</ul> +<a name="MappedSelect-java.lang.String-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MappedSelect</h4> +<pre>protected MappedSelect(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> queryName, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><<a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a>> resultClass)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="query-java.lang.String-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>query</h4> +<pre>public static <T> <a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a><T> query(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> queryName, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> 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 name="query-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>query</h4> +<pre>public static <a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a><?> query(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> 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 name="limit-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>limit</h4> +<pre>public <a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a><<a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a>> limit(int 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 name="offset-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>offset</h4> +<pre>public <a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a><<a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a>> offset(int 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 name="statementFetchSize-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>statementFetchSize</h4> +<pre>public <a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a><<a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a>> statementFetchSize(int 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="http://docs.oracle.com/javase/7/docs/api/java/sql/Statement.html?is-external=true#setFetchSize-int-"; title="class or interface in java.sql"><code>Statement.setFetchSize(int)</code></a></dd> +</dl> +</li> +</ul> +<a name="pageSize-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>pageSize</h4> +<pre>public <a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a><<a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a>> pageSize(int 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 name="forceNoCache--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>forceNoCache</h4> +<pre>public <a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a><<a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a>> forceNoCache()</pre> +<div class="block">Forces query cache to be refreshed during the execution of this query.</div> +</li> +</ul> +<a name="params-java.util.Map-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>params</h4> +<pre>public <a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a><<a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a>> params(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,?> parameters)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../org/apache/cayenne/query/AbstractMappedQuery.html#params-java.util.Map-">params</a></code> in class <code><a href="../../../../org/apache/cayenne/query/AbstractMappedQuery.html" title="class in org.apache.cayenne.query">AbstractMappedQuery</a></code></dd> +</dl> +</li> +</ul> +<a name="param-java.lang.String-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>param</h4> +<pre>public <a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="class in org.apache.cayenne.query">MappedSelect</a><<a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a>> param(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../org/apache/cayenne/query/AbstractMappedQuery.html#param-java.lang.String-java.lang.Object-">param</a></code> in class <code><a href="../../../../org/apache/cayenne/query/AbstractMappedQuery.html" title="class in org.apache.cayenne.query">AbstractMappedQuery</a></code></dd> +</dl> +</li> +</ul> +<a name="select-org.apache.cayenne.ObjectContext-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>select</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a>> select(<a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/cayenne/query/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="../../../../org/apache/cayenne/query/Select.html#select-org.apache.cayenne.ObjectContext-">select</a></code> in interface <code><a href="../../../../org/apache/cayenne/query/Select.html" title="interface in org.apache.cayenne.query">Select</a><<a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="selectOne-org.apache.cayenne.ObjectContext-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>selectOne</h4> +<pre>public <a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a> selectOne(<a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/cayenne/query/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="../../../../org/apache/cayenne/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="../../../../org/apache/cayenne/query/Select.html#selectOne-org.apache.cayenne.ObjectContext-">selectOne</a></code> in interface <code><a href="../../../../org/apache/cayenne/query/Select.html" title="interface in org.apache.cayenne.query">Select</a><<a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="selectFirst-org.apache.cayenne.ObjectContext-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>selectFirst</h4> +<pre>public <a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a> selectFirst(<a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/cayenne/query/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="../../../../org/apache/cayenne/query/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="../../../../org/apache/cayenne/query/Select.html#selectFirst-org.apache.cayenne.ObjectContext-">selectFirst</a></code> in interface <code><a href="../../../../org/apache/cayenne/query/Select.html" title="interface in org.apache.cayenne.query">Select</a><<a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="iterate-org.apache.cayenne.ObjectContext-org.apache.cayenne.ResultIteratorCallback-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>iterate</h4> +<pre>public void iterate(<a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context, + <a href="../../../../org/apache/cayenne/ResultIteratorCallback.html" title="interface in org.apache.cayenne">ResultIteratorCallback</a><<a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a>> callback)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/cayenne/query/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="../../../../org/apache/cayenne/query/Select.html#iterate-org.apache.cayenne.ObjectContext-org.apache.cayenne.ResultIteratorCallback-">iterate</a></code> in interface <code><a href="../../../../org/apache/cayenne/query/Select.html" title="interface in org.apache.cayenne.query">Select</a><<a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="iterator-org.apache.cayenne.ObjectContext-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>iterator</h4> +<pre>public <a href="../../../../org/apache/cayenne/ResultIterator.html" title="interface in org.apache.cayenne">ResultIterator</a><<a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a>> iterator(<a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/cayenne/query/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="../../../../org/apache/cayenne/query/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="../../../../org/apache/cayenne/query/Select.html#iterator-org.apache.cayenne.ObjectContext-">iterator</a></code> in interface <code><a href="../../../../org/apache/cayenne/query/Select.html" title="interface in org.apache.cayenne.query">Select</a><<a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="batchIterator-org.apache.cayenne.ObjectContext-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>batchIterator</h4> +<pre>public <a href="../../../../org/apache/cayenne/ResultBatchIterator.html" title="class in org.apache.cayenne">ResultBatchIterator</a><<a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a>> batchIterator(<a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context, + int size)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/cayenne/query/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="../../../../org/apache/cayenne/query/Select.html#batchIterator-org.apache.cayenne.ObjectContext-int-">batchIterator</a></code> in interface <code><a href="../../../../org/apache/cayenne/query/Select.html" title="interface in org.apache.cayenne.query">Select</a><<a href="../../../../org/apache/cayenne/query/MappedSelect.html" title="type parameter in MappedSelect">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="createReplacementQuery-org.apache.cayenne.map.EntityResolver-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createReplacementQuery</h4> +<pre>protected <a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a> createReplacementQuery(<a href="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a> resolver)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/cayenne/query/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="../../../../org/apache/cayenne/query/AbstractMappedQuery.html#createReplacementQuery-org.apache.cayenne.map.EntityResolver-">createReplacementQuery</a></code> in class <code><a href="../../../../org/apache/cayenne/query/AbstractMappedQuery.html" title="class in org.apache.cayenne.query">AbstractMappedQuery</a></code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/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> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/cayenne/query/MappedExec.html" title="class in org.apache.cayenne.query"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/cayenne/query/NamedQuery.html" title="class in org.apache.cayenne.query"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/cayenne/query/MappedSelect.html" target="_top">Frames</a></li> +<li><a href="MappedSelect.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2001–2016 <a href="http://cayenne.apache.org/";>Apache Cayenne</a>. All rights reserved.</small></p> +</body> +</html>
