Google Git
Sign in
apache / cayenne-website / 626d8c1d90628349118d991467d8b423be9e228e / . / src / main / site / static / docs / 4.2 / api / org / apache / cayenne / map / DbRelationship.html
blob: 1a2b38678b5ceb4485ac88ee33d69072deb98488 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.10) on Mon Dec 05 10:27:04 MSK 2022 -->
<title>DbRelationship (cayenne-doc: Cayenne Documentation 4.2.RC2 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-12-05">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DbRelationship (cayenne-doc: Cayenne Documentation 4.2.RC2 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = false;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.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 class="aboutLanguage"><a href="http://cayenne.apache.org" target="top">Apache Cayenne</a></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.cayenne.map</a></div>
<h2 title="Class DbRelationship" class="title">Class DbRelationship</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="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><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code>, <code><a href="../configuration/ConfigurationNode.html" title="interface in org.apache.cayenne.configuration">ConfigurationNode</a></code>, <code><a href="../util/CayenneMapEntry.html" title="interface in org.apache.cayenne.util">CayenneMapEntry</a></code>, <code><a href="../util/XMLSerializable.html" title="interface in org.apache.cayenne.util">XMLSerializable</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">DbRelationship</span>
extends <a href="Relationship.html" title="class in org.apache.cayenne.map">Relationship</a>
implements <a href="../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="seeLabel">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 =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="DbJoin.html" title="class in org.apache.cayenne.map">DbJoin</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#joins">joins</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toDependentPK">toDependentPK</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.apache.cayenne.map.Relationship">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.cayenne.map.<a href="Relationship.html" title="class in org.apache.cayenne.map">Relationship</a></h3>
<code><a href="Relationship.html#name">name</a>, <a href="Relationship.html#runtime">runtime</a>, <a href="Relationship.html#sourceEntity">sourceEntity</a>, <a href="Relationship.html#targetEntityName">targetEntityName</a>, <a href="Relationship.html#toMany">toMany</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">DbRelationship</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String)">DbRelationship</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;T</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#acceptVisitor(org.apache.cayenne.configuration.ConfigurationNodeVisitor)">acceptVisitor</a></span>&#8203;(<a href="../configuration/ConfigurationNodeVisitor.html" title="interface in org.apache.cayenne.configuration">ConfigurationNodeVisitor</a>&lt;T&gt;&nbsp;visitor)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addJoin(org.apache.cayenne.map.DbJoin)">addJoin</a></span>&#8203;(<a href="DbJoin.html" title="class in org.apache.cayenne.map">DbJoin</a>&nbsp;join)</code></th>
<td class="colLast">
<div class="block">Adds a join.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createReverseRelationship()">createReverseRelationship</a></span>()</code></th>
<td class="colLast">
<div class="block">Creates a new relationship with the same set of joins, but going in the
opposite direction.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#encodeAsXML(org.apache.cayenne.util.XMLEncoder,org.apache.cayenne.configuration.ConfigurationNodeVisitor)">encodeAsXML</a></span>&#8203;(<a href="../util/XMLEncoder.html" title="class in org.apache.cayenne.util">XMLEncoder</a>&nbsp;encoder,
<a href="../configuration/ConfigurationNodeVisitor.html" title="interface in org.apache.cayenne.configuration">ConfigurationNodeVisitor</a>&nbsp;delegate)</code></th>
<td class="colLast">
<div class="block">Prints itself as XML to the provided XMLEncoder.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="DbJoin.html" title="class in org.apache.cayenne.map">DbJoin</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getJoins()">getJoins</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a list of joins.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReverseRelationship()">getReverseRelationship</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns DbRelationship that is the opposite of this DbRelationship.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<a href="DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSourceAttributes()">getSourceAttributes</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a Collection of source attributes.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSourceEntity()">getSourceEntity</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns relationship source entity.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSourceEntityName()">getSourceEntityName</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<a href="DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTargetAttributes()">getTargetAttributes</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a Collection of target attributes.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTargetEntity()">getTargetEntity</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a target of this relationship.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isFromPK()">isFromPK</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isMandatory()">isMandatory</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns if relationship is mandatory</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSourceIndependentFromTargetChange()">isSourceIndependentFromTargetChange</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a boolean indicating whether modifying a target of such
relationship in any way will not change the underlying table row of the
source.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isToDependentPK()">isToDependentPK</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns <code>true</code> if relationship from source to target points to
dependent primary key.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isToMasterPK()">isToMasterPK</a></span>()</code></th>
<td class="colLast">
<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 id="i16" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isToPK()">isToPK</a></span>()</code></th>
<td class="colLast">
<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 id="i17" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isValidForDepPk()">isValidForDepPk</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeAllJoins()">removeAllJoins</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeJoin(org.apache.cayenne.map.DbJoin)">removeJoin</a></span>&#8203;(<a href="DbJoin.html" title="class in org.apache.cayenne.map">DbJoin</a>&nbsp;join)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setJoins(java.util.Collection)">setJoins</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<a href="DbJoin.html" title="class in org.apache.cayenne.map">DbJoin</a>&gt;&nbsp;newJoins)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setToDependentPK(boolean)">setToDependentPK</a></span>&#8203;(boolean&nbsp;toDependentPK)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setToMany(boolean)">setToMany</a></span>&#8203;(boolean&nbsp;toMany)</code></th>
<td class="colLast">
<div class="block">Sets relationship multiplicity.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#srcFkSnapshotWithTargetSnapshot(java.util.Map)">srcFkSnapshotWithTargetSnapshot</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;&nbsp;targetSnapshot)</code></th>
<td class="colLast">
<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 id="i24" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#srcPkSnapshotWithTargetSnapshot(java.util.Map)">srcPkSnapshotWithTargetSnapshot</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;&nbsp;targetSnapshot)</code></th>
<td class="colLast">
<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 id="i25" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#targetPkSnapshotWithSrcSnapshot(java.util.Map)">targetPkSnapshotWithSrcSnapshot</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;&nbsp;srcSnapshot)</code></th>
<td class="colLast">
<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>
<tr id="i26" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">
<div class="block">Overrides Object.toString() to return informative description.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.cayenne.map.Relationship">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.cayenne.map.<a href="Relationship.html" title="class in org.apache.cayenne.map">Relationship</a></h3>
<code><a href="Relationship.html#getName()">getName</a>, <a href="Relationship.html#getParent()">getParent</a>, <a href="Relationship.html#getTargetEntityName()">getTargetEntityName</a>, <a href="Relationship.html#isRuntime()">isRuntime</a>, <a href="Relationship.html#isToMany()">isToMany</a>, <a href="Relationship.html#setName(java.lang.String)">setName</a>, <a href="Relationship.html#setParent(java.lang.Object)">setParent</a>, <a href="Relationship.html#setRuntime(boolean)">setRuntime</a>, <a href="Relationship.html#setSourceEntity(org.apache.cayenne.map.Entity)">setSourceEntity</a>, <a href="Relationship.html#setTargetEntityName(java.lang.String)">setTargetEntityName</a>, <a href="Relationship.html#setTargetEntityName(org.apache.cayenne.map.Entity)">setTargetEntityName</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="joins">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>joins</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="DbJoin.html" title="class in org.apache.cayenne.map">DbJoin</a>&gt; joins</pre>
</li>
</ul>
<a id="toDependentPK">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toDependentPK</h4>
<pre>protected&nbsp;boolean toDependentPK</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DbRelationship</h4>
<pre>public&nbsp;DbRelationship()</pre>
</li>
</ul>
<a id="&lt;init&gt;(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DbRelationship</h4>
<pre>public&nbsp;DbRelationship&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;name)</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getSourceEntity()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSourceEntity</h4>
<pre class="methodSignature">public&nbsp;<a href="DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>&nbsp;getSourceEntity()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="Relationship.html#getSourceEntity()">Relationship</a></code></span></div>
<div class="block">Returns relationship source entity.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="Relationship.html#getSourceEntity()">getSourceEntity</a></code>&nbsp;in class&nbsp;<code><a href="Relationship.html" title="class in org.apache.cayenne.map">Relationship</a></code></dd>
</dl>
</li>
</ul>
<a id="acceptVisitor(org.apache.cayenne.configuration.ConfigurationNodeVisitor)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>acceptVisitor</h4>
<pre class="methodSignature">public&nbsp;&lt;T&gt;&nbsp;T&nbsp;acceptVisitor&#8203;(<a href="../configuration/ConfigurationNodeVisitor.html" title="interface in org.apache.cayenne.configuration">ConfigurationNodeVisitor</a>&lt;T&gt;&nbsp;visitor)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../configuration/ConfigurationNode.html#acceptVisitor(org.apache.cayenne.configuration.ConfigurationNodeVisitor)">acceptVisitor</a></code>&nbsp;in interface&nbsp;<code><a href="../configuration/ConfigurationNode.html" title="interface in org.apache.cayenne.configuration">ConfigurationNode</a></code></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.1</dd>
</dl>
</li>
</ul>
<a id="encodeAsXML(org.apache.cayenne.util.XMLEncoder,org.apache.cayenne.configuration.ConfigurationNodeVisitor)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeAsXML</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;encodeAsXML&#8203;(<a href="../util/XMLEncoder.html" title="class in org.apache.cayenne.util">XMLEncoder</a>&nbsp;encoder,
<a href="../configuration/ConfigurationNodeVisitor.html" title="interface in org.apache.cayenne.configuration">ConfigurationNodeVisitor</a>&nbsp;delegate)</pre>
<div class="block">Prints itself as XML to the provided XMLEncoder.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../util/XMLSerializable.html#encodeAsXML(org.apache.cayenne.util.XMLEncoder,org.apache.cayenne.configuration.ConfigurationNodeVisitor)">encodeAsXML</a></code>&nbsp;in interface&nbsp;<code><a href="../util/XMLSerializable.html" title="interface in org.apache.cayenne.util">XMLSerializable</a></code></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a id="getTargetEntity()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTargetEntity</h4>
<pre class="methodSignature">public&nbsp;<a href="DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</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><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Relationship.html#getTargetEntity()">getTargetEntity</a></code>&nbsp;in class&nbsp;<code><a href="Relationship.html" title="class in org.apache.cayenne.map">Relationship</a></code></dd>
</dl>
</li>
</ul>
<a id="getTargetAttributes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTargetAttributes</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<a href="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="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a id="getSourceAttributes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSourceAttributes</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<a href="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="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a id="createReverseRelationship()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createReverseRelationship</h4>
<pre class="methodSignature">public&nbsp;<a href="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="simpleTagLabel">Since:</span></dt>
<dd>1.0.5</dd>
</dl>
</li>
</ul>
<a id="getReverseRelationship()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReverseRelationship</h4>
<pre class="methodSignature">public&nbsp;<a href="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><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Relationship.html#getReverseRelationship()">getReverseRelationship</a></code>&nbsp;in class&nbsp;<code><a href="Relationship.html" title="class in org.apache.cayenne.map">Relationship</a></code></dd>
</dl>
</li>
</ul>
<a id="isToPK()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isToPK</h4>
<pre class="methodSignature">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="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a id="isFromPK()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFromPK</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isFromPK()</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a id="isToMasterPK()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isToMasterPK</h4>
<pre class="methodSignature">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 id="isSourceIndependentFromTargetChange()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSourceIndependentFromTargetChange</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isSourceIndependentFromTargetChange()</pre>
<div class="block">Returns a boolean indicating whether modifying a target of such
relationship in any way will not change the underlying table row of the
source.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.0</dd>
</dl>
</li>
</ul>
<a id="isToDependentPK()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isToDependentPK</h4>
<pre class="methodSignature">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 id="setToDependentPK(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setToDependentPK</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setToDependentPK&#8203;(boolean&nbsp;toDependentPK)</pre>
</li>
</ul>
<a id="isValidForDepPk()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValidForDepPk</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isValidForDepPk()</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a id="getJoins()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJoins</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="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 id="addJoin(org.apache.cayenne.map.DbJoin)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addJoin</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;addJoin&#8203;(<a href="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="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a id="removeJoin(org.apache.cayenne.map.DbJoin)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeJoin</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;removeJoin&#8203;(<a href="DbJoin.html" title="class in org.apache.cayenne.map">DbJoin</a>&nbsp;join)</pre>
</li>
</ul>
<a id="removeAllJoins()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeAllJoins</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;removeAllJoins()</pre>
</li>
</ul>
<a id="setJoins(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setJoins</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setJoins&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<a href="DbJoin.html" title="class in org.apache.cayenne.map">DbJoin</a>&gt;&nbsp;newJoins)</pre>
</li>
</ul>
<a id="targetPkSnapshotWithSrcSnapshot(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>targetPkSnapshotWithSrcSnapshot</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;&nbsp;targetPkSnapshotWithSrcSnapshot&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">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 id="srcFkSnapshotWithTargetSnapshot(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>srcFkSnapshotWithTargetSnapshot</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;&nbsp;srcFkSnapshotWithTargetSnapshot&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">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 id="srcPkSnapshotWithTargetSnapshot(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>srcPkSnapshotWithTargetSnapshot</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;&nbsp;srcPkSnapshotWithTargetSnapshot&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">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 id="setToMany(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setToMany</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setToMany&#8203;(boolean&nbsp;toMany)</pre>
<div class="block">Sets relationship multiplicity.</div>
</li>
</ul>
<a id="isMandatory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isMandatory</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isMandatory()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="Relationship.html#isMandatory()">Relationship</a></code></span></div>
<div class="block">Returns if relationship is mandatory</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Relationship.html#isMandatory()">isMandatory</a></code>&nbsp;in class&nbsp;<code><a href="Relationship.html" title="class in org.apache.cayenne.map">Relationship</a></code></dd>
</dl>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;toString()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="Relationship.html#toString()">Relationship</a></code></span></div>
<div class="block">Overrides Object.toString() to return informative description.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="Relationship.html#toString()">toString</a></code>&nbsp;in class&nbsp;<code><a href="Relationship.html" title="class in org.apache.cayenne.map">Relationship</a></code></dd>
</dl>
</li>
</ul>
<a id="getSourceEntityName()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getSourceEntityName</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;getSourceEntityName()</pre>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.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 class="aboutLanguage"><a href="http://cayenne.apache.org" target="top">Apache Cayenne</a></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2001&#x2013;2022 <a href="https://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p>
</footer>
</body>
</html>