blob: 50d013c7dd0bf8354421b8b8ad180a137d59f400 [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>
<title>NamedEntityGraph</title>
<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="NamedEntityGraph";
}
}
catch(err) {
}
//-->
</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>
<div class="subNav">
<ul class="navList">
<li><a href="../../jakarta/persistence/NamedAttributeNode.html" title="annotation in jakarta.persistence"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../jakarta/persistence/NamedEntityGraphs.html" title="annotation in jakarta.persistence"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?jakarta/persistence/NamedEntityGraph.html" target="_top">Frames</a></li>
<li><a href="NamedEntityGraph.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>Field&nbsp;|&nbsp;</li>
<li>Required&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.element.detail">Element</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">jakarta.persistence</div>
<h2 title="Annotation Type NamedEntityGraph" class="title">Annotation Type NamedEntityGraph</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>@Repeatable(value=<a href="../../jakarta/persistence/NamedEntityGraphs.html" title="annotation in jakarta.persistence">NamedEntityGraphs.class</a>)
@Target(value=TYPE)
@Retention(value=RUNTIME)
public @interface <span class="memberNameLabel">NamedEntityGraph</span></pre>
<div class="block">Used to specify the path and boundaries for a find operation or query.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.1</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.optional.element.summary">
<!-- -->
</a>
<h3>Optional Element Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
<caption><span>Optional Elements</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Optional Element and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../jakarta/persistence/NamedAttributeNode.html" title="annotation in jakarta.persistence">NamedAttributeNode</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/NamedEntityGraph.html#attributeNodes--">attributeNodes</a></span></code>
<div class="block">(Optional) A list of attributes of the entity that are included in
this graph.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/NamedEntityGraph.html#includeAllAttributes--">includeAllAttributes</a></span></code>
<div class="block">(Optional) Includes all of the attributes of the annotated
entity class as attribute nodes in the NamedEntityGraph without
the need to explicitly list them.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/NamedEntityGraph.html#name--">name</a></span></code>
<div class="block">(Optional) The name of the entity graph.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../jakarta/persistence/NamedSubgraph.html" title="annotation in jakarta.persistence">NamedSubgraph</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/NamedEntityGraph.html#subclassSubgraphs--">subclassSubgraphs</a></span></code>
<div class="block">(Optional) A list of subgraphs that will add additional
attributes for subclasses of the annotated entity class to the
entity graph.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../jakarta/persistence/NamedSubgraph.html" title="annotation in jakarta.persistence">NamedSubgraph</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/NamedEntityGraph.html#subgraphs--">subgraphs</a></span></code>
<div class="block">(Optional) A list of subgraphs that are included in the
entity graph.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.element.detail">
<!-- -->
</a>
<h3>Element Detail</h3>
<a name="name--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>name</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;name</pre>
<div class="block">(Optional) The name of the entity graph.
Defaults to the entity name of the root entity.</div>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="attributeNodes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>attributeNodes</h4>
<pre>public abstract&nbsp;<a href="../../jakarta/persistence/NamedAttributeNode.html" title="annotation in jakarta.persistence">NamedAttributeNode</a>[]&nbsp;attributeNodes</pre>
<div class="block">(Optional) A list of attributes of the entity that are included in
this graph.</div>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="includeAllAttributes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>includeAllAttributes</h4>
<pre>public abstract&nbsp;boolean&nbsp;includeAllAttributes</pre>
<div class="block">(Optional) Includes all of the attributes of the annotated
entity class as attribute nodes in the NamedEntityGraph without
the need to explicitly list them. Included attributes can
still be fully specified by an attribute node referencing a
subgraph.</div>
<dl>
<dt>Default:</dt>
<dd>false</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="subgraphs--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>subgraphs</h4>
<pre>public abstract&nbsp;<a href="../../jakarta/persistence/NamedSubgraph.html" title="annotation in jakarta.persistence">NamedSubgraph</a>[]&nbsp;subgraphs</pre>
<div class="block">(Optional) A list of subgraphs that are included in the
entity graph. These are referenced by name from NamedAttributeNode
definitions.</div>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="subclassSubgraphs--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>subclassSubgraphs</h4>
<pre>public abstract&nbsp;<a href="../../jakarta/persistence/NamedSubgraph.html" title="annotation in jakarta.persistence">NamedSubgraph</a>[]&nbsp;subclassSubgraphs</pre>
<div class="block">(Optional) A list of subgraphs that will add additional
attributes for subclasses of the annotated entity class to the
entity graph. Specified attributes from superclasses are
included in subclasses.</div>
<dl>
<dt>Default:</dt>
<dd>{}</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>
<div class="subNav">
<ul class="navList">
<li><a href="../../jakarta/persistence/NamedAttributeNode.html" title="annotation in jakarta.persistence"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../jakarta/persistence/NamedEntityGraphs.html" title="annotation in jakarta.persistence"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?jakarta/persistence/NamedEntityGraph.html" target="_top">Frames</a></li>
<li><a href="NamedEntityGraph.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>Field&nbsp;|&nbsp;</li>
<li>Required&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.element.detail">Element</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>