blob: 72c421f6be009bba89125e66130d808451c0eaca [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:57 FET 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>DefaultDataChannelDescriptorMerger (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="DefaultDataChannelDescriptorMerger (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/DefaultDataChannelDescriptorMerger.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/configuration/DefaultConfigurationNameMapper.html" title="class in org.apache.cayenne.configuration"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cayenne/configuration/DefaultObjectStoreFactory.html" title="class in org.apache.cayenne.configuration"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cayenne/configuration/DefaultDataChannelDescriptorMerger.html" target="_top">Frames</a></li>
<li><a href="DefaultDataChannelDescriptorMerger.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>Field&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>Field&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.configuration</div>
<h2 title="Class DefaultDataChannelDescriptorMerger" class="title">Class DefaultDataChannelDescriptorMerger</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.configuration.DefaultDataChannelDescriptorMerger</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../org/apache/cayenne/configuration/DataChannelDescriptorMerger.html" title="interface in org.apache.cayenne.configuration">DataChannelDescriptorMerger</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">DefaultDataChannelDescriptorMerger</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>
implements <a href="../../../../org/apache/cayenne/configuration/DataChannelDescriptorMerger.html" title="interface in org.apache.cayenne.configuration">DataChannelDescriptorMerger</a></pre>
<div class="block">A default implementation of <a href="../../../../org/apache/cayenne/configuration/DataChannelDescriptorMerger.html" title="interface in org.apache.cayenne.configuration"><code>DataChannelDescriptorMerger</code></a>. The general rule of
merge is that the order of descriptors on the merge list matters. If there are two
conflicting metadata objects belonging to two descriptors, an object from the last
descriptor takes precedence over the object from the first one. This way it is easy to
override pieces of metadata. This is also similar to how DI modules are merged in
Cayenne. So this is how the merge works:
<ul>
<li>Merged descriptor name is the same as the name of the last descriptor on the merge
list.</li>
<li>Merged descriptor properties are the same as the properties of the last descriptor
on the merge list. I.e. properties are not merged to avoid invalid combinations and
unexpected runtime behavior.</li>
<li>If there are two or more DataMaps with the same name, only one DataMap is placed in
the merged descriptor, the rest are discarded. DataMap with highest index in the
descriptor array is chosen per precedence rule above.</li>
<li>If there are two or more DataNodes with the same name, only one DataNodes is placed
in the merged descriptor, the rest are discarded. DataNodes with highest index in the
descriptor array is chosen per precedence rule above.</li>
</ul></div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>3.1</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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/configuration/DefaultDataChannelDescriptorMerger.html#DefaultDataChannelDescriptorMerger()">DefaultDataChannelDescriptorMerger</a></strong>()</code>&nbsp;</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>protected <a href="../../../../org/apache/cayenne/configuration/DataNodeDescriptor.html" title="class in org.apache.cayenne.configuration">DataNodeDescriptor</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/configuration/DefaultDataChannelDescriptorMerger.html#cloneDataNodeDescriptor(org.apache.cayenne.configuration.DataNodeDescriptor,%20org.apache.cayenne.configuration.DataChannelDescriptor)">cloneDataNodeDescriptor</a></strong>(<a href="../../../../org/apache/cayenne/configuration/DataNodeDescriptor.html" title="class in org.apache.cayenne.configuration">DataNodeDescriptor</a>&nbsp;original,
<a href="../../../../org/apache/cayenne/configuration/DataChannelDescriptor.html" title="class in org.apache.cayenne.configuration">DataChannelDescriptor</a>&nbsp;targetOwner)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/cayenne/configuration/DataChannelDescriptor.html" title="class in org.apache.cayenne.configuration">DataChannelDescriptor</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/configuration/DefaultDataChannelDescriptorMerger.html#merge(org.apache.cayenne.configuration.DataChannelDescriptor...)">merge</a></strong>(<a href="../../../../org/apache/cayenne/configuration/DataChannelDescriptor.html" title="class in org.apache.cayenne.configuration">DataChannelDescriptor</a>...&nbsp;descriptors)</code>&nbsp;</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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DefaultDataChannelDescriptorMerger()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DefaultDataChannelDescriptorMerger</h4>
<pre>public&nbsp;DefaultDataChannelDescriptorMerger()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="merge(org.apache.cayenne.configuration.DataChannelDescriptor...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>merge</h4>
<pre>public&nbsp;<a href="../../../../org/apache/cayenne/configuration/DataChannelDescriptor.html" title="class in org.apache.cayenne.configuration">DataChannelDescriptor</a>&nbsp;merge(<a href="../../../../org/apache/cayenne/configuration/DataChannelDescriptor.html" title="class in org.apache.cayenne.configuration">DataChannelDescriptor</a>...&nbsp;descriptors)</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/cayenne/configuration/DataChannelDescriptorMerger.html#merge(org.apache.cayenne.configuration.DataChannelDescriptor...)">merge</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/cayenne/configuration/DataChannelDescriptorMerger.html" title="interface in org.apache.cayenne.configuration">DataChannelDescriptorMerger</a></code></dd>
</dl>
</li>
</ul>
<a name="cloneDataNodeDescriptor(org.apache.cayenne.configuration.DataNodeDescriptor, org.apache.cayenne.configuration.DataChannelDescriptor)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>cloneDataNodeDescriptor</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/cayenne/configuration/DataNodeDescriptor.html" title="class in org.apache.cayenne.configuration">DataNodeDescriptor</a>&nbsp;cloneDataNodeDescriptor(<a href="../../../../org/apache/cayenne/configuration/DataNodeDescriptor.html" title="class in org.apache.cayenne.configuration">DataNodeDescriptor</a>&nbsp;original,
<a href="../../../../org/apache/cayenne/configuration/DataChannelDescriptor.html" title="class in org.apache.cayenne.configuration">DataChannelDescriptor</a>&nbsp;targetOwner)</pre>
</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/DefaultDataChannelDescriptorMerger.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/configuration/DefaultConfigurationNameMapper.html" title="class in org.apache.cayenne.configuration"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cayenne/configuration/DefaultObjectStoreFactory.html" title="class in org.apache.cayenne.configuration"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cayenne/configuration/DefaultDataChannelDescriptorMerger.html" target="_top">Frames</a></li>
<li><a href="DefaultDataChannelDescriptorMerger.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>Field&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>Field&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>