blob: ef1d74a97df30b7c81cf390a8fa2e4a0586fd91f [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:27 CEST 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Extent (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="Extent (OpenJPA Parent POM 3.1.2 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":38,"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"],32:["t6","Deprecated 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/Extent.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/persistence/EntityNotFoundException.html" title="class in org.apache.openjpa.persistence"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/persistence/ExtentImpl.html" title="class in org.apache.openjpa.persistence"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/persistence/Extent.html" target="_top">Frames</a></li>
<li><a href="Extent.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.persistence</div>
<h2 title="Interface Extent" class="title">Interface Extent&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;T&gt;</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/openjpa/persistence/ExtentImpl.html" title="class in org.apache.openjpa.persistence">ExtentImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Extent&lt;T&gt;</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;T&gt;</pre>
<div class="block">An extent is a logical view of all instances of a class.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.4.0</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/Extent.html#closeAll--">closeAll</a></span>()</code>
<div class="block">Close all open iterators that are consuming database resources.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/Extent.html" title="interface in org.apache.openjpa.kernel">Extent</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/Extent.html#getDelegate--">getDelegate</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">cast to <a href="../../../../org/apache/openjpa/persistence/ExtentImpl.html" title="class in org.apache.openjpa.persistence"><code>ExtentImpl</code></a> instead. This
method pierces the published-API boundary, as does the SPI cast.</span></div>
</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;<a href="../../../../org/apache/openjpa/persistence/Extent.html" title="type parameter in Extent">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/Extent.html#getElementClass--">getElementClass</a></span>()</code>
<div class="block">The extent's element type.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/OpenJPAEntityManager.html" title="interface in org.apache.openjpa.persistence">OpenJPAEntityManager</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/Extent.html#getEntityManager--">getEntityManager</a></span>()</code>
<div class="block">The owning entity manager.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/Extent.html#getFetchPlan--">getFetchPlan</a></span>()</code>
<div class="block">Fetch configuration for controlling how iterated objects are loaded.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/Extent.html#getIgnoreChanges--">getIgnoreChanges</a></span>()</code>
<div class="block">Whether the extent sees inserts and deletes in the current transaction.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/Extent.html#hasSubclasses--">hasSubclasses</a></span>()</code>
<div class="block">Whether the extent includes subclasses.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/openjpa/persistence/Extent.html" title="type parameter in Extent">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/Extent.html#list--">list</a></span>()</code>
<div class="block">List the extent contents.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/persistence/Extent.html#setIgnoreChanges-boolean-">setIgnoreChanges</a></span>(boolean&nbsp;ignoreChanges)</code>
<div class="block">Whether the extent sees inserts and deletes in the current transaction.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Iterable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#forEach-java.util.function.Consumer-" title="class or interface in java.lang">forEach</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#iterator--" title="class or interface in java.lang">iterator</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#spliterator--" title="class or interface in java.lang">spliterator</a></code></li>
</ul>
</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="getElementClass--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getElementClass</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;<a href="../../../../org/apache/openjpa/persistence/Extent.html" title="type parameter in Extent">T</a>&gt;&nbsp;getElementClass()</pre>
<div class="block">The extent's element type.</div>
</li>
</ul>
<a name="hasSubclasses--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasSubclasses</h4>
<pre>boolean&nbsp;hasSubclasses()</pre>
<div class="block">Whether the extent includes subclasses.</div>
</li>
</ul>
<a name="getEntityManager--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEntityManager</h4>
<pre><a href="../../../../org/apache/openjpa/persistence/OpenJPAEntityManager.html" title="interface in org.apache.openjpa.persistence">OpenJPAEntityManager</a>&nbsp;getEntityManager()</pre>
<div class="block">The owning entity manager.</div>
</li>
</ul>
<a name="getFetchPlan--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFetchPlan</h4>
<pre><a href="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</a>&nbsp;getFetchPlan()</pre>
<div class="block">Fetch configuration for controlling how iterated objects are loaded.</div>
</li>
</ul>
<a name="getIgnoreChanges--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIgnoreChanges</h4>
<pre>boolean&nbsp;getIgnoreChanges()</pre>
<div class="block">Whether the extent sees inserts and deletes in the current transaction.</div>
</li>
</ul>
<a name="setIgnoreChanges-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIgnoreChanges</h4>
<pre>void&nbsp;setIgnoreChanges(boolean&nbsp;ignoreChanges)</pre>
<div class="block">Whether the extent sees inserts and deletes in the current transaction.</div>
</li>
</ul>
<a name="list--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>list</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/openjpa/persistence/Extent.html" title="type parameter in Extent">T</a>&gt;&nbsp;list()</pre>
<div class="block">List the extent contents.</div>
</li>
</ul>
<a name="closeAll--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>closeAll</h4>
<pre>void&nbsp;closeAll()</pre>
<div class="block">Close all open iterators that are consuming database resources.</div>
</li>
</ul>
<a name="getDelegate--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getDelegate</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
<a href="../../../../org/apache/openjpa/kernel/Extent.html" title="interface in org.apache.openjpa.kernel">Extent</a>&nbsp;getDelegate()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">cast to <a href="../../../../org/apache/openjpa/persistence/ExtentImpl.html" title="class in org.apache.openjpa.persistence"><code>ExtentImpl</code></a> instead. This
method pierces the published-API boundary, as does the SPI cast.</span></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/Extent.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/persistence/EntityNotFoundException.html" title="class in org.apache.openjpa.persistence"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/persistence/ExtentImpl.html" title="class in org.apache.openjpa.persistence"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/persistence/Extent.html" target="_top">Frames</a></li>
<li><a href="Extent.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>