blob: ca82ad287b6fcb6f46a19f0a95cb835235647adc [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_252) on Thu Sep 03 11:54:22 CEST 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ResultObjectProvider (OpenJPA Parent POM 3.1.2 API)</title>
<meta name="date" content="2020-09-03">
<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="ResultObjectProvider (OpenJPA Parent POM 3.1.2 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/ResultObjectProvider.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/lib/rop/ResultListIterator.html" title="class in org.apache.openjpa.lib.rop"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProviderIterator.html" title="class in org.apache.openjpa.lib.rop"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/lib/rop/ResultObjectProvider.html" target="_top">Frames</a></li>
<li><a href="ResultObjectProvider.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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.lib.rop</div>
<h2 title="Interface ResultObjectProvider" class="title">Interface ResultObjectProvider</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../org/apache/openjpa/lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</a></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../org/apache/openjpa/lib/rop/BatchedResultObjectProvider.html" title="interface in org.apache.openjpa.lib.rop">BatchedResultObjectProvider</a>, <a href="../../../../../org/apache/openjpa/kernel/PCResultObjectProvider.html" title="interface in org.apache.openjpa.kernel">PCResultObjectProvider</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/openjpa/kernel/AbstractPCResultObjectProvider.html" title="class in org.apache.openjpa.kernel">AbstractPCResultObjectProvider</a>, <a href="../../../../../org/apache/openjpa/jdbc/kernel/GenericResultObjectProvider.html" title="class in org.apache.openjpa.jdbc.kernel">GenericResultObjectProvider</a>, <a href="../../../../../org/apache/openjpa/jdbc/kernel/InstanceResultObjectProvider.html" title="class in org.apache.openjpa.jdbc.kernel">InstanceResultObjectProvider</a>, <a href="../../../../../org/apache/openjpa/lib/rop/ListResultObjectProvider.html" title="class in org.apache.openjpa.lib.rop">ListResultObjectProvider</a>, <a href="../../../../../org/apache/openjpa/lib/rop/MergedResultObjectProvider.html" title="class in org.apache.openjpa.lib.rop">MergedResultObjectProvider</a>, <a href="../../../../../org/apache/openjpa/kernel/OrderingMergedResultObjectProvider.html" title="class in org.apache.openjpa.kernel">OrderingMergedResultObjectProvider</a>, <a href="../../../../../org/apache/openjpa/jdbc/kernel/PagingResultObjectProvider.html" title="class in org.apache.openjpa.jdbc.kernel">PagingResultObjectProvider</a>, <a href="../../../../../org/apache/openjpa/jdbc/kernel/PreparedResultObjectProvider.html" title="class in org.apache.openjpa.jdbc.kernel">PreparedResultObjectProvider</a>, <a href="../../../../../org/apache/openjpa/kernel/QueryImpl.PackingResultObjectProvider.html" title="class in org.apache.openjpa.kernel">QueryImpl.PackingResultObjectProvider</a>, <a href="../../../../../org/apache/openjpa/lib/rop/RangeResultObjectProvider.html" title="class in org.apache.openjpa.lib.rop">RangeResultObjectProvider</a>, <a href="../../../../../org/apache/openjpa/jdbc/kernel/SelectResultObjectProvider.html" title="class in org.apache.openjpa.jdbc.kernel">SelectResultObjectProvider</a>, <a href="../../../../../org/apache/openjpa/slice/jdbc/UniqueResultObjectProvider.html" title="class in org.apache.openjpa.slice.jdbc">UniqueResultObjectProvider</a>, <a href="../../../../../org/apache/openjpa/jdbc/kernel/XROP.html" title="class in org.apache.openjpa.jdbc.kernel">XROP</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ResultObjectProvider</span>
extends <a href="../../../../../org/apache/openjpa/lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</a></pre>
<div class="block">Interface that allows lazy/custom instantiation of input objects.
<a href="../../../../../org/apache/openjpa/lib/rop/ResultList.html" title="interface in org.apache.openjpa.lib.rop"><code>ResultList</code></a> objects do not necessarily load in data all
at once. Instead, they may lazily load objects as necessary. So,
the lifespan of a <a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html" title="interface in org.apache.openjpa.lib.rop"><code>ResultObjectProvider</code></a> instance is
related to how the application deals with processing the
<a href="../../../../../org/apache/openjpa/lib/rop/ResultList.html" title="interface in org.apache.openjpa.lib.rop"><code>ResultList</code></a> created with a given
<a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html" title="interface in org.apache.openjpa.lib.rop"><code>ResultObjectProvider</code></a> instance.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Marc Prud'hommeaux, Patrick Linskey, Abe White</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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">&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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html#absolute-int-">absolute</a></span>(int&nbsp;pos)</code>
<div class="block">Move to the given 0-based position.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html#close--">close</a></span>()</code>
<div class="block">Free the resources associated with this provider.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html#getResultObject--">getResultObject</a></span>()</code>
<div class="block">Instantiate the current result object.</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/openjpa/lib/rop/ResultObjectProvider.html#handleCheckedException-java.lang.Exception-">handleCheckedException</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>&nbsp;e)</code>
<div class="block">Any checked exceptions that are thrown will be passed to this method.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html#next--">next</a></span>()</code>
<div class="block">Advance the input to the next position.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html#open--">open</a></span>()</code>
<div class="block">Open the result.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html#reset--">reset</a></span>()</code>
<div class="block">Reset this provider.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html#size--">size</a></span>()</code>
<div class="block">Return the number of items in the input, or <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true#MAX_VALUE" title="class or interface in java.lang"><code>Integer.MAX_VALUE</code></a>
if the size in unknown.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html#supportsRandomAccess--">supportsRandomAccess</a></span>()</code>
<div class="block">Return true if this provider supports random access.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="supportsRandomAccess--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>supportsRandomAccess</h4>
<pre>boolean&nbsp;supportsRandomAccess()</pre>
<div class="block">Return true if this provider supports random access.</div>
</li>
</ul>
<a name="open--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>open</h4>
<pre>void&nbsp;open()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Open the result. This will be called before
<a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html#next--"><code>next()</code></a>, <a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html#absolute-int-"><code>absolute(int)</code></a>, or <a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html#size--"><code>size()</code></a>.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="getResultObject--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResultObject</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;getResultObject()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Instantiate the current result object. This method will only be
called after <a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html#next--"><code>next()</code></a> or <a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html#absolute-int-"><code>absolute(int)</code></a>.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="next--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>next</h4>
<pre>boolean&nbsp;next()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Advance the input to the next position. Return <code>true</code> if
there is more data; otherwise <code>false</code>.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="absolute-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>absolute</h4>
<pre>boolean&nbsp;absolute(int&nbsp;pos)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Move to the given 0-based position. This method is
only called for providers that support random access.
Return <code>true</code> if there is data at this position;
otherwise <code>false</code>. This may be invoked in place of
<a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html#next--"><code>next()</code></a>.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="size--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
<pre>int&nbsp;size()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Return the number of items in the input, or <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true#MAX_VALUE" title="class or interface in java.lang"><code>Integer.MAX_VALUE</code></a>
if the size in unknown.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="reset--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre>void&nbsp;reset()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Reset this provider. This is an optional operation. If supported,
it should move the position of the provider to before the first
element. Non-random-access providers may be able to support this
method by re-acquiring all resources as if the result were just opened.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>void&nbsp;close()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Free the resources associated with this provider.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/lib/util/Closeable.html#close--">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openjpa/lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="handleCheckedException-java.lang.Exception-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>handleCheckedException</h4>
<pre>void&nbsp;handleCheckedException(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>&nbsp;e)</pre>
<div class="block">Any checked exceptions that are thrown will be passed to this method.
The provider should re-throw the exception as an appropriate unchecked
exception.</div>
</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/ResultObjectProvider.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/lib/rop/ResultListIterator.html" title="class in org.apache.openjpa.lib.rop"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/lib/rop/ResultObjectProviderIterator.html" title="class in org.apache.openjpa.lib.rop"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/lib/rop/ResultObjectProvider.html" target="_top">Frames</a></li>
<li><a href="ResultObjectProvider.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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;2020 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>