blob: 427f355de2e7cb75db76cb86ca37e7ebc936403b [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>DbRelationship (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="DbRelationship (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/DbRelationship.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/map/DbKeyGenerator.html" title="class in org.apache.cayenne.map"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cayenne/map/DbRelationshipDetected.html" title="class in org.apache.cayenne.map"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cayenne/map/DbRelationship.html" target="_top">Frames</a></li>
<li><a href="DbRelationship.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.map</div>
<h2 title="Class DbRelationship" class="title">Class DbRelationship</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><a href="../../../../org/apache/cayenne/map/Relationship.html" title="class in org.apache.cayenne.map">org.apache.cayenne.map.Relationship</a></li>
<li>
<ul class="inheritance">
<li>org.apache.cayenne.map.DbRelationship</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../../org/apache/cayenne/configuration/ConfigurationNode.html" title="interface in org.apache.cayenne.configuration">ConfigurationNode</a>, <a href="../../../../org/apache/cayenne/util/CayenneMapEntry.html" title="interface in org.apache.cayenne.util">CayenneMapEntry</a>, <a href="../../../../org/apache/cayenne/util/XMLSerializable.html" title="interface in org.apache.cayenne.util">XMLSerializable</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/apache/cayenne/map/DbRelationshipDetected.html" title="class in org.apache.cayenne.map">DbRelationshipDetected</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">DbRelationship</span>
extends <a href="../../../../org/apache/cayenne/map/Relationship.html" title="class in org.apache.cayenne.map">Relationship</a>
implements <a href="../../../../org/apache/cayenne/configuration/ConfigurationNode.html" title="interface in org.apache.cayenne.configuration">ConfigurationNode</a></pre>
<div class="block">A DbRelationship is a descriptor of a database inter-table relationship based on one or
more primary key/foreign key pairs.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#org.apache.cayenne.map.DbRelationship">Serialized Form</a></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 <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>&lt;<a href="../../../../org/apache/cayenne/map/DbJoin.html" title="class in org.apache.cayenne.map">DbJoin</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/DbRelationship.html#joins">joins</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/DbRelationship.html#toDependentPK">toDependentPK</a></strong></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.cayenne.map.Relationship">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.cayenne.map.<a href="../../../../org/apache/cayenne/map/Relationship.html" title="class in org.apache.cayenne.map">Relationship</a></h3>
<code><a href="../../../../org/apache/cayenne/map/Relationship.html#name">name</a>, <a href="../../../../org/apache/cayenne/map/Relationship.html#runtime">runtime</a>, <a href="../../../../org/apache/cayenne/map/Relationship.html#sourceEntity">sourceEntity</a>, <a href="../../../../org/apache/cayenne/map/Relationship.html#targetEntityName">targetEntityName</a>, <a href="../../../../org/apache/cayenne/map/Relationship.html#toMany">toMany</a></code></li>
</ul>
</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/map/DbRelationship.html#DbRelationship()">DbRelationship</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/cayenne/map/DbRelationship.html#DbRelationship(java.lang.String)">DbRelationship</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</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>&lt;T&gt;&nbsp;T</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/DbRelationship.html#acceptVisitor(org.apache.cayenne.configuration.ConfigurationNodeVisitor)">acceptVisitor</a></strong>(<a href="../../../../org/apache/cayenne/configuration/ConfigurationNodeVisitor.html" title="interface in org.apache.cayenne.configuration">ConfigurationNodeVisitor</a>&lt;T&gt;&nbsp;visitor)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/DbRelationship.html#addJoin(org.apache.cayenne.map.DbJoin)">addJoin</a></strong>(<a href="../../../../org/apache/cayenne/map/DbJoin.html" title="class in org.apache.cayenne.map">DbJoin</a>&nbsp;join)</code>
<div class="block">Adds a join.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/cayenne/map/DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/DbRelationship.html#createReverseRelationship()">createReverseRelationship</a></strong>()</code>
<div class="block">Creates a new relationship with the same set of joins, but going in the opposite
direction.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/DbRelationship.html#encodeAsXML(org.apache.cayenne.util.XMLEncoder)">encodeAsXML</a></strong>(<a href="../../../../org/apache/cayenne/util/XMLEncoder.html" title="class in org.apache.cayenne.util">XMLEncoder</a>&nbsp;encoder)</code>
<div class="block">Prints itself as XML to the provided XMLEncoder.</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>&lt;<a href="../../../../org/apache/cayenne/map/DbJoin.html" title="class in org.apache.cayenne.map">DbJoin</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/DbRelationship.html#getJoins()">getJoins</a></strong>()</code>
<div class="block">Returns a list of joins.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/cayenne/map/DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/DbRelationship.html#getReverseRelationship()">getReverseRelationship</a></strong>()</code>
<div class="block">Returns DbRelationship that is the opposite of this DbRelationship.</div>
</td>
</tr>
<tr class="altColor">
<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>&lt;<a href="../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/DbRelationship.html#getSourceAttributes()">getSourceAttributes</a></strong>()</code>
<div class="block">Returns a Collection of source attributes.</div>
</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>&lt;<a href="../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/DbRelationship.html#getTargetAttributes()">getTargetAttributes</a></strong>()</code>
<div class="block">Returns a Collection of target attributes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/cayenne/map/Entity.html" title="class in org.apache.cayenne.map">Entity</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/DbRelationship.html#getTargetEntity()">getTargetEntity</a></strong>()</code>
<div class="block">Returns a target of this relationship.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/DbRelationship.html#isFromPK()">isFromPK</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/map/DbRelationship.html#isMandatory()">isMandatory</a></strong>()</code>
<div class="block">Returns if relationship is mandatory</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/DbRelationship.html#isToDependentPK()">isToDependentPK</a></strong>()</code>
<div class="block">Returns <code>true</code> if relationship from source to target points to dependent
primary key.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/DbRelationship.html#isToMasterPK()">isToMasterPK</a></strong>()</code>
<div class="block">Returns <code>true</code> if a method <code>isToDependentPK</code> of reverse
relationship of this relationship returns <code>true</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/DbRelationship.html#isToPK()">isToPK</a></strong>()</code>
<div class="block">Returns true if the relationship points to at least one of the PK columns of the
target entity.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/DbRelationship.html#isValidForDepPk()">isValidForDepPk</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/DbRelationship.html#removeAllJoins()">removeAllJoins</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/DbRelationship.html#removeJoin(org.apache.cayenne.map.DbJoin)">removeJoin</a></strong>(<a href="../../../../org/apache/cayenne/map/DbJoin.html" title="class in org.apache.cayenne.map">DbJoin</a>&nbsp;join)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/DbRelationship.html#setJoins(java.util.Collection)">setJoins</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>&lt;<a href="../../../../org/apache/cayenne/map/DbJoin.html" title="class in org.apache.cayenne.map">DbJoin</a>&gt;&nbsp;newJoins)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/DbRelationship.html#setToDependentPK(boolean)">setToDependentPK</a></strong>(boolean&nbsp;toDependentPK)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/DbRelationship.html#setToMany(boolean)">setToMany</a></strong>(boolean&nbsp;toMany)</code>
<div class="block">Sets relationship multiplicity.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<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>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/DbRelationship.html#srcFkSnapshotWithTargetSnapshot(java.util.Map)">srcFkSnapshotWithTargetSnapshot</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<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>&gt;&nbsp;targetSnapshot)</code>
<div class="block">Creates a snapshot of foreign key attributes of a source object of this
relationship based on a snapshot of a target.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<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>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/DbRelationship.html#srcPkSnapshotWithTargetSnapshot(java.util.Map)">srcPkSnapshotWithTargetSnapshot</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<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>&gt;&nbsp;targetSnapshot)</code>
<div class="block">Creates a snapshot of primary key attributes of a source object of this
relationship based on a snapshot of a target.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<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>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/DbRelationship.html#targetPkSnapshotWithSrcSnapshot(java.util.Map)">targetPkSnapshotWithSrcSnapshot</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<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>&gt;&nbsp;srcSnapshot)</code>
<div class="block">Creates a snapshot of primary key attributes of a target object of this
relationship based on a snapshot of a source.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.cayenne.map.Relationship">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.cayenne.map.<a href="../../../../org/apache/cayenne/map/Relationship.html" title="class in org.apache.cayenne.map">Relationship</a></h3>
<code><a href="../../../../org/apache/cayenne/map/Relationship.html#getName()">getName</a>, <a href="../../../../org/apache/cayenne/map/Relationship.html#getParent()">getParent</a>, <a href="../../../../org/apache/cayenne/map/Relationship.html#getSourceEntity()">getSourceEntity</a>, <a href="../../../../org/apache/cayenne/map/Relationship.html#getTargetEntityName()">getTargetEntityName</a>, <a href="../../../../org/apache/cayenne/map/Relationship.html#isRuntime()">isRuntime</a>, <a href="../../../../org/apache/cayenne/map/Relationship.html#isToMany()">isToMany</a>, <a href="../../../../org/apache/cayenne/map/Relationship.html#setName(java.lang.String)">setName</a>, <a href="../../../../org/apache/cayenne/map/Relationship.html#setParent(java.lang.Object)">setParent</a>, <a href="../../../../org/apache/cayenne/map/Relationship.html#setRuntime(boolean)">setRuntime</a>, <a href="../../../../org/apache/cayenne/map/Relationship.html#setSourceEntity(org.apache.cayenne.map.Entity)">setSourceEntity</a>, <a href="../../../../org/apache/cayenne/map/Relationship.html#setTargetEntity(org.apache.cayenne.map.Entity)">setTargetEntity</a>, <a href="../../../../org/apache/cayenne/map/Relationship.html#setTargetEntityName(java.lang.String)">setTargetEntityName</a>, <a href="../../../../org/apache/cayenne/map/Relationship.html#toString()">toString</a></code></li>
</ul>
<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#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="joins">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>joins</h4>
<pre>protected&nbsp;<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>&lt;<a href="../../../../org/apache/cayenne/map/DbJoin.html" title="class in org.apache.cayenne.map">DbJoin</a>&gt; joins</pre>
</li>
</ul>
<a name="toDependentPK">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toDependentPK</h4>
<pre>protected&nbsp;boolean toDependentPK</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DbRelationship()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DbRelationship</h4>
<pre>public&nbsp;DbRelationship()</pre>
</li>
</ul>
<a name="DbRelationship(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DbRelationship</h4>
<pre>public&nbsp;DbRelationship(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="acceptVisitor(org.apache.cayenne.configuration.ConfigurationNodeVisitor)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>acceptVisitor</h4>
<pre>public&nbsp;&lt;T&gt;&nbsp;T&nbsp;acceptVisitor(<a href="../../../../org/apache/cayenne/configuration/ConfigurationNodeVisitor.html" title="interface in org.apache.cayenne.configuration">ConfigurationNodeVisitor</a>&lt;T&gt;&nbsp;visitor)</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/cayenne/configuration/ConfigurationNode.html#acceptVisitor(org.apache.cayenne.configuration.ConfigurationNodeVisitor)">acceptVisitor</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/cayenne/configuration/ConfigurationNode.html" title="interface in org.apache.cayenne.configuration">ConfigurationNode</a></code></dd>
<dt><span class="strong">Since:</span></dt>
<dd>3.1</dd></dl>
</li>
</ul>
<a name="encodeAsXML(org.apache.cayenne.util.XMLEncoder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeAsXML</h4>
<pre>public&nbsp;void&nbsp;encodeAsXML(<a href="../../../../org/apache/cayenne/util/XMLEncoder.html" title="class in org.apache.cayenne.util">XMLEncoder</a>&nbsp;encoder)</pre>
<div class="block">Prints itself as XML to the provided XMLEncoder.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/cayenne/util/XMLSerializable.html#encodeAsXML(org.apache.cayenne.util.XMLEncoder)">encodeAsXML</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/cayenne/util/XMLSerializable.html" title="interface in org.apache.cayenne.util">XMLSerializable</a></code></dd>
<dt><span class="strong">Since:</span></dt>
<dd>1.1</dd></dl>
</li>
</ul>
<a name="getTargetEntity()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTargetEntity</h4>
<pre>public&nbsp;<a href="../../../../org/apache/cayenne/map/Entity.html" title="class in org.apache.cayenne.map">Entity</a>&nbsp;getTargetEntity()</pre>
<div class="block">Returns a target of this relationship. If relationship is not attached to a
DbEntity, and DbEntity doesn't have a namespace, and exception is thrown.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/cayenne/map/Relationship.html#getTargetEntity()">getTargetEntity</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/cayenne/map/Relationship.html" title="class in org.apache.cayenne.map">Relationship</a></code></dd>
</dl>
</li>
</ul>
<a name="getTargetAttributes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTargetAttributes</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>&lt;<a href="../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a>&gt;&nbsp;getTargetAttributes()</pre>
<div class="block">Returns a Collection of target attributes.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.1</dd></dl>
</li>
</ul>
<a name="getSourceAttributes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSourceAttributes</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>&lt;<a href="../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a>&gt;&nbsp;getSourceAttributes()</pre>
<div class="block">Returns a Collection of source attributes.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.1</dd></dl>
</li>
</ul>
<a name="createReverseRelationship()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createReverseRelationship</h4>
<pre>public&nbsp;<a href="../../../../org/apache/cayenne/map/DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</a>&nbsp;createReverseRelationship()</pre>
<div class="block">Creates a new relationship with the same set of joins, but going in the opposite
direction.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.0.5</dd></dl>
</li>
</ul>
<a name="getReverseRelationship()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReverseRelationship</h4>
<pre>public&nbsp;<a href="../../../../org/apache/cayenne/map/DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</a>&nbsp;getReverseRelationship()</pre>
<div class="block">Returns DbRelationship that is the opposite of this DbRelationship. This means a
relationship from this target entity to this source entity with the same join
semantics. Returns null if no such relationship exists.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/cayenne/map/Relationship.html#getReverseRelationship()">getReverseRelationship</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/cayenne/map/Relationship.html" title="class in org.apache.cayenne.map">Relationship</a></code></dd>
</dl>
</li>
</ul>
<a name="isToPK()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isToPK</h4>
<pre>public&nbsp;boolean&nbsp;isToPK()</pre>
<div class="block">Returns true if the relationship points to at least one of the PK columns of the
target entity.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.1</dd></dl>
</li>
</ul>
<a name="isFromPK()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFromPK</h4>
<pre>public&nbsp;boolean&nbsp;isFromPK()</pre>
<dl><dt><span class="strong">Since:</span></dt>
<dd>3.0</dd></dl>
</li>
</ul>
<a name="isToMasterPK()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isToMasterPK</h4>
<pre>public&nbsp;boolean&nbsp;isToMasterPK()</pre>
<div class="block">Returns <code>true</code> if a method <code>isToDependentPK</code> of reverse
relationship of this relationship returns <code>true</code>.</div>
</li>
</ul>
<a name="isToDependentPK()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isToDependentPK</h4>
<pre>public&nbsp;boolean&nbsp;isToDependentPK()</pre>
<div class="block">Returns <code>true</code> if relationship from source to target points to dependent
primary key. Dependent PK is a primary key column of the destination table that is
also a FK to the source column.</div>
</li>
</ul>
<a name="setToDependentPK(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setToDependentPK</h4>
<pre>public&nbsp;void&nbsp;setToDependentPK(boolean&nbsp;toDependentPK)</pre>
</li>
</ul>
<a name="isValidForDepPk()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValidForDepPk</h4>
<pre>public&nbsp;boolean&nbsp;isValidForDepPk()</pre>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.1</dd></dl>
</li>
</ul>
<a name="getJoins()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJoins</h4>
<pre>public&nbsp;<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>&lt;<a href="../../../../org/apache/cayenne/map/DbJoin.html" title="class in org.apache.cayenne.map">DbJoin</a>&gt;&nbsp;getJoins()</pre>
<div class="block">Returns a list of joins. List is returned by reference, so any modifications of the
list will affect this relationship.</div>
</li>
</ul>
<a name="addJoin(org.apache.cayenne.map.DbJoin)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addJoin</h4>
<pre>public&nbsp;void&nbsp;addJoin(<a href="../../../../org/apache/cayenne/map/DbJoin.html" title="class in org.apache.cayenne.map">DbJoin</a>&nbsp;join)</pre>
<div class="block">Adds a join.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.1</dd></dl>
</li>
</ul>
<a name="removeJoin(org.apache.cayenne.map.DbJoin)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeJoin</h4>
<pre>public&nbsp;void&nbsp;removeJoin(<a href="../../../../org/apache/cayenne/map/DbJoin.html" title="class in org.apache.cayenne.map">DbJoin</a>&nbsp;join)</pre>
</li>
</ul>
<a name="removeAllJoins()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeAllJoins</h4>
<pre>public&nbsp;void&nbsp;removeAllJoins()</pre>
</li>
</ul>
<a name="setJoins(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setJoins</h4>
<pre>public&nbsp;void&nbsp;setJoins(<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>&lt;<a href="../../../../org/apache/cayenne/map/DbJoin.html" title="class in org.apache.cayenne.map">DbJoin</a>&gt;&nbsp;newJoins)</pre>
</li>
</ul>
<a name="targetPkSnapshotWithSrcSnapshot(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>targetPkSnapshotWithSrcSnapshot</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<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>&gt;&nbsp;targetPkSnapshotWithSrcSnapshot(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<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>&gt;&nbsp;srcSnapshot)</pre>
<div class="block">Creates a snapshot of primary key attributes of a target object of this
relationship based on a snapshot of a source. Only "to-one" relationships are
supported. Returns null if relationship does not point to an object. Throws
CayenneRuntimeException if relationship is "to many" or if snapshot is missing id
components.</div>
</li>
</ul>
<a name="srcFkSnapshotWithTargetSnapshot(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>srcFkSnapshotWithTargetSnapshot</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<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>&gt;&nbsp;srcFkSnapshotWithTargetSnapshot(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<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>&gt;&nbsp;targetSnapshot)</pre>
<div class="block">Creates a snapshot of foreign key attributes of a source object of this
relationship based on a snapshot of a target. Only "to-one" relationships are
supported. Throws CayenneRuntimeException if relationship is "to many".</div>
</li>
</ul>
<a name="srcPkSnapshotWithTargetSnapshot(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>srcPkSnapshotWithTargetSnapshot</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<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>&gt;&nbsp;srcPkSnapshotWithTargetSnapshot(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<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>&gt;&nbsp;targetSnapshot)</pre>
<div class="block">Creates a snapshot of primary key attributes of a source object of this
relationship based on a snapshot of a target. Only "to-many" relationships are
supported. Throws CayenneRuntimeException if relationship is "to one".</div>
</li>
</ul>
<a name="setToMany(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setToMany</h4>
<pre>public&nbsp;void&nbsp;setToMany(boolean&nbsp;toMany)</pre>
<div class="block">Sets relationship multiplicity.</div>
</li>
</ul>
<a name="isMandatory()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isMandatory</h4>
<pre>public&nbsp;boolean&nbsp;isMandatory()</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../org/apache/cayenne/map/Relationship.html#isMandatory()">Relationship</a></code></strong></div>
<div class="block">Returns if relationship is mandatory</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/cayenne/map/Relationship.html#isMandatory()">isMandatory</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/cayenne/map/Relationship.html" title="class in org.apache.cayenne.map">Relationship</a></code></dd>
</dl>
</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/DbRelationship.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/map/DbKeyGenerator.html" title="class in org.apache.cayenne.map"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cayenne/map/DbRelationshipDetected.html" title="class in org.apache.cayenne.map"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cayenne/map/DbRelationship.html" target="_top">Frames</a></li>
<li><a href="DbRelationship.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>