| <!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_67) on Sat Sep 20 17:22:59 FET 2014 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>DataPortDelegate (Cayenne Documentation 3.1 API)</title> |
| <meta name="date" content="2014-09-20"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="DataPortDelegate (Cayenne Documentation 3.1 API)"; |
| } |
| //--> |
| </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/DataPortDelegate.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/cayenne/access/DataPort.html" title="class in org.apache.cayenne.access"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/cayenne/access/DataRowStore.html" title="class in org.apache.cayenne.access"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/cayenne/access/DataPortDelegate.html" target="_top">Frames</a></li> |
| <li><a href="DataPortDelegate.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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.cayenne.access</div> |
| <h2 title="Interface DataPortDelegate" class="title">Interface DataPortDelegate</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">DataPortDelegate</span></pre> |
| <div class="block">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.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.2: Prior to 1.2 DataPort classes were a part of cayenne-examples package.</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"> </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>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/access/DataPortDelegate.html#didCleanData(org.apache.cayenne.access.DataPort,%20org.apache.cayenne.map.DbEntity,%20int)">didCleanData</a></strong>(<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> |
| <div class="block">Invoked by DataPort right after the end of data cleanup for a given entity.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/access/DataPortDelegate.html#didPortEntity(org.apache.cayenne.access.DataPort,%20org.apache.cayenne.map.DbEntity,%20int)">didPortEntity</a></strong>(<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> |
| <div class="block">Invoked by DataPort right after the end of data port for a given entity.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/access/DataPortDelegate.html#willCleanData(org.apache.cayenne.access.DataPort,%20org.apache.cayenne.map.DbEntity,%20org.apache.cayenne.query.Query)">willCleanData</a></strong>(<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> |
| <div class="block">Invoked by DataPort right before the start of data cleanup for a given entity.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/access/DataPortDelegate.html#willCleanData(org.apache.cayenne.access.DataPort,%20java.util.List)">willCleanData</a></strong>(<a href="../../../../org/apache/cayenne/access/DataPort.html" title="class in org.apache.cayenne.access">DataPort</a> portTool, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a> entities)</code> |
| <div class="block">Allows delegate to sort or otherwise alter a list of DbEntities right before data |
| cleanup starts.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/access/DataPortDelegate.html#willPortEntities(org.apache.cayenne.access.DataPort,%20java.util.List)">willPortEntities</a></strong>(<a href="../../../../org/apache/cayenne/access/DataPort.html" title="class in org.apache.cayenne.access">DataPort</a> portTool, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a> entities)</code> |
| <div class="block">Allows delegate to sort or otherwise alter a list of DbEntities right before the |
| port starts.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/access/DataPortDelegate.html#willPortEntity(org.apache.cayenne.access.DataPort,%20org.apache.cayenne.map.DbEntity,%20org.apache.cayenne.query.Query)">willPortEntity</a></strong>(<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> |
| <div class="block">Invoked by DataPort right before the start of data port for a given entity.</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="willPortEntities(org.apache.cayenne.access.DataPort, java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>willPortEntities</h4> |
| <pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a> willPortEntities(<a href="../../../../org/apache/cayenne/access/DataPort.html" title="class in org.apache.cayenne.access">DataPort</a> portTool, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a> entities)</pre> |
| <div class="block">Allows delegate to sort or otherwise alter a list of DbEntities right before the |
| port starts.</div> |
| </li> |
| </ul> |
| <a name="willPortEntity(org.apache.cayenne.access.DataPort, org.apache.cayenne.map.DbEntity, org.apache.cayenne.query.Query)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>willPortEntity</h4> |
| <pre><a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a> willPortEntity(<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> |
| <div class="block">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.</div> |
| </li> |
| </ul> |
| <a name="didPortEntity(org.apache.cayenne.access.DataPort, org.apache.cayenne.map.DbEntity, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>didPortEntity</h4> |
| <pre>void didPortEntity(<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> |
| <div class="block">Invoked by DataPort right after the end of data port for a given entity. Allows |
| delegate to handle such things like logging, etc.</div> |
| </li> |
| </ul> |
| <a name="willCleanData(org.apache.cayenne.access.DataPort, java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>willCleanData</h4> |
| <pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a> willCleanData(<a href="../../../../org/apache/cayenne/access/DataPort.html" title="class in org.apache.cayenne.access">DataPort</a> portTool, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a> entities)</pre> |
| <div class="block">Allows delegate to sort or otherwise alter a list of DbEntities right before data |
| cleanup starts.</div> |
| </li> |
| </ul> |
| <a name="willCleanData(org.apache.cayenne.access.DataPort, org.apache.cayenne.map.DbEntity, org.apache.cayenne.query.Query)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>willCleanData</h4> |
| <pre><a href="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</a> willCleanData(<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> |
| <div class="block">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.</div> |
| </li> |
| </ul> |
| <a name="didCleanData(org.apache.cayenne.access.DataPort, org.apache.cayenne.map.DbEntity, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>didCleanData</h4> |
| <pre>void didCleanData(<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> |
| <div class="block">Invoked by DataPort right after the end of data cleanup for a given entity. Allows |
| delegate to handle such things like logging, etc.</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/DataPortDelegate.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/cayenne/access/DataPort.html" title="class in org.apache.cayenne.access"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/cayenne/access/DataRowStore.html" title="class in org.apache.cayenne.access"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/cayenne/access/DataPortDelegate.html" target="_top">Frames</a></li> |
| <li><a href="DataPortDelegate.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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 © 2001–2014 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
