Google Git
Sign in
apache / cayenne-website / 0af753b3ec346c0432aa26fe6065228badfd46ed / . / docs / 3.1 / api / org / apache / cayenne / access / DataPort.html
blob: a9b11e4a02e98318ec4f8fe6c8509e041a2fb79d [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sat Sep 20 17:22:59 FET 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>DataPort (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="DataPort (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/DataPort.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/DataNode.html" title="class in org.apache.cayenne.access"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cayenne/access/DataPortDelegate.html" title="interface 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/DataPort.html" target="_top">Frames</a></li>
<li><a href="DataPort.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.cayenne.access</div>
<h2 title="Class DataPort" class="title">Class DataPort</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.cayenne.access.DataPort</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">DataPort</span>
extends <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">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></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">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/access/DataPort.html#cleaningDestination">cleaningDestination</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/cayenne/access/DataPortDelegate.html" title="interface in org.apache.cayenne.access">DataPortDelegate</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/access/DataPort.html#delegate">delegate</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/cayenne/access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/access/DataPort.html#destinationNode">destinationNode</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/access/DataPort.html#entities">entities</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/access/DataPort.html#INSERT_BATCH_SIZE">INSERT_BATCH_SIZE</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/access/DataPort.html#insertBatchSize">insertBatchSize</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/cayenne/access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/access/DataPort.html#sourceNode">sourceNode</a></strong></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/cayenne/access/DataPort.html#DataPort()">DataPort</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/cayenne/access/DataPort.html#DataPort(org.apache.cayenne.access.DataPortDelegate)">DataPort</a></strong>(<a href="../../../../org/apache/cayenne/access/DataPortDelegate.html" title="interface in org.apache.cayenne.access">DataPortDelegate</a>&nbsp;delegate)</code>
<div class="block">Creates a new DataPort instance, setting its delegate.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/access/DataPort.html#execute()">execute</a></strong>()</code>
<div class="block">Runs DataPort.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/cayenne/access/DataPortDelegate.html" title="interface in org.apache.cayenne.access">DataPortDelegate</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/access/DataPort.html#getDelegate()">getDelegate</a></strong>()</code>
<div class="block">Returns previously initialized DataPortDelegate object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/cayenne/access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/access/DataPort.html#getDestinationNode()">getDestinationNode</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/access/DataPort.html#getEntities()">getEntities</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/access/DataPort.html#getInsertBatchSize()">getInsertBatchSize</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/cayenne/access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/access/DataPort.html#getSourceNode()">getSourceNode</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/access/DataPort.html#isCleaningDestination()">isCleaningDestination</a></strong>()</code>
<div class="block">Returns true if a DataPort was configured to delete all data from the destination
tables.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/access/DataPort.html#processDelete(java.util.List)">processDelete</a></strong>(<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>&nbsp;entities)</code>
<div class="block">Cleans up destination tables data.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/access/DataPort.html#processInsert(java.util.List)">processInsert</a></strong>(<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>&nbsp;entities)</code>
<div class="block">Reads source data from source, saving it to destination.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/access/DataPort.html#setCleaningDestination(boolean)">setCleaningDestination</a></strong>(boolean&nbsp;cleaningDestination)</code>
<div class="block">Defines whether DataPort should delete all data from destination tables before
doing the port.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/access/DataPort.html#setDelegate(org.apache.cayenne.access.DataPortDelegate)">setDelegate</a></strong>(<a href="../../../../org/apache/cayenne/access/DataPortDelegate.html" title="interface in org.apache.cayenne.access">DataPortDelegate</a>&nbsp;delegate)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/access/DataPort.html#setDestinationNode(org.apache.cayenne.access.DataNode)">setDestinationNode</a></strong>(<a href="../../../../org/apache/cayenne/access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</a>&nbsp;destinationNode)</code>
<div class="block">Sets the DataNode serving as a destination of the ported data.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/access/DataPort.html#setEntities(java.util.Collection)">setEntities</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&nbsp;entities)</code>
<div class="block">Sets the initial list of entities to process.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/access/DataPort.html#setInsertBatchSize(int)">setInsertBatchSize</a></strong>(int&nbsp;insertBatchSize)</code>
<div class="block">Sets a parameter used for tuning insert batches.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/access/DataPort.html#setSourceNode(org.apache.cayenne.access.DataNode)">setSourceNode</a></strong>(<a href="../../../../org/apache/cayenne/access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</a>&nbsp;sourceNode)</code>
<div class="block">Sets the DataNode serving as a source of the ported data.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="INSERT_BATCH_SIZE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INSERT_BATCH_SIZE</h4>
<pre>public static final&nbsp;int INSERT_BATCH_SIZE</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cayenne.access.DataPort.INSERT_BATCH_SIZE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="sourceNode">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sourceNode</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/cayenne/access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</a> sourceNode</pre>
</li>
</ul>
<a name="destinationNode">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>destinationNode</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/cayenne/access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</a> destinationNode</pre>
</li>
</ul>
<a name="entities">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>entities</h4>
<pre>protected&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> entities</pre>
</li>
</ul>
<a name="cleaningDestination">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cleaningDestination</h4>
<pre>protected&nbsp;boolean cleaningDestination</pre>
</li>
</ul>
<a name="delegate">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>delegate</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/cayenne/access/DataPortDelegate.html" title="interface in org.apache.cayenne.access">DataPortDelegate</a> delegate</pre>
</li>
</ul>
<a name="insertBatchSize">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>insertBatchSize</h4>
<pre>protected&nbsp;int insertBatchSize</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DataPort()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DataPort</h4>
<pre>public&nbsp;DataPort()</pre>
</li>
</ul>
<a name="DataPort(org.apache.cayenne.access.DataPortDelegate)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DataPort</h4>
<pre>public&nbsp;DataPort(<a href="../../../../org/apache/cayenne/access/DataPortDelegate.html" title="interface in org.apache.cayenne.access">DataPortDelegate</a>&nbsp;delegate)</pre>
<div class="block">Creates a new DataPort instance, setting its delegate.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="execute()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre>public&nbsp;void&nbsp;execute()
throws <a href="../../../../org/apache/cayenne/CayenneException.html" title="class in org.apache.cayenne">CayenneException</a></pre>
<div class="block">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.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/cayenne/CayenneException.html" title="class in org.apache.cayenne">CayenneException</a></code></dd></dl>
</li>
</ul>
<a name="processDelete(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>processDelete</h4>
<pre>protected&nbsp;void&nbsp;processDelete(<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>&nbsp;entities)</pre>
<div class="block">Cleans up destination tables data.</div>
</li>
</ul>
<a name="processInsert(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>processInsert</h4>
<pre>protected&nbsp;void&nbsp;processInsert(<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>&nbsp;entities)
throws <a href="../../../../org/apache/cayenne/CayenneException.html" title="class in org.apache.cayenne">CayenneException</a></pre>
<div class="block">Reads source data from source, saving it to destination.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/cayenne/CayenneException.html" title="class in org.apache.cayenne">CayenneException</a></code></dd></dl>
</li>
</ul>
<a name="getEntities()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEntities</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&nbsp;getEntities()</pre>
</li>
</ul>
<a name="getSourceNode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSourceNode</h4>
<pre>public&nbsp;<a href="../../../../org/apache/cayenne/access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</a>&nbsp;getSourceNode()</pre>
</li>
</ul>
<a name="getDestinationNode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDestinationNode</h4>
<pre>public&nbsp;<a href="../../../../org/apache/cayenne/access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</a>&nbsp;getDestinationNode()</pre>
</li>
</ul>
<a name="setEntities(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEntities</h4>
<pre>public&nbsp;void&nbsp;setEntities(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&nbsp;entities)</pre>
<div class="block">Sets the initial list of entities to process. This list can be later modified by
the delegate.</div>
</li>
</ul>
<a name="setSourceNode(org.apache.cayenne.access.DataNode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSourceNode</h4>
<pre>public&nbsp;void&nbsp;setSourceNode(<a href="../../../../org/apache/cayenne/access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</a>&nbsp;sourceNode)</pre>
<div class="block">Sets the DataNode serving as a source of the ported data.</div>
</li>
</ul>
<a name="setDestinationNode(org.apache.cayenne.access.DataNode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDestinationNode</h4>
<pre>public&nbsp;void&nbsp;setDestinationNode(<a href="../../../../org/apache/cayenne/access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</a>&nbsp;destinationNode)</pre>
<div class="block">Sets the DataNode serving as a destination of the ported data.</div>
</li>
</ul>
<a name="getDelegate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDelegate</h4>
<pre>public&nbsp;<a href="../../../../org/apache/cayenne/access/DataPortDelegate.html" title="interface in org.apache.cayenne.access">DataPortDelegate</a>&nbsp;getDelegate()</pre>
<div class="block">Returns previously initialized DataPortDelegate object.</div>
</li>
</ul>
<a name="setDelegate(org.apache.cayenne.access.DataPortDelegate)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDelegate</h4>
<pre>public&nbsp;void&nbsp;setDelegate(<a href="../../../../org/apache/cayenne/access/DataPortDelegate.html" title="interface in org.apache.cayenne.access">DataPortDelegate</a>&nbsp;delegate)</pre>
</li>
</ul>
<a name="isCleaningDestination()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCleaningDestination</h4>
<pre>public&nbsp;boolean&nbsp;isCleaningDestination()</pre>
<div class="block">Returns true if a DataPort was configured to delete all data from the destination
tables.</div>
</li>
</ul>
<a name="setCleaningDestination(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCleaningDestination</h4>
<pre>public&nbsp;void&nbsp;setCleaningDestination(boolean&nbsp;cleaningDestination)</pre>
<div class="block">Defines whether DataPort should delete all data from destination tables before
doing the port.</div>
</li>
</ul>
<a name="getInsertBatchSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInsertBatchSize</h4>
<pre>public&nbsp;int&nbsp;getInsertBatchSize()</pre>
</li>
</ul>
<a name="setInsertBatchSize(int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setInsertBatchSize</h4>
<pre>public&nbsp;void&nbsp;setInsertBatchSize(int&nbsp;insertBatchSize)</pre>
<div class="block">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.</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/DataPort.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/DataNode.html" title="class in org.apache.cayenne.access"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cayenne/access/DataPortDelegate.html" title="interface 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/DataPort.html" target="_top">Frames</a></li>
<li><a href="DataPort.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2001&#x2013;2014 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p>
</body>
</html>