blob: ff2a0cfdfbff1f434d9a4b253cf988f4f5e43e20 [file] [log] [blame]
<!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 (version 1.7.0_121) on Fri Jan 06 19:36:24 UTC 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ChangeTracker (OpenJPA Parent POM 2.4.2 API)</title>
<meta name="date" content="2017-01-06">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ChangeTracker (OpenJPA Parent POM 2.4.2 API)";
}
}
catch(err) {
}
//-->
</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/ChangeTracker.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/util/CallbackException.html" title="class in org.apache.openjpa.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/util/CharId.html" title="class in org.apache.openjpa.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/util/ChangeTracker.html" target="_top">Frames</a></li>
<li><a href="ChangeTracker.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>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.util</div>
<h2 title="Interface ChangeTracker" class="title">Interface ChangeTracker</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../org/apache/openjpa/util/CollectionChangeTracker.html" title="interface in org.apache.openjpa.util">CollectionChangeTracker</a>, <a href="../../../../org/apache/openjpa/util/MapChangeTracker.html" title="interface in org.apache.openjpa.util">MapChangeTracker</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/openjpa/util/AbstractChangeTracker.html" title="class in org.apache.openjpa.util">AbstractChangeTracker</a>, <a href="../../../../org/apache/openjpa/util/AbstractLRSProxyCollection.html" title="class in org.apache.openjpa.util">AbstractLRSProxyCollection</a>, <a href="../../../../org/apache/openjpa/util/AbstractLRSProxyMap.html" title="class in org.apache.openjpa.util">AbstractLRSProxyMap</a>, <a href="../../../../org/apache/openjpa/util/CollectionChangeTrackerImpl.html" title="class in org.apache.openjpa.util">CollectionChangeTrackerImpl</a>, <a href="../../../../org/apache/openjpa/util/DelayedCollectionChangeTrackerImpl.html" title="class in org.apache.openjpa.util">DelayedCollectionChangeTrackerImpl</a>, <a href="../../../../org/apache/openjpa/jdbc/meta/strats/LRSProxyCollection.html" title="class in org.apache.openjpa.jdbc.meta.strats">LRSProxyCollection</a>, <a href="../../../../org/apache/openjpa/util/MapChangeTrackerImpl.html" title="class in org.apache.openjpa.util">MapChangeTrackerImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">ChangeTracker</span></pre>
<div class="block">Interface for components that track changes to containers at a
fine-grained level. Proxies that use change trackers might have better
update performance than non-tracking proxies.</div>
<dl><dt><span class="strong">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="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><a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/util/ChangeTracker.html#getAdded()">getAdded</a></strong>()</code>
<div class="block">Return the collection of values that need to be added to the managed
container.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/util/ChangeTracker.html#getChanged()">getChanged</a></strong>()</code>
<div class="block">Return the set of elements that have changed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/util/ChangeTracker.html#getNextSequence()">getNextSequence</a></strong>()</code>
<div class="block">The next element sequence value for this proxy at load time.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/util/ChangeTracker.html#getRemoved()">getRemoved</a></strong>()</code>
<div class="block">Return the set of values that need to be removed from the managed
container.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/util/ChangeTracker.html#isTracking()">isTracking</a></strong>()</code>
<div class="block">Return true if this tracker has an up-to-date view of all the changes
to the container it is managing.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/util/ChangeTracker.html#setNextSequence(int)">setNextSequence</a></strong>(int&nbsp;seq)</code>
<div class="block">The maximum element sequence value for this proxy at load time.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/util/ChangeTracker.html#startTracking()">startTracking</a></strong>()</code>
<div class="block">Reset the state of the change tracker, and turn change tracking back
on if it has been disabled.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/util/ChangeTracker.html#stopTracking()">stopTracking</a></strong>()</code>
<div class="block">Tell the tracker to stop tracking changes for its container.</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="isTracking()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isTracking</h4>
<pre>boolean&nbsp;isTracking()</pre>
<div class="block">Return true if this tracker has an up-to-date view of all the changes
to the container it is managing.</div>
</li>
</ul>
<a name="startTracking()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startTracking</h4>
<pre>void&nbsp;startTracking()</pre>
<div class="block">Reset the state of the change tracker, and turn change tracking back
on if it has been disabled.</div>
</li>
</ul>
<a name="stopTracking()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stopTracking</h4>
<pre>void&nbsp;stopTracking()</pre>
<div class="block">Tell the tracker to stop tracking changes for its container.</div>
</li>
</ul>
<a name="getAdded()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAdded</h4>
<pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&nbsp;getAdded()</pre>
<div class="block">Return the collection of values that need to be added to the managed
container.</div>
</li>
</ul>
<a name="getRemoved()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemoved</h4>
<pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&nbsp;getRemoved()</pre>
<div class="block">Return the set of values that need to be removed from the managed
container.</div>
</li>
</ul>
<a name="getChanged()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChanged</h4>
<pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&nbsp;getChanged()</pre>
<div class="block">Return the set of elements that have changed. In maps, this marks a
possible change in value for a key. In collections, this marks an
element that has been removed and re-added.</div>
</li>
</ul>
<a name="getNextSequence()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNextSequence</h4>
<pre>int&nbsp;getNextSequence()</pre>
<div class="block">The next element sequence value for this proxy at load time.
If the data store keeps this proxy's data in sequence order but allows
holes for removed objects, the implementation can set the next
sequence at load time, then retrieve it and start from there for
added objects at flush time. This value is set back to 0 if the
proxy stops tracking changes. For ordered proxies, it is set to the
proxy's size when the proxy starts tracking changes again.</div>
</li>
</ul>
<a name="setNextSequence(int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setNextSequence</h4>
<pre>void&nbsp;setNextSequence(int&nbsp;seq)</pre>
<div class="block">The maximum element sequence value for this proxy at load time.
If the data store keeps this proxy's data in sequence order but allows
holes for removed objects, the implementation can set the next
sequence at load time, then retrieve it and start from there for
added objects at flush time. This value is set back to 0 if the
proxy stops tracking changes. For ordered proxies, it is set to the
proxy's size when the proxy starts tracking changes again.</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><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/ChangeTracker.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/util/CallbackException.html" title="class in org.apache.openjpa.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/util/CharId.html" title="class in org.apache.openjpa.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/util/ChangeTracker.html" target="_top">Frames</a></li>
<li><a href="ChangeTracker.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>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;2017 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>