Google Git
Sign in
eclipse / gerrit / www.eclipse.org / eclipselink / 7bae487f45ea47ce0120322304c66c82f6be5da6 / . / api / 3.0 / org / eclipse / persistence / sessions / CopyGroup.html
blob: 74264014716a9855a66ef4c278c2b5fbf44d6119 [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 (1.8.0_252) on Thu Apr 08 02:07:30 UTC 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CopyGroup (EclipseLink 3.0.1, API Reference)</title>
<meta name="date" content="2021-04-08">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CopyGroup (EclipseLink 3.0.1, API Reference)";
}
}
catch(err) {
}
//-->
var methods = {"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};
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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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="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">EclipseLink 3.0.1, API Reference</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/eclipse/persistence/sessions/Connector.html" title="interface in org.eclipse.persistence.sessions"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/eclipse/persistence/sessions/DatabaseLogin.html" title="class in org.eclipse.persistence.sessions"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/eclipse/persistence/sessions/CopyGroup.html" target="_top">Frames</a></li>
<li><a href="CopyGroup.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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.eclipse.persistence.sessions</div>
<h2 title="Class CopyGroup" class="title">Class CopyGroup</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">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html" title="class in org.eclipse.persistence.core.queries">org.eclipse.persistence.core.queries.CoreAttributeGroup</a>&lt;org.eclipse.persistence.internal.queries.AttributeItem,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>&gt;</li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html" title="class in org.eclipse.persistence.queries">org.eclipse.persistence.queries.AttributeGroup</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.persistence.sessions.CopyGroup</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">CopyGroup</span>
extends <a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html" title="class in org.eclipse.persistence.queries">AttributeGroup</a></pre>
<div class="block"><b>Purpose</b>: Define how an object is to be copied.<p>
<b>Description</b>: This is for usage with the object copying feature, not the unit of work.
This is useful for copying an entire object graph as part of the
host application's logic.<p>
<b>Responsibilities</b>:<ul>
<li> Indicate through CASCADE levels the depth relationships will copied.
<li> Indicate if PK attributes should be copied with existing value or should be reset.
<li> Copies only the attributes found in the group.
</ul></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/eclipse/persistence/sessions/Session.html#copy-java.lang.Object-org.eclipse.persistence.queries.AttributeGroup-"><code>Session.copy(Object, AttributeGroup)</code></a>,
<a href="../../../../serialized-form.html#org.eclipse.persistence.sessions.CopyGroup">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="memberSummary" 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>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#CASCADE_ALL_PARTS">CASCADE_ALL_PARTS</a></span></code>
<div class="block">Depth level indicating that all relationships with mappings should be used when
building the copied object graph</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#CASCADE_PRIVATE_PARTS">CASCADE_PRIVATE_PARTS</a></span></code>
<div class="block">Depth level indicating that only relationships with mapping indicated privately-
owned should be copied</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#CASCADE_TREE">CASCADE_TREE</a></span></code>
<div class="block">Depth level indicating that only the attributes found in the attribute group should be copied</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#copies">copies</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#depth">depth</a></span></code>
<div class="block">Policy depth that determines how the copy will cascade to the object's
related parts</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#NO_CASCADE">NO_CASCADE</a></span></code>
<div class="block">Depth level indicating that NO relationships should be included in the copy.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected org.eclipse.persistence.internal.sessions.AbstractSession</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#session">session</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#shouldResetPrimaryKey">shouldResetPrimaryKey</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#shouldResetVersion">shouldResetVersion</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.eclipse.persistence.core.queries.CoreAttributeGroup">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.persistence.core.queries.<a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html" title="class in org.eclipse.persistence.core.queries">CoreAttributeGroup</a></h3>
<code><a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#allsubclasses">allsubclasses</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#isValidated">isValidated</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#items">items</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#name">name</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#subClasses">subClasses</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#superClassGroup">superClassGroup</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#type">type</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#typeName">typeName</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="memberSummary" 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><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#CopyGroup--">CopyGroup</a></span>()</code>
<div class="block">PUBLIC:
By default only copy the attributes found in the attribute group and don't null primary keys.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#CopyGroup-java.lang.String-">CopyGroup</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">PUBLIC:
By default only copy the attributes found in the attribute group and don't null primary keys.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#addAttribute-java.lang.String-org.eclipse.persistence.sessions.CopyGroup-">addAttribute</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;attributeNameOrPath,
<a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html" title="class in org.eclipse.persistence.sessions">CopyGroup</a>&nbsp;group)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#addAttribute-java.lang.String-org.eclipse.persistence.core.queries.CoreAttributeGroup-">addAttribute</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;attributeNameOrPath,
<a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html" title="class in org.eclipse.persistence.core.queries">CoreAttributeGroup</a>&nbsp;group)</code>
<div class="block">Add a basic attribute or nested attribute with each String representing
an attribute on the path to what needs to be included in the
AttributeGroup.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#cascadeAllParts--">cascadeAllParts</a></span>()</code>
<div class="block">PUBLIC:
Set if the copy should cascade all relationships when copying the object(s).</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#cascadePrivateParts--">cascadePrivateParts</a></span>()</code>
<div class="block">PUBLIC:
Set if the copy should cascade only those relationships that are configured
as privately-owned.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#cascadeTree--">cascadeTree</a></span>()</code>
<div class="block">PUBLIC:
Set if the copy should cascade only those attributes that are found in the group.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html" title="class in org.eclipse.persistence.sessions">CopyGroup</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#clone--">clone</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#dontCascade--">dontCascade</a></span>()</code>
<div class="block">PUBLIC:
Set if the copy should not cascade relationships when copying the object(s)</div>
</td>
</tr>
<tr id="i7" 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">Map</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#getCopies--">getCopies</a></span>()</code>
<div class="block">INTERNAL: Get the session.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#getDepth--">getDepth</a></span>()</code>
<div class="block">INTERNAL: Return the cascade depth.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html" title="class in org.eclipse.persistence.sessions">CopyGroup</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#getGroup-java.lang.String-">getGroup</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;attributeNameOrPath)</code>
<div class="block">Returns CopyGroup corresponding to the passed (possibly nested) attribute.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>org.eclipse.persistence.internal.sessions.AbstractSession</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#getSession--">getSession</a></span>()</code>
<div class="block">INTERNAL: Return the session.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#isCopyGroup--">isCopyGroup</a></span>()</code>
<div class="block">INTERNAL:
This method is used internally when converting to a copy group.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>protected <a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html" title="class in org.eclipse.persistence.sessions">CopyGroup</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#newGroup-java.lang.String-org.eclipse.persistence.core.queries.CoreAttributeGroup-">newGroup</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html" title="class in org.eclipse.persistence.core.queries">CoreAttributeGroup</a>&nbsp;parent)</code>
<div class="block">Subclass may create different types.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#setCopies-java.util.Map-">setCopies</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;newCopies)</code>
<div class="block">INTERNAL: Set the copies.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#setDepth-int-">setDepth</a></span>(int&nbsp;newDepth)</code>
<div class="block">INTERNAL: Set the cascade depth.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#setSession-org.eclipse.persistence.internal.sessions.AbstractSession-">setSession</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;newSession)</code>
<div class="block">INTERNAL: Set the session.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#setShouldResetPrimaryKey-boolean-">setShouldResetPrimaryKey</a></span>(boolean&nbsp;newShouldResetPrimaryKey)</code>
<div class="block">PUBLIC:
Set if the primary key should be reset to null.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#setShouldResetVersion-boolean-">setShouldResetVersion</a></span>(boolean&nbsp;newShouldResetVersion)</code>
<div class="block">PUBLIC:
Set if the version should be reset to null.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#shouldCascade--">shouldCascade</a></span>()</code>
<div class="block">PUBLIC:
Return true if has been configured to CASCADE_ALL_PARTS or CASCADE_PRIVATE_PARTS.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#shouldCascadeAllParts--">shouldCascadeAllParts</a></span>()</code>
<div class="block">PUBLIC:
Return true if should CASCADE_ALL_PARTS</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#shouldCascadePrivateParts--">shouldCascadePrivateParts</a></span>()</code>
<div class="block">PUBLIC:
Return true if should CASCADE_PRIVATE_PARTS</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#shouldCascadeTree--">shouldCascadeTree</a></span>()</code>
<div class="block">PUBLIC:
Return true if should CASCADE_TREE</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#shouldResetPrimaryKey--">shouldResetPrimaryKey</a></span>()</code>
<div class="block">PUBLIC:
Return if the primary key should be reset to null.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#shouldResetVersion--">shouldResetVersion</a></span>()</code>
<div class="block">PUBLIC:
Return if the version should be reset to null.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html#toStringAdditionalInfo--">toStringAdditionalInfo</a></span>()</code>
<div class="block">INTERNAL:</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.persistence.queries.AttributeGroup">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.persistence.queries.<a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html" title="class in org.eclipse.persistence.queries">AttributeGroup</a></h3>
<code><a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html#addAttribute-java.lang.String-org.eclipse.persistence.queries.AttributeGroup-">addAttribute</a>, <a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html#findGroup-org.eclipse.persistence.descriptors.ClassDescriptor-">findGroup</a>, <a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html#getItem-java.lang.String-">getItem</a>, <a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html#isConcurrent--">isConcurrent</a>, <a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html#isLoadGroup--">isLoadGroup</a>, <a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html#isSupersetOf-org.eclipse.persistence.queries.AttributeGroup-">isSupersetOf</a>, <a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html#newItem-org.eclipse.persistence.queries.AttributeGroup-java.lang.String-">newItem</a>, <a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html#newItem-org.eclipse.persistence.core.queries.CoreAttributeGroup-java.lang.String-">newItem</a>, <a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html#toCopyGroup--">toCopyGroup</a>, <a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html#toCopyGroup-java.util.Map-java.util.Map-">toCopyGroup</a>, <a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html#toFetchGroup--">toFetchGroup</a>, <a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html#toFetchGroup-java.util.Map-">toFetchGroup</a>, <a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html#toLoadGroup--">toLoadGroup</a>, <a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html#toLoadGroup-java.util.Map-boolean-">toLoadGroup</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.eclipse.persistence.core.queries.CoreAttributeGroup">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.persistence.core.queries.<a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html" title="class in org.eclipse.persistence.core.queries">CoreAttributeGroup</a></h3>
<code><a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#addAttribute-java.lang.String-">addAttribute</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#addAttribute-java.lang.String-java.util.Collection-">addAttribute</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#addAttributeKey-java.lang.String-org.eclipse.persistence.core.queries.CoreAttributeGroup-">addAttributeKey</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#addAttributes-java.util.Collection-">addAttributes</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#clone-java.util.Map-">clone</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#containsAttribute-java.lang.String-">containsAttribute</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#containsAttributeInternal-java.lang.String-">containsAttributeInternal</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#convert-java.lang.String...-">convert</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#convertClassNamesToClasses-java.lang.ClassLoader-">convertClassNamesToClasses</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#equals-java.lang.Object-">equals</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#getAllItems--">getAllItems</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#getAttributeNames--">getAttributeNames</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#getItem-java.lang.String:A-boolean-">getItem</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#getItems--">getItems</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#getName--">getName</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#getSubClassGroups--">getSubClassGroups</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#getType--">getType</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#getTypeName--">getTypeName</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#hashCode--">hashCode</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#hasInheritance--">hasInheritance</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#hasItems--">hasItems</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#insertSubClass-org.eclipse.persistence.core.queries.CoreAttributeGroup-">insertSubClass</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#isFetchGroup--">isFetchGroup</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#isSupersetOf-org.eclipse.persistence.core.queries.CoreAttributeGroup-">isSupersetOf</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#isValidated--">isValidated</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#removeAttribute-java.lang.String-">removeAttribute</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#setAllSubclasses-java.util.Map-">setAllSubclasses</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#setAttributeNames-java.util.Set-">setAttributeNames</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#setName-java.lang.String-">setName</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#toString--">toString</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#toStringItems--">toStringItems</a>, <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#toStringPath-java.lang.String:A-int-">toStringPath</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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><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">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">getClass</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">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">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">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">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">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="shouldResetPrimaryKey">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldResetPrimaryKey</h4>
<pre>protected&nbsp;boolean shouldResetPrimaryKey</pre>
</li>
</ul>
<a name="shouldResetVersion">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldResetVersion</h4>
<pre>protected&nbsp;boolean shouldResetVersion</pre>
</li>
</ul>
<a name="session">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>session</h4>
<pre>protected transient&nbsp;org.eclipse.persistence.internal.sessions.AbstractSession session</pre>
</li>
</ul>
<a name="copies">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copies</h4>
<pre>protected&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">Map</a> copies</pre>
</li>
</ul>
<a name="depth">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>depth</h4>
<pre>protected&nbsp;int depth</pre>
<div class="block">Policy depth that determines how the copy will cascade to the object's
related parts</div>
</li>
</ul>
<a name="NO_CASCADE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NO_CASCADE</h4>
<pre>public static final&nbsp;int NO_CASCADE</pre>
<div class="block">Depth level indicating that NO relationships should be included in the copy.
Relationships that are not copied will include the default value of the object's
instantiation policy</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.eclipse.persistence.sessions.CopyGroup.NO_CASCADE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="CASCADE_PRIVATE_PARTS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CASCADE_PRIVATE_PARTS</h4>
<pre>public static final&nbsp;int CASCADE_PRIVATE_PARTS</pre>
<div class="block">Depth level indicating that only relationships with mapping indicated privately-
owned should be copied</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.eclipse.persistence.sessions.CopyGroup.CASCADE_PRIVATE_PARTS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="CASCADE_ALL_PARTS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CASCADE_ALL_PARTS</h4>
<pre>public static final&nbsp;int CASCADE_ALL_PARTS</pre>
<div class="block">Depth level indicating that all relationships with mappings should be used when
building the copied object graph</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.eclipse.persistence.sessions.CopyGroup.CASCADE_ALL_PARTS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="CASCADE_TREE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CASCADE_TREE</h4>
<pre>public static final&nbsp;int CASCADE_TREE</pre>
<div class="block">Depth level indicating that only the attributes found in the attribute group should be copied</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.eclipse.persistence.sessions.CopyGroup.CASCADE_TREE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="CopyGroup--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CopyGroup</h4>
<pre>public&nbsp;CopyGroup()</pre>
<div class="block">PUBLIC:
By default only copy the attributes found in the attribute group and don't null primary keys.</div>
</li>
</ul>
<a name="CopyGroup-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CopyGroup</h4>
<pre>public&nbsp;CopyGroup(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">PUBLIC:
By default only copy the attributes found in the attribute group and don't null primary keys.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="cascadeAllParts--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cascadeAllParts</h4>
<pre>public&nbsp;void&nbsp;cascadeAllParts()</pre>
<div class="block">PUBLIC:
Set if the copy should cascade all relationships when copying the object(s).</div>
</li>
</ul>
<a name="cascadePrivateParts--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cascadePrivateParts</h4>
<pre>public&nbsp;void&nbsp;cascadePrivateParts()</pre>
<div class="block">PUBLIC:
Set if the copy should cascade only those relationships that are configured
as privately-owned.</div>
</li>
</ul>
<a name="cascadeTree--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cascadeTree</h4>
<pre>public&nbsp;void&nbsp;cascadeTree()</pre>
<div class="block">PUBLIC:
Set if the copy should cascade only those attributes that are found in the group.</div>
</li>
</ul>
<a name="dontCascade--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dontCascade</h4>
<pre>public&nbsp;void&nbsp;dontCascade()</pre>
<div class="block">PUBLIC:
Set if the copy should not cascade relationships when copying the object(s)</div>
</li>
</ul>
<a name="getCopies--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCopies</h4>
<pre>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">Map</a>&nbsp;getCopies()</pre>
<div class="block">INTERNAL: Get the session.</div>
</li>
</ul>
<a name="getDepth--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDepth</h4>
<pre>public&nbsp;int&nbsp;getDepth()</pre>
<div class="block">INTERNAL: Return the cascade depth.</div>
</li>
</ul>
<a name="getSession--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSession</h4>
<pre>public&nbsp;org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;getSession()</pre>
<div class="block">INTERNAL: Return the session.</div>
</li>
</ul>
<a name="setCopies-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCopies</h4>
<pre>public&nbsp;void&nbsp;setCopies(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;newCopies)</pre>
<div class="block">INTERNAL: Set the copies.</div>
</li>
</ul>
<a name="setDepth-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDepth</h4>
<pre>public&nbsp;void&nbsp;setDepth(int&nbsp;newDepth)</pre>
<div class="block">INTERNAL: Set the cascade depth.</div>
</li>
</ul>
<a name="setSession-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSession</h4>
<pre>public&nbsp;void&nbsp;setSession(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;newSession)</pre>
<div class="block">INTERNAL: Set the session.</div>
</li>
</ul>
<a name="setShouldResetPrimaryKey-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setShouldResetPrimaryKey</h4>
<pre>public&nbsp;void&nbsp;setShouldResetPrimaryKey(boolean&nbsp;newShouldResetPrimaryKey)</pre>
<div class="block">PUBLIC:
Set if the primary key should be reset to null.</div>
</li>
</ul>
<a name="setShouldResetVersion-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setShouldResetVersion</h4>
<pre>public&nbsp;void&nbsp;setShouldResetVersion(boolean&nbsp;newShouldResetVersion)</pre>
<div class="block">PUBLIC:
Set if the version should be reset to null.</div>
</li>
</ul>
<a name="shouldCascade--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldCascade</h4>
<pre>public&nbsp;boolean&nbsp;shouldCascade()</pre>
<div class="block">PUBLIC:
Return true if has been configured to CASCADE_ALL_PARTS or CASCADE_PRIVATE_PARTS.</div>
</li>
</ul>
<a name="shouldCascadeAllParts--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldCascadeAllParts</h4>
<pre>public&nbsp;boolean&nbsp;shouldCascadeAllParts()</pre>
<div class="block">PUBLIC:
Return true if should CASCADE_ALL_PARTS</div>
</li>
</ul>
<a name="shouldCascadePrivateParts--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldCascadePrivateParts</h4>
<pre>public&nbsp;boolean&nbsp;shouldCascadePrivateParts()</pre>
<div class="block">PUBLIC:
Return true if should CASCADE_PRIVATE_PARTS</div>
</li>
</ul>
<a name="shouldCascadeTree--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldCascadeTree</h4>
<pre>public&nbsp;boolean&nbsp;shouldCascadeTree()</pre>
<div class="block">PUBLIC:
Return true if should CASCADE_TREE</div>
</li>
</ul>
<a name="shouldResetPrimaryKey--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldResetPrimaryKey</h4>
<pre>public&nbsp;boolean&nbsp;shouldResetPrimaryKey()</pre>
<div class="block">PUBLIC:
Return if the primary key should be reset to null.</div>
</li>
</ul>
<a name="shouldResetVersion--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldResetVersion</h4>
<pre>public&nbsp;boolean&nbsp;shouldResetVersion()</pre>
<div class="block">PUBLIC:
Return if the version should be reset to null.</div>
</li>
</ul>
<a name="toStringAdditionalInfo--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toStringAdditionalInfo</h4>
<pre>protected&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">String</a>&nbsp;toStringAdditionalInfo()</pre>
<div class="block">INTERNAL:</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#toStringAdditionalInfo--">toStringAdditionalInfo</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html" title="class in org.eclipse.persistence.core.queries">CoreAttributeGroup</a>&lt;org.eclipse.persistence.internal.queries.AttributeItem,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="addAttribute-java.lang.String-org.eclipse.persistence.core.queries.CoreAttributeGroup-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addAttribute</h4>
<pre>public&nbsp;void&nbsp;addAttribute(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;attributeNameOrPath,
<a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html" title="class in org.eclipse.persistence.core.queries">CoreAttributeGroup</a>&nbsp;group)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#addAttribute-java.lang.String-org.eclipse.persistence.core.queries.CoreAttributeGroup-">CoreAttributeGroup</a></code></span></div>
<div class="block">Add a basic attribute or nested attribute with each String representing
an attribute on the path to what needs to be included in the
AttributeGroup.
<p>
Example: <code>
group.addAttribute("firstName", group1);<br>
group.addAttribute("manager.address", group2);
</code>
Note that existing group corresponding to attributeNameOrPath
will be overridden with the passed group.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html#addAttribute-java.lang.String-org.eclipse.persistence.core.queries.CoreAttributeGroup-">addAttribute</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html" title="class in org.eclipse.persistence.core.queries">CoreAttributeGroup</a>&lt;org.eclipse.persistence.internal.queries.AttributeItem,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>attributeNameOrPath</code> - A simple attribute, array or attributes forming a path</dd>
<dd><code>group</code> - - an AttributeGroup to be added.</dd>
</dl>
</li>
</ul>
<a name="addAttribute-java.lang.String-org.eclipse.persistence.sessions.CopyGroup-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addAttribute</h4>
<pre>public&nbsp;void&nbsp;addAttribute(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;attributeNameOrPath,
<a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html" title="class in org.eclipse.persistence.sessions">CopyGroup</a>&nbsp;group)</pre>
</li>
</ul>
<a name="isCopyGroup--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCopyGroup</h4>
<pre>public&nbsp;boolean&nbsp;isCopyGroup()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html#isCopyGroup--">AttributeGroup</a></code></span></div>
<div class="block">INTERNAL:
This method is used internally when converting to a copy group.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html#isCopyGroup--">isCopyGroup</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html" title="class in org.eclipse.persistence.queries">AttributeGroup</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="clone--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clone</h4>
<pre>public&nbsp;<a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html" title="class in org.eclipse.persistence.sessions">CopyGroup</a>&nbsp;clone()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html#clone--">clone</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html" title="class in org.eclipse.persistence.queries">AttributeGroup</a></code></dd>
</dl>
</li>
</ul>
<a name="getGroup-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGroup</h4>
<pre>public&nbsp;<a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html" title="class in org.eclipse.persistence.sessions">CopyGroup</a>&nbsp;getGroup(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;attributeNameOrPath)</pre>
<div class="block">Returns CopyGroup corresponding to the passed (possibly nested) attribute.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html#getGroup-java.lang.String-">getGroup</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html" title="class in org.eclipse.persistence.queries">AttributeGroup</a></code></dd>
</dl>
</li>
</ul>
<a name="newGroup-java.lang.String-org.eclipse.persistence.core.queries.CoreAttributeGroup-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>newGroup</h4>
<pre>protected&nbsp;<a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html" title="class in org.eclipse.persistence.sessions">CopyGroup</a>&nbsp;newGroup(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html" title="class in org.eclipse.persistence.core.queries">CoreAttributeGroup</a>&nbsp;parent)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html#newGroup-java.lang.String-org.eclipse.persistence.core.queries.CoreAttributeGroup-">AttributeGroup</a></code></span></div>
<div class="block">Subclass may create different types.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html#newGroup-java.lang.String-org.eclipse.persistence.core.queries.CoreAttributeGroup-">newGroup</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html" title="class in org.eclipse.persistence.queries">AttributeGroup</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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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="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">EclipseLink 3.0.1, API Reference</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/eclipse/persistence/sessions/Connector.html" title="interface in org.eclipse.persistence.sessions"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/eclipse/persistence/sessions/DatabaseLogin.html" title="class in org.eclipse.persistence.sessions"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/eclipse/persistence/sessions/CopyGroup.html" target="_top">Frames</a></li>
<li><a href="CopyGroup.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.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>
</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; 2007&#x2013;2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p>
</body>
</html>