| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.5.0_15) on Fri Mar 13 09:15:46 CDT 2009 --> |
| <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| <TITLE> |
| ChangeTracker (OpenJPA 1.2.1 API) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.openjpa.util.ChangeTracker interface"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="ChangeTracker (OpenJPA 1.2.1 API)"; |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ChangeTracker.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/openjpa/util/CallbackException.html" title="class in org.apache.openjpa.util"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/openjpa/util/CharId.html" title="class in org.apache.openjpa.util"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/openjpa/util/ChangeTracker.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="ChangeTracker.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.openjpa.util</FONT> |
| <BR> |
| Interface ChangeTracker</H2> |
| <DL> |
| <DT><B>All Known Subinterfaces:</B> <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><B>All Known Implementing Classes:</B> <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/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> |
| <DL> |
| <DT><PRE>public interface <B>ChangeTracker</B></DL> |
| </PRE> |
| |
| <P> |
| 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. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Author:</B></DT> |
| <DD>Abe White</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/util/ChangeTracker.html#getAdded()">getAdded</A></B>()</CODE> |
| |
| <BR> |
| Return the collection of values that need to be added to the managed |
| container.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/util/ChangeTracker.html#getChanged()">getChanged</A></B>()</CODE> |
| |
| <BR> |
| Return the set of elements that have changed.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/util/ChangeTracker.html#getNextSequence()">getNextSequence</A></B>()</CODE> |
| |
| <BR> |
| The next element sequence value for this proxy at load time.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/util/ChangeTracker.html#getRemoved()">getRemoved</A></B>()</CODE> |
| |
| <BR> |
| Return the set of values that need to be removed from the managed |
| container.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/util/ChangeTracker.html#isTracking()">isTracking</A></B>()</CODE> |
| |
| <BR> |
| Return true if this tracker has an up-to-date view of all the changes |
| to the container it is managing.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/util/ChangeTracker.html#setNextSequence(int)">setNextSequence</A></B>(int seq)</CODE> |
| |
| <BR> |
| The maximum element sequence value for this proxy at load time.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/util/ChangeTracker.html#startTracking()">startTracking</A></B>()</CODE> |
| |
| <BR> |
| Reset the state of the change tracker, and turn change tracking back |
| on if it has been disabled.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/util/ChangeTracker.html#stopTracking()">stopTracking</A></B>()</CODE> |
| |
| <BR> |
| Tell the tracker to stop tracking changes for its container.</TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="isTracking()"><!-- --></A><H3> |
| isTracking</H3> |
| <PRE> |
| boolean <B>isTracking</B>()</PRE> |
| <DL> |
| <DD>Return true if this tracker has an up-to-date view of all the changes |
| to the container it is managing. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="startTracking()"><!-- --></A><H3> |
| startTracking</H3> |
| <PRE> |
| void <B>startTracking</B>()</PRE> |
| <DL> |
| <DD>Reset the state of the change tracker, and turn change tracking back |
| on if it has been disabled. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="stopTracking()"><!-- --></A><H3> |
| stopTracking</H3> |
| <PRE> |
| void <B>stopTracking</B>()</PRE> |
| <DL> |
| <DD>Tell the tracker to stop tracking changes for its container. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAdded()"><!-- --></A><H3> |
| getAdded</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> <B>getAdded</B>()</PRE> |
| <DL> |
| <DD>Return the collection of values that need to be added to the managed |
| container. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getRemoved()"><!-- --></A><H3> |
| getRemoved</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> <B>getRemoved</B>()</PRE> |
| <DL> |
| <DD>Return the set of values that need to be removed from the managed |
| container. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getChanged()"><!-- --></A><H3> |
| getChanged</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> <B>getChanged</B>()</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getNextSequence()"><!-- --></A><H3> |
| getNextSequence</H3> |
| <PRE> |
| int <B>getNextSequence</B>()</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setNextSequence(int)"><!-- --></A><H3> |
| setNextSequence</H3> |
| <PRE> |
| void <B>setNextSequence</B>(int seq)</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ChangeTracker.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/openjpa/util/CallbackException.html" title="class in org.apache.openjpa.util"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/openjpa/util/CharId.html" title="class in org.apache.openjpa.util"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/openjpa/util/ChangeTracker.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="ChangeTracker.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2006-2009 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
