| <!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_06) on Wed Jul 19 14:45:43 EDT 2006 --> |
| <TITLE> |
| DataPortDelegate (Apache Cayenne API Documentation - v.2.0-incubating-SNAPSHOT) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.cayenne.access.DataPortDelegate interface"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../apache-javadoc.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="DataPortDelegate (Apache Cayenne API Documentation - v.2.0-incubating-SNAPSHOT)"; |
| } |
| </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="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-files/index-1.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/cayenne/access/DataPort.html" title="class in org.apache.cayenne.access"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/cayenne/access/DataRowStore.html" title="class in org.apache.cayenne.access"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/cayenne/access/DataPortDelegate.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="DataPortDelegate.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.cayenne.access</FONT> |
| <BR> |
| Interface DataPortDelegate</H2> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>DataPortDelegate</B></DL> |
| </PRE> |
| |
| <P> |
| Interface for callback and delegate methods allowing implementing classes to control |
| various aspects of data porting via DataPort. DataPort instance will invoke appropriate |
| delegate methods during different stages of porting process. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2: Prior to 1.2 DataPort classes were a part of cayenne-examples package.</DD> |
| <DT><B>Author:</B></DT> |
| <DD>Andrei Adamchik</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> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/access/DataPortDelegate.html#didCleanData(org.apache.cayenne.access.DataPort, org.apache.cayenne.map.DbEntity, int)">didCleanData</A></B>(<A HREF="../../../../org/apache/cayenne/access/DataPort.html" title="class in org.apache.cayenne.access">DataPort</A> portTool, |
| <A HREF="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</A> entity, |
| int rowCount)</CODE> |
| |
| <BR> |
| Invoked by DataPort right after the end of data cleanup for a given entity.</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/cayenne/access/DataPortDelegate.html#didPortEntity(org.apache.cayenne.access.DataPort, org.apache.cayenne.map.DbEntity, int)">didPortEntity</A></B>(<A HREF="../../../../org/apache/cayenne/access/DataPort.html" title="class in org.apache.cayenne.access">DataPort</A> portTool, |
| <A HREF="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</A> entity, |
| int rowCount)</CODE> |
| |
| <BR> |
| Invoked by DataPort right after the end of data port for a given entity.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/access/DataPortDelegate.html#willCleanData(org.apache.cayenne.access.DataPort, org.apache.cayenne.map.DbEntity, org.apache.cayenne.query.Query)">willCleanData</A></B>(<A HREF="../../../../org/apache/cayenne/access/DataPort.html" title="class in org.apache.cayenne.access">DataPort</A> portTool, |
| <A HREF="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</A> entity, |
| <A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A> query)</CODE> |
| |
| <BR> |
| Invoked by DataPort right before the start of data cleanup for a given entity.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/access/DataPortDelegate.html#willCleanData(org.apache.cayenne.access.DataPort, java.util.List)">willCleanData</A></B>(<A HREF="../../../../org/apache/cayenne/access/DataPort.html" title="class in org.apache.cayenne.access">DataPort</A> portTool, |
| java.util.List entities)</CODE> |
| |
| <BR> |
| Allows delegate to sort or otherwise alter a list of DbEntities right before data |
| cleanup starts.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/access/DataPortDelegate.html#willPortEntities(org.apache.cayenne.access.DataPort, java.util.List)">willPortEntities</A></B>(<A HREF="../../../../org/apache/cayenne/access/DataPort.html" title="class in org.apache.cayenne.access">DataPort</A> portTool, |
| java.util.List entities)</CODE> |
| |
| <BR> |
| Allows delegate to sort or otherwise alter a list of DbEntities right before the |
| port starts.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/access/DataPortDelegate.html#willPortEntity(org.apache.cayenne.access.DataPort, org.apache.cayenne.map.DbEntity, org.apache.cayenne.query.Query)">willPortEntity</A></B>(<A HREF="../../../../org/apache/cayenne/access/DataPort.html" title="class in org.apache.cayenne.access">DataPort</A> portTool, |
| <A HREF="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</A> entity, |
| <A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A> query)</CODE> |
| |
| <BR> |
| Invoked by DataPort right before the start of data port for a given entity.</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="willPortEntities(org.apache.cayenne.access.DataPort, java.util.List)"><!-- --></A><H3> |
| willPortEntities</H3> |
| <PRE> |
| java.util.List <B>willPortEntities</B>(<A HREF="../../../../org/apache/cayenne/access/DataPort.html" title="class in org.apache.cayenne.access">DataPort</A> portTool, |
| java.util.List entities)</PRE> |
| <DL> |
| <DD>Allows delegate to sort or otherwise alter a list of DbEntities right before the |
| port starts. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="willPortEntity(org.apache.cayenne.access.DataPort, org.apache.cayenne.map.DbEntity, org.apache.cayenne.query.Query)"><!-- --></A><H3> |
| willPortEntity</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A> <B>willPortEntity</B>(<A HREF="../../../../org/apache/cayenne/access/DataPort.html" title="class in org.apache.cayenne.access">DataPort</A> portTool, |
| <A HREF="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</A> entity, |
| <A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A> query)</PRE> |
| <DL> |
| <DD>Invoked by DataPort right before the start of data port for a given entity. Allows |
| delegate to handle such things like logging, etc. Also makes it possible to |
| substitute or alter the select query used to fecth the source data, e.g. set a |
| limiting qualifier. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="didPortEntity(org.apache.cayenne.access.DataPort, org.apache.cayenne.map.DbEntity, int)"><!-- --></A><H3> |
| didPortEntity</H3> |
| <PRE> |
| void <B>didPortEntity</B>(<A HREF="../../../../org/apache/cayenne/access/DataPort.html" title="class in org.apache.cayenne.access">DataPort</A> portTool, |
| <A HREF="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</A> entity, |
| int rowCount)</PRE> |
| <DL> |
| <DD>Invoked by DataPort right after the end of data port for a given entity. Allows |
| delegate to handle such things like logging, etc. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="willCleanData(org.apache.cayenne.access.DataPort, java.util.List)"><!-- --></A><H3> |
| willCleanData</H3> |
| <PRE> |
| java.util.List <B>willCleanData</B>(<A HREF="../../../../org/apache/cayenne/access/DataPort.html" title="class in org.apache.cayenne.access">DataPort</A> portTool, |
| java.util.List entities)</PRE> |
| <DL> |
| <DD>Allows delegate to sort or otherwise alter a list of DbEntities right before data |
| cleanup starts. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="willCleanData(org.apache.cayenne.access.DataPort, org.apache.cayenne.map.DbEntity, org.apache.cayenne.query.Query)"><!-- --></A><H3> |
| willCleanData</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A> <B>willCleanData</B>(<A HREF="../../../../org/apache/cayenne/access/DataPort.html" title="class in org.apache.cayenne.access">DataPort</A> portTool, |
| <A HREF="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</A> entity, |
| <A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A> query)</PRE> |
| <DL> |
| <DD>Invoked by DataPort right before the start of data cleanup for a given entity. |
| Allows delegate to handle such things like logging, etc. Also makes it possible to |
| substitute or alter the delete query used to cleanup the data, e.g. set a limiting |
| qualifier. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="didCleanData(org.apache.cayenne.access.DataPort, org.apache.cayenne.map.DbEntity, int)"><!-- --></A><H3> |
| didCleanData</H3> |
| <PRE> |
| void <B>didCleanData</B>(<A HREF="../../../../org/apache/cayenne/access/DataPort.html" title="class in org.apache.cayenne.access">DataPort</A> portTool, |
| <A HREF="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</A> entity, |
| int rowCount)</PRE> |
| <DL> |
| <DD>Invoked by DataPort right after the end of data cleanup for a given entity. Allows |
| delegate to handle such things like logging, etc. |
| <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="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-files/index-1.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/cayenne/access/DataPort.html" title="class in org.apache.cayenne.access"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/cayenne/access/DataRowStore.html" title="class in org.apache.cayenne.access"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/cayenne/access/DataPortDelegate.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="DataPortDelegate.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> |
| |
| <i>Copyright © 2001-2006 <a href= |
| "http://apache.org" target="_top">Apache.org</a> All Rights Reserved.</i> |
| |
| </BODY> |
| </HTML> |
