Google Git
Sign in
apache / openjpa-site / f4f8b894b02554a0a851bbf380ef41d45c445062 / . / content / builds / 2.4.3 / apidocs / org / apache / openjpa / jdbc / kernel / PreparedResultObjectProvider.html
blob: ce2fad36e6ee7ab3979965e8cd356a6d188d775c [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="it">
<head>
<!-- Generated by javadoc (version 1.7.0_80) on Thu Jun 14 10:04:01 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PreparedResultObjectProvider (OpenJPA Parent POM 2.4.3 API)</title>
<meta name="date" content="2018-06-14">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PreparedResultObjectProvider (OpenJPA Parent POM 2.4.3 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/PreparedResultObjectProvider.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/openjpa/jdbc/kernel/PreparedQueryImpl.html" title="class in org.apache.openjpa.jdbc.kernel"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/jdbc/kernel/PreparedSQLStoreQuery.html" title="class in org.apache.openjpa.jdbc.kernel"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/jdbc/kernel/PreparedResultObjectProvider.html" target="_top">Frames</a></li>
<li><a href="PreparedResultObjectProvider.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields_inherited_from_class_org.apache.openjpa.jdbc.kernel.SelectResultObjectProvider">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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.openjpa.jdbc.kernel</div>
<h2 title="Class PreparedResultObjectProvider" class="title">Class PreparedResultObjectProvider</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/6/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/openjpa/jdbc/kernel/SelectResultObjectProvider.html" title="class in org.apache.openjpa.jdbc.kernel">org.apache.openjpa.jdbc.kernel.SelectResultObjectProvider</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/openjpa/jdbc/kernel/InstanceResultObjectProvider.html" title="class in org.apache.openjpa.jdbc.kernel">org.apache.openjpa.jdbc.kernel.InstanceResultObjectProvider</a></li>
<li>
<ul class="inheritance">
<li>org.apache.openjpa.jdbc.kernel.PreparedResultObjectProvider</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="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html" title="interface in org.apache.openjpa.lib.rop">ResultObjectProvider</a>, <a href="../../../../../org/apache/openjpa/lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">PreparedResultObjectProvider</span>
extends <a href="../../../../../org/apache/openjpa/jdbc/kernel/InstanceResultObjectProvider.html" title="class in org.apache.openjpa.jdbc.kernel">InstanceResultObjectProvider</a></pre>
<div class="block">A Select-oriented Result Object Provider whose Select has been executed
outside its own scope.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Pinaki Poddar</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>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.openjpa.jdbc.kernel.SelectResultObjectProvider">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.openjpa.jdbc.kernel.<a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html" title="class in org.apache.openjpa.jdbc.kernel">SelectResultObjectProvider</a></h3>
<code><a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html#_res">_res</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/kernel/PreparedResultObjectProvider.html#PreparedResultObjectProvider(org.apache.openjpa.jdbc.sql.SelectExecutor,%20org.apache.openjpa.jdbc.meta.ClassMapping,%20org.apache.openjpa.jdbc.kernel.JDBCStore,%20org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration,%20org.apache.openjpa.jdbc.sql.Result)">PreparedResultObjectProvider</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/sql/SelectExecutor.html" title="interface in org.apache.openjpa.jdbc.sql">SelectExecutor</a>&nbsp;sel,
<a href="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</a>&nbsp;mapping,
<a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCStore</a>&nbsp;store,
<a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCFetchConfiguration.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCFetchConfiguration</a>&nbsp;fetch,
<a href="../../../../../org/apache/openjpa/jdbc/sql/Result.html" title="interface in org.apache.openjpa.jdbc.sql">Result</a>&nbsp;res)</code>
<div class="block">Constructor.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/kernel/PreparedResultObjectProvider.html#open()">open</a></strong>()</code>
<div class="block">Open the result.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.openjpa.jdbc.kernel.InstanceResultObjectProvider">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.openjpa.jdbc.kernel.<a href="../../../../../org/apache/openjpa/jdbc/kernel/InstanceResultObjectProvider.html" title="class in org.apache.openjpa.jdbc.kernel">InstanceResultObjectProvider</a></h3>
<code><a href="../../../../../org/apache/openjpa/jdbc/kernel/InstanceResultObjectProvider.html#getResultObject()">getResultObject</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.openjpa.jdbc.kernel.SelectResultObjectProvider">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.openjpa.jdbc.kernel.<a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html" title="class in org.apache.openjpa.jdbc.kernel">SelectResultObjectProvider</a></h3>
<code><a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html#absolute(int)">absolute</a>, <a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html#close()">close</a>, <a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html#getFetchConfiguration()">getFetchConfiguration</a>, <a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html#getResult()">getResult</a>, <a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html#getSelect()">getSelect</a>, <a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html#getStore()">getStore</a>, <a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html#handleCheckedException(java.lang.Exception)">handleCheckedException</a>, <a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html#next()">next</a>, <a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html#reset()">reset</a>, <a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html#setSize(int)">setSize</a>, <a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html#size()">size</a>, <a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html#supportsRandomAccess()">supportsRandomAccess</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&nbsp;java.lang.<a href="http://docs.oracle.com/javase/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="PreparedResultObjectProvider(org.apache.openjpa.jdbc.sql.SelectExecutor, org.apache.openjpa.jdbc.meta.ClassMapping, org.apache.openjpa.jdbc.kernel.JDBCStore, org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration, org.apache.openjpa.jdbc.sql.Result)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PreparedResultObjectProvider</h4>
<pre>public&nbsp;PreparedResultObjectProvider(<a href="../../../../../org/apache/openjpa/jdbc/sql/SelectExecutor.html" title="interface in org.apache.openjpa.jdbc.sql">SelectExecutor</a>&nbsp;sel,
<a href="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</a>&nbsp;mapping,
<a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCStore</a>&nbsp;store,
<a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCFetchConfiguration.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCFetchConfiguration</a>&nbsp;fetch,
<a href="../../../../../org/apache/openjpa/jdbc/sql/Result.html" title="interface in org.apache.openjpa.jdbc.sql">Result</a>&nbsp;res)</pre>
<div class="block">Constructor.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sel</code> - the select to execute</dd><dd><code>store</code> - the store to delegate loading to</dd><dd><code>fetch</code> - the fetch configuration, or null for the default</dd><dd><code>res</code> - the result of the given select</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="open()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>open</h4>
<pre>public&nbsp;void&nbsp;open()
throws <a href="http://docs.oracle.com/javase/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html#open()">ResultObjectProvider</a></code></strong></div>
<div class="block">Open the result. This will be called before
<a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html#next()"><code>ResultObjectProvider.next()</code></a>, <a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html#absolute(int)"><code>ResultObjectProvider.absolute(int)</code></a>, or <a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html#size()"><code>ResultObjectProvider.size()</code></a>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html#open()">open</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html" title="interface in org.apache.openjpa.lib.rop">ResultObjectProvider</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html#open()">open</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html" title="class in org.apache.openjpa.jdbc.kernel">SelectResultObjectProvider</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/PreparedResultObjectProvider.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/openjpa/jdbc/kernel/PreparedQueryImpl.html" title="class in org.apache.openjpa.jdbc.kernel"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/jdbc/kernel/PreparedSQLStoreQuery.html" title="class in org.apache.openjpa.jdbc.kernel"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/jdbc/kernel/PreparedResultObjectProvider.html" target="_top">Frames</a></li>
<li><a href="PreparedResultObjectProvider.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields_inherited_from_class_org.apache.openjpa.jdbc.kernel.SelectResultObjectProvider">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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>