http://git-wip-us.apache.org/repos/asf/cayenne-website/blob/0af753b3/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/DataPort.html ---------------------------------------------------------------------- diff --git a/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/DataPort.html b/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/DataPort.html new file mode 100644 index 0000000..5d441d0 --- /dev/null +++ b/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/DataPort.html @@ -0,0 +1,731 @@ +<!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:42:41 EDT 2006 --> +<TITLE> +DataPort (Cayenne API Documentation - v.1.2) +</TITLE> + +<META NAME="keywords" CONTENT="org.objectstyle.cayenne.access.DataPort class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../objectstyle-javadoc.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="DataPort (Cayenne API Documentation - v.1.2)"; +} +</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/objectstyle/cayenne/access/DataNode.html" title="class in org.objectstyle.cayenne.access"><B>PREV CLASS</B></A> + <A HREF="../../../../org/objectstyle/cayenne/access/DataPortDelegate.html" title="interface in org.objectstyle.cayenne.access"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/objectstyle/cayenne/access/DataPort.html" target="_top"><B>FRAMES</B></A> + <A HREF="DataPort.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <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.objectstyle.cayenne.access</FONT> +<BR> +Class DataPort</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.objectstyle.cayenne.access.DataPort</B> +</PRE> +<HR> +<DL> +<DT><PRE>public class <B>DataPort</B><DT>extends java.lang.Object</DL> +</PRE> + +<P> +An engine to port data between two DataNodes. These nodes can potentially connect to + databases from different vendors. The only assumption is that all of the DbEntities + (tables) being ported are present in both source and destination databases and are + adequately described by Cayenne mapping. + <p> + DataPort implements a Cayenne-based algorithm to read data from source DataNode and + write to destination DataNode. It uses DataPortDelegate interface to externalize + various things, such as determining what entities to port (include/exclude from port + based on some criteria), logging the progress of port operation, qualifying the + queries, etc. + </p> +<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> +<!-- =========== FIELD SUMMARY =========== --> + +<A NAME="field_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>Field Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataPort.html#cleaningDestination">cleaningDestination</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected <A HREF="../../../../org/objectstyle/cayenne/access/DataPortDelegate.html" title="interface in org.objectstyle.cayenne.access">DataPortDelegate</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataPort.html#delegate">delegate</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected <A HREF="../../../../org/objectstyle/cayenne/access/DataNode.html" title="class in org.objectstyle.cayenne.access">DataNode</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataPort.html#destinationNode">destinationNode</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected java.util.Collection</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataPort.html#entities">entities</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataPort.html#INSERT_BATCH_SIZE">INSERT_BATCH_SIZE</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataPort.html#insertBatchSize">insertBatchSize</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected <A HREF="../../../../org/objectstyle/cayenne/access/DataNode.html" title="class in org.objectstyle.cayenne.access">DataNode</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataPort.html#sourceNode">sourceNode</A></B></CODE> + +<BR> + </TD> +</TR> +</TABLE> + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_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>Constructor Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataPort.html#DataPort()">DataPort</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataPort.html#DataPort(org.objectstyle.cayenne.access.DataPortDelegate)">DataPort</A></B>(<A HREF="../../../../org/objectstyle/cayenne/access/DataPortDelegate.html" title="interface in org.objectstyle.cayenne.access">DataPortDelegate</A> delegate)</CODE> + +<BR> + Creates a new DataPort instance, setting its delegate.</TD> +</TR> +</TABLE> + +<!-- ========== 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/objectstyle/cayenne/access/DataPort.html#execute()">execute</A></B>()</CODE> + +<BR> + Runs DataPort.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../org/objectstyle/cayenne/access/DataPortDelegate.html" title="interface in org.objectstyle.cayenne.access">DataPortDelegate</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataPort.html#getDelegate()">getDelegate</A></B>()</CODE> + +<BR> + Returns previously initialized DataPortDelegate object.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../org/objectstyle/cayenne/access/DataNode.html" title="class in org.objectstyle.cayenne.access">DataNode</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataPort.html#getDestinationNode()">getDestinationNode</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.Collection</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataPort.html#getEntities()">getEntities</A></B>()</CODE> + +<BR> + </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/objectstyle/cayenne/access/DataPort.html#getInsertBatchSize()">getInsertBatchSize</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../org/objectstyle/cayenne/access/DataNode.html" title="class in org.objectstyle.cayenne.access">DataNode</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataPort.html#getSourceNode()">getSourceNode</A></B>()</CODE> + +<BR> + </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/objectstyle/cayenne/access/DataPort.html#isCleaningDestination()">isCleaningDestination</A></B>()</CODE> + +<BR> + Returns true if a DataPort was configured to delete all data from the destination + tables.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataPort.html#processDelete(java.util.List)">processDelete</A></B>(java.util.List entities)</CODE> + +<BR> + Cleans up destination tables data.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataPort.html#processInsert(java.util.List)">processInsert</A></B>(java.util.List entities)</CODE> + +<BR> + Reads source data from source, saving it to destination.</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/objectstyle/cayenne/access/DataPort.html#setCleaningDestination(boolean)">setCleaningDestination</A></B>(boolean cleaningDestination)</CODE> + +<BR> + Defines whether DataPort should delete all data from destination tables before + doing the port.</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/objectstyle/cayenne/access/DataPort.html#setDelegate(org.objectstyle.cayenne.access.DataPortDelegate)">setDelegate</A></B>(<A HREF="../../../../org/objectstyle/cayenne/access/DataPortDelegate.html" title="interface in org.objectstyle.cayenne.access">DataPortDelegate</A> delegate)</CODE> + +<BR> + </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/objectstyle/cayenne/access/DataPort.html#setDestinationNode(org.objectstyle.cayenne.access.DataNode)">setDestinationNode</A></B>(<A HREF="../../../../org/objectstyle/cayenne/access/DataNode.html" title="class in org.objectstyle.cayenne.access">DataNode</A> destinationNode)</CODE> + +<BR> + Sets the DataNode serving as a destination of the ported data.</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/objectstyle/cayenne/access/DataPort.html#setEntities(java.util.Collection)">setEntities</A></B>(java.util.Collection entities)</CODE> + +<BR> + Sets the initial list of entities to process.</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/objectstyle/cayenne/access/DataPort.html#setInsertBatchSize(int)">setInsertBatchSize</A></B>(int insertBatchSize)</CODE> + +<BR> + Sets a parameter used for tuning insert batches.</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/objectstyle/cayenne/access/DataPort.html#setSourceNode(org.objectstyle.cayenne.access.DataNode)">setSourceNode</A></B>(<A HREF="../../../../org/objectstyle/cayenne/access/DataNode.html" title="class in org.objectstyle.cayenne.access">DataNode</A> sourceNode)</CODE> + +<BR> + Sets the DataNode serving as a source of the ported data.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ============ FIELD DETAIL =========== --> + +<A NAME="field_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>Field Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="INSERT_BATCH_SIZE"><!-- --></A><H3> +INSERT_BATCH_SIZE</H3> +<PRE> +public static final int <B>INSERT_BATCH_SIZE</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.objectstyle.cayenne.access.DataPort.INSERT_BATCH_SIZE">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="sourceNode"><!-- --></A><H3> +sourceNode</H3> +<PRE> +protected <A HREF="../../../../org/objectstyle/cayenne/access/DataNode.html" title="class in org.objectstyle.cayenne.access">DataNode</A> <B>sourceNode</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="destinationNode"><!-- --></A><H3> +destinationNode</H3> +<PRE> +protected <A HREF="../../../../org/objectstyle/cayenne/access/DataNode.html" title="class in org.objectstyle.cayenne.access">DataNode</A> <B>destinationNode</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="entities"><!-- --></A><H3> +entities</H3> +<PRE> +protected java.util.Collection <B>entities</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="cleaningDestination"><!-- --></A><H3> +cleaningDestination</H3> +<PRE> +protected boolean <B>cleaningDestination</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="delegate"><!-- --></A><H3> +delegate</H3> +<PRE> +protected <A HREF="../../../../org/objectstyle/cayenne/access/DataPortDelegate.html" title="interface in org.objectstyle.cayenne.access">DataPortDelegate</A> <B>delegate</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="insertBatchSize"><!-- --></A><H3> +insertBatchSize</H3> +<PRE> +protected int <B>insertBatchSize</B></PRE> +<DL> +<DL> +</DL> +</DL> + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_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>Constructor Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="DataPort()"><!-- --></A><H3> +DataPort</H3> +<PRE> +public <B>DataPort</B>()</PRE> +<DL> +</DL> +<HR> + +<A NAME="DataPort(org.objectstyle.cayenne.access.DataPortDelegate)"><!-- --></A><H3> +DataPort</H3> +<PRE> +public <B>DataPort</B>(<A HREF="../../../../org/objectstyle/cayenne/access/DataPortDelegate.html" title="interface in org.objectstyle.cayenne.access">DataPortDelegate</A> delegate)</PRE> +<DL> +<DD>Creates a new DataPort instance, setting its delegate. +<P> +</DL> + +<!-- ============ 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="execute()"><!-- --></A><H3> +execute</H3> +<PRE> +public void <B>execute</B>() + throws <A HREF="../../../../org/objectstyle/cayenne/CayenneException.html" title="class in org.objectstyle.cayenne">CayenneException</A></PRE> +<DL> +<DD>Runs DataPort. The instance must be fully configured by the time this method is + invoked, having its delegate, source and destinatio nodes, and a list of entities + set up. +<P> +<DD><DL> + +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../../org/objectstyle/cayenne/CayenneException.html" title="class in org.objectstyle.cayenne">CayenneException</A></CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="processDelete(java.util.List)"><!-- --></A><H3> +processDelete</H3> +<PRE> +protected void <B>processDelete</B>(java.util.List entities)</PRE> +<DL> +<DD>Cleans up destination tables data. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="processInsert(java.util.List)"><!-- --></A><H3> +processInsert</H3> +<PRE> +protected void <B>processInsert</B>(java.util.List entities) + throws <A HREF="../../../../org/objectstyle/cayenne/CayenneException.html" title="class in org.objectstyle.cayenne">CayenneException</A></PRE> +<DL> +<DD>Reads source data from source, saving it to destination. +<P> +<DD><DL> + +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../../org/objectstyle/cayenne/CayenneException.html" title="class in org.objectstyle.cayenne">CayenneException</A></CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="getEntities()"><!-- --></A><H3> +getEntities</H3> +<PRE> +public java.util.Collection <B>getEntities</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getSourceNode()"><!-- --></A><H3> +getSourceNode</H3> +<PRE> +public <A HREF="../../../../org/objectstyle/cayenne/access/DataNode.html" title="class in org.objectstyle.cayenne.access">DataNode</A> <B>getSourceNode</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getDestinationNode()"><!-- --></A><H3> +getDestinationNode</H3> +<PRE> +public <A HREF="../../../../org/objectstyle/cayenne/access/DataNode.html" title="class in org.objectstyle.cayenne.access">DataNode</A> <B>getDestinationNode</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setEntities(java.util.Collection)"><!-- --></A><H3> +setEntities</H3> +<PRE> +public void <B>setEntities</B>(java.util.Collection entities)</PRE> +<DL> +<DD>Sets the initial list of entities to process. This list can be later modified by + the delegate. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setSourceNode(org.objectstyle.cayenne.access.DataNode)"><!-- --></A><H3> +setSourceNode</H3> +<PRE> +public void <B>setSourceNode</B>(<A HREF="../../../../org/objectstyle/cayenne/access/DataNode.html" title="class in org.objectstyle.cayenne.access">DataNode</A> sourceNode)</PRE> +<DL> +<DD>Sets the DataNode serving as a source of the ported data. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setDestinationNode(org.objectstyle.cayenne.access.DataNode)"><!-- --></A><H3> +setDestinationNode</H3> +<PRE> +public void <B>setDestinationNode</B>(<A HREF="../../../../org/objectstyle/cayenne/access/DataNode.html" title="class in org.objectstyle.cayenne.access">DataNode</A> destinationNode)</PRE> +<DL> +<DD>Sets the DataNode serving as a destination of the ported data. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getDelegate()"><!-- --></A><H3> +getDelegate</H3> +<PRE> +public <A HREF="../../../../org/objectstyle/cayenne/access/DataPortDelegate.html" title="interface in org.objectstyle.cayenne.access">DataPortDelegate</A> <B>getDelegate</B>()</PRE> +<DL> +<DD>Returns previously initialized DataPortDelegate object. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setDelegate(org.objectstyle.cayenne.access.DataPortDelegate)"><!-- --></A><H3> +setDelegate</H3> +<PRE> +public void <B>setDelegate</B>(<A HREF="../../../../org/objectstyle/cayenne/access/DataPortDelegate.html" title="interface in org.objectstyle.cayenne.access">DataPortDelegate</A> delegate)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="isCleaningDestination()"><!-- --></A><H3> +isCleaningDestination</H3> +<PRE> +public boolean <B>isCleaningDestination</B>()</PRE> +<DL> +<DD>Returns true if a DataPort was configured to delete all data from the destination + tables. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setCleaningDestination(boolean)"><!-- --></A><H3> +setCleaningDestination</H3> +<PRE> +public void <B>setCleaningDestination</B>(boolean cleaningDestination)</PRE> +<DL> +<DD>Defines whether DataPort should delete all data from destination tables before + doing the port. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getInsertBatchSize()"><!-- --></A><H3> +getInsertBatchSize</H3> +<PRE> +public int <B>getInsertBatchSize</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setInsertBatchSize(int)"><!-- --></A><H3> +setInsertBatchSize</H3> +<PRE> +public void <B>setInsertBatchSize</B>(int insertBatchSize)</PRE> +<DL> +<DD>Sets a parameter used for tuning insert batches. If set to a value greater than + zero, DataPort will commit every N rows. If set to value less or equal to zero, + DataPort will commit only once at the end of the insert. +<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/objectstyle/cayenne/access/DataNode.html" title="class in org.objectstyle.cayenne.access"><B>PREV CLASS</B></A> + <A HREF="../../../../org/objectstyle/cayenne/access/DataPortDelegate.html" title="interface in org.objectstyle.cayenne.access"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/objectstyle/cayenne/access/DataPort.html" target="_top"><B>FRAMES</B></A> + <A HREF="DataPort.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> + + <!--@SFLOGO@--> <i>Copyright © 2001-2006 <a href= + "http://objectstyle.org"; target="_top">ObjectStyle.org</a> All Rights Reserved.</i> + +</BODY> +</HTML>
http://git-wip-us.apache.org/repos/asf/cayenne-website/blob/0af753b3/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/DataPortDelegate.html ---------------------------------------------------------------------- diff --git a/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/DataPortDelegate.html b/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/DataPortDelegate.html new file mode 100644 index 0000000..0d8c5ad --- /dev/null +++ b/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/DataPortDelegate.html @@ -0,0 +1,355 @@ +<!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:42:41 EDT 2006 --> +<TITLE> +DataPortDelegate (Cayenne API Documentation - v.1.2) +</TITLE> + +<META NAME="keywords" CONTENT="org.objectstyle.cayenne.access.DataPortDelegate interface"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../objectstyle-javadoc.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="DataPortDelegate (Cayenne API Documentation - v.1.2)"; +} +</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/objectstyle/cayenne/access/DataPort.html" title="class in org.objectstyle.cayenne.access"><B>PREV CLASS</B></A> + <A HREF="../../../../org/objectstyle/cayenne/access/DataRowStore.html" title="class in org.objectstyle.cayenne.access"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/objectstyle/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.objectstyle.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/objectstyle/cayenne/access/DataPortDelegate.html#didCleanData(org.objectstyle.cayenne.access.DataPort, org.objectstyle.cayenne.map.DbEntity, int)">didCleanData</A></B>(<A HREF="../../../../org/objectstyle/cayenne/access/DataPort.html" title="class in org.objectstyle.cayenne.access">DataPort</A> portTool, + <A HREF="../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.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/objectstyle/cayenne/access/DataPortDelegate.html#didPortEntity(org.objectstyle.cayenne.access.DataPort, org.objectstyle.cayenne.map.DbEntity, int)">didPortEntity</A></B>(<A HREF="../../../../org/objectstyle/cayenne/access/DataPort.html" title="class in org.objectstyle.cayenne.access">DataPort</A> portTool, + <A HREF="../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.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/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataPortDelegate.html#willCleanData(org.objectstyle.cayenne.access.DataPort, org.objectstyle.cayenne.map.DbEntity, org.objectstyle.cayenne.query.Query)">willCleanData</A></B>(<A HREF="../../../../org/objectstyle/cayenne/access/DataPort.html" title="class in org.objectstyle.cayenne.access">DataPort</A> portTool, + <A HREF="../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> entity, + <A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.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/objectstyle/cayenne/access/DataPortDelegate.html#willCleanData(org.objectstyle.cayenne.access.DataPort, java.util.List)">willCleanData</A></B>(<A HREF="../../../../org/objectstyle/cayenne/access/DataPort.html" title="class in org.objectstyle.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/objectstyle/cayenne/access/DataPortDelegate.html#willPortEntities(org.objectstyle.cayenne.access.DataPort, java.util.List)">willPortEntities</A></B>(<A HREF="../../../../org/objectstyle/cayenne/access/DataPort.html" title="class in org.objectstyle.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/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataPortDelegate.html#willPortEntity(org.objectstyle.cayenne.access.DataPort, org.objectstyle.cayenne.map.DbEntity, org.objectstyle.cayenne.query.Query)">willPortEntity</A></B>(<A HREF="../../../../org/objectstyle/cayenne/access/DataPort.html" title="class in org.objectstyle.cayenne.access">DataPort</A> portTool, + <A HREF="../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> entity, + <A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.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.objectstyle.cayenne.access.DataPort, java.util.List)"><!-- --></A><H3> +willPortEntities</H3> +<PRE> +java.util.List <B>willPortEntities</B>(<A HREF="../../../../org/objectstyle/cayenne/access/DataPort.html" title="class in org.objectstyle.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.objectstyle.cayenne.access.DataPort, org.objectstyle.cayenne.map.DbEntity, org.objectstyle.cayenne.query.Query)"><!-- --></A><H3> +willPortEntity</H3> +<PRE> +<A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A> <B>willPortEntity</B>(<A HREF="../../../../org/objectstyle/cayenne/access/DataPort.html" title="class in org.objectstyle.cayenne.access">DataPort</A> portTool, + <A HREF="../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> entity, + <A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.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.objectstyle.cayenne.access.DataPort, org.objectstyle.cayenne.map.DbEntity, int)"><!-- --></A><H3> +didPortEntity</H3> +<PRE> +void <B>didPortEntity</B>(<A HREF="../../../../org/objectstyle/cayenne/access/DataPort.html" title="class in org.objectstyle.cayenne.access">DataPort</A> portTool, + <A HREF="../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.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.objectstyle.cayenne.access.DataPort, java.util.List)"><!-- --></A><H3> +willCleanData</H3> +<PRE> +java.util.List <B>willCleanData</B>(<A HREF="../../../../org/objectstyle/cayenne/access/DataPort.html" title="class in org.objectstyle.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.objectstyle.cayenne.access.DataPort, org.objectstyle.cayenne.map.DbEntity, org.objectstyle.cayenne.query.Query)"><!-- --></A><H3> +willCleanData</H3> +<PRE> +<A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.cayenne.query">Query</A> <B>willCleanData</B>(<A HREF="../../../../org/objectstyle/cayenne/access/DataPort.html" title="class in org.objectstyle.cayenne.access">DataPort</A> portTool, + <A HREF="../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> entity, + <A HREF="../../../../org/objectstyle/cayenne/query/Query.html" title="interface in org.objectstyle.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.objectstyle.cayenne.access.DataPort, org.objectstyle.cayenne.map.DbEntity, int)"><!-- --></A><H3> +didCleanData</H3> +<PRE> +void <B>didCleanData</B>(<A HREF="../../../../org/objectstyle/cayenne/access/DataPort.html" title="class in org.objectstyle.cayenne.access">DataPort</A> portTool, + <A HREF="../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.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/objectstyle/cayenne/access/DataPort.html" title="class in org.objectstyle.cayenne.access"><B>PREV CLASS</B></A> + <A HREF="../../../../org/objectstyle/cayenne/access/DataRowStore.html" title="class in org.objectstyle.cayenne.access"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/objectstyle/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> + + <!--@SFLOGO@--> <i>Copyright © 2001-2006 <a href= + "http://objectstyle.org"; target="_top">ObjectStyle.org</a> All Rights Reserved.</i> + +</BODY> +</HTML>
