| <!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:33 UTC 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>LoadGroup (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="LoadGroup (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}; |
| 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/queries/JPQLCall.html" title="class in org.eclipse.persistence.queries"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/persistence/queries/MethodBaseQueryRedirector.html" title="class in org.eclipse.persistence.queries"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/persistence/queries/LoadGroup.html" target="_top">Frames</a></li> |
| <li><a href="LoadGroup.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.queries</div> |
| <h2 title="Class LoadGroup" class="title">Class LoadGroup</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><org.eclipse.persistence.internal.queries.AttributeItem,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>></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.queries.LoadGroup</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">LoadGroup</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>: Used to load specified relationship attributes and nested |
| relationship attributes. |
| <p> |
| A LoadGroup can be configured for use on a query using |
| <a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html#setLoadGroup-org.eclipse.persistence.queries.LoadGroup-"><code>ObjectLevelReadQuery.setLoadGroup(LoadGroup)</code></a> or in the case of JPA |
| users with LOAD_GROUP query hint. Alternatively a <a href="../../../../org/eclipse/persistence/queries/FetchGroup.html" title="class in org.eclipse.persistence.queries"><code>FetchGroup</code></a> could be |
| used with <a href="../../../../org/eclipse/persistence/queries/FetchGroup.html#shouldLoad--"><code>FetchGroup.shouldLoad()</code></a> set to true and the FetchGroup |
| configured on a query be executed.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/queries/FetchGroup.html" title="class in org.eclipse.persistence.queries"><code>FetchGroup</code></a>, |
| <a href="../../../../serialized-form.html#org.eclipse.persistence.queries.LoadGroup">Serialized Form</a></dd> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>ailitchev</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>Eclipselink 2.1</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"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/LoadGroup.html#isConcurrent">isConcurrent</a></span></code> </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 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"> </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/queries/LoadGroup.html#LoadGroup--">LoadGroup</a></span>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/LoadGroup.html#LoadGroup-java.lang.String-">LoadGroup</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> name)</code> </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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/queries/LoadGroup.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> attributeNameOrPath, |
| <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html" title="class in org.eclipse.persistence.core.queries">CoreAttributeGroup</a> 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="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/LoadGroup.html#addAttribute-java.lang.String-org.eclipse.persistence.queries.LoadGroup-">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> attributeNameOrPath, |
| <a href="../../../../org/eclipse/persistence/queries/LoadGroup.html" title="class in org.eclipse.persistence.queries">LoadGroup</a> group)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/queries/LoadGroup.html" title="class in org.eclipse.persistence.queries">LoadGroup</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/LoadGroup.html#clone--">clone</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/queries/LoadGroup.html" title="class in org.eclipse.persistence.queries">LoadGroup</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/LoadGroup.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> attributeNameOrPath)</code> |
| <div class="block">Returns LoadGroup corresponding to the passed (possibly nested) attribute.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/LoadGroup.html#getIsConcurrent--">getIsConcurrent</a></span>()</code> |
| <div class="block">INTERNAL: |
| Return if the load group should load its relationships concurrently.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/LoadGroup.html#isConcurrent--">isConcurrent</a></span>()</code> |
| <div class="block">ADVANCED: |
| Return if the load group should load its relationships concurrently.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/LoadGroup.html#isLoadGroup--">isLoadGroup</a></span>()</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/eclipse/persistence/queries/LoadGroup.html" title="class in org.eclipse.persistence.queries">LoadGroup</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/LoadGroup.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> name, |
| <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html" title="class in org.eclipse.persistence.core.queries">CoreAttributeGroup</a> parent)</code> |
| <div class="block">Subclass may create different types.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/queries/LoadGroup.html#setIsConcurrent-java.lang.Boolean-">setIsConcurrent</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> isConcurrent)</code> |
| <div class="block">ADVANCED: |
| Set if the load group should load its relationships concurrently.</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 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#isCopyGroup--">isCopyGroup</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 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#toStringAdditionalInfo--">toStringAdditionalInfo</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 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="isConcurrent"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isConcurrent</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> isConcurrent</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="LoadGroup--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>LoadGroup</h4> |
| <pre>public LoadGroup()</pre> |
| </li> |
| </ul> |
| <a name="LoadGroup-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>LoadGroup</h4> |
| <pre>public LoadGroup(<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> name)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="newGroup-java.lang.String-org.eclipse.persistence.core.queries.CoreAttributeGroup-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newGroup</h4> |
| <pre>protected <a href="../../../../org/eclipse/persistence/queries/LoadGroup.html" title="class in org.eclipse.persistence.queries">LoadGroup</a> 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> name, |
| <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html" title="class in org.eclipse.persistence.core.queries">CoreAttributeGroup</a> parent)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <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> in class <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="isLoadGroup--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isLoadGroup</h4> |
| <pre>public boolean isLoadGroup()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html#isLoadGroup--">isLoadGroup</a></code> in class <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="clone--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clone</h4> |
| <pre>public <a href="../../../../org/eclipse/persistence/queries/LoadGroup.html" title="class in org.eclipse.persistence.queries">LoadGroup</a> clone()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html#clone--">clone</a></code> in class <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 <a href="../../../../org/eclipse/persistence/queries/LoadGroup.html" title="class in org.eclipse.persistence.queries">LoadGroup</a> 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> attributeNameOrPath)</pre> |
| <div class="block">Returns LoadGroup 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> in class <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="addAttribute-java.lang.String-org.eclipse.persistence.core.queries.CoreAttributeGroup-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addAttribute</h4> |
| <pre>public void 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> attributeNameOrPath, |
| <a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html" title="class in org.eclipse.persistence.core.queries">CoreAttributeGroup</a> group)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <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> in class <code><a href="../../../../org/eclipse/persistence/core/queries/CoreAttributeGroup.html" title="class in org.eclipse.persistence.core.queries">CoreAttributeGroup</a><org.eclipse.persistence.internal.queries.AttributeItem,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>></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.queries.LoadGroup-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addAttribute</h4> |
| <pre>public void 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> attributeNameOrPath, |
| <a href="../../../../org/eclipse/persistence/queries/LoadGroup.html" title="class in org.eclipse.persistence.queries">LoadGroup</a> group)</pre> |
| </li> |
| </ul> |
| <a name="getIsConcurrent--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIsConcurrent</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> getIsConcurrent()</pre> |
| <div class="block">INTERNAL: |
| Return if the load group should load its relationships concurrently.</div> |
| </li> |
| </ul> |
| <a name="isConcurrent--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isConcurrent</h4> |
| <pre>public boolean isConcurrent()</pre> |
| <div class="block">ADVANCED: |
| Return if the load group should load its relationships concurrently. |
| This will use the session's server platform's thread pool. |
| Each of the query results objects relationships will be loaded on a different thread. |
| This can improve performance by processing many queries at once. |
| Concurrent load is only supported when a shared cache is used.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/queries/AttributeGroup.html#isConcurrent--">isConcurrent</a></code> in class <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="setIsConcurrent-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setIsConcurrent</h4> |
| <pre>public void setIsConcurrent(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> isConcurrent)</pre> |
| <div class="block">ADVANCED: |
| Set if the load group should load its relationships concurrently. |
| This will use the session's server platform's thread pool. |
| Each of the query results objects relationships will be loaded on a different thread. |
| This can improve performance by processing many queries at once. |
| Concurrent load is only supported when a shared cache is used.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <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/queries/JPQLCall.html" title="class in org.eclipse.persistence.queries"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/persistence/queries/MethodBaseQueryRedirector.html" title="class in org.eclipse.persistence.queries"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/persistence/queries/LoadGroup.html" target="_top">Frames</a></li> |
| <li><a href="LoadGroup.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 2007–2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
