Google Git
Sign in
apache / tomee-site-pub / 43cf80e624a0cecf0f38bef5ef2614bfb2410f57 / . / jakartaee-9.0 / javadoc / jakarta / persistence / criteria / PluralJoin.html
blob: e7ec7e42c7ab6854a2a72884cfdfa3be39086356 [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>PluralJoin</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="PluralJoin";
}
}
catch(err) {
}
//-->
var methods = {"i0":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../jakarta/persistence/criteria/Path.html" title="interface in jakarta.persistence.criteria"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../jakarta/persistence/criteria/Predicate.html" title="interface in jakarta.persistence.criteria"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?jakarta/persistence/criteria/PluralJoin.html" target="_top">Frames</a></li>
<li><a href="PluralJoin.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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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">jakarta.persistence.criteria</div>
<h2 title="Interface PluralJoin" class="title">Interface PluralJoin&lt;Z,C,E&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>Z</code> - the source type</dd>
<dd><code>C</code> - the collection type</dd>
<dd><code>E</code> - the element type of the collection</dd>
</dl>
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../jakarta/persistence/criteria/Expression.html" title="interface in jakarta.persistence.criteria">Expression</a>&lt;E&gt;, <a href="../../../jakarta/persistence/criteria/FetchParent.html" title="interface in jakarta.persistence.criteria">FetchParent</a>&lt;Z,E&gt;, <a href="../../../jakarta/persistence/criteria/From.html" title="interface in jakarta.persistence.criteria">From</a>&lt;Z,E&gt;, <a href="../../../jakarta/persistence/criteria/Join.html" title="interface in jakarta.persistence.criteria">Join</a>&lt;Z,E&gt;, <a href="../../../jakarta/persistence/criteria/Path.html" title="interface in jakarta.persistence.criteria">Path</a>&lt;E&gt;, <a href="../../../jakarta/persistence/criteria/Selection.html" title="interface in jakarta.persistence.criteria">Selection</a>&lt;E&gt;, <a href="../../../jakarta/persistence/TupleElement.html" title="interface in jakarta.persistence">TupleElement</a>&lt;E&gt;</dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../jakarta/persistence/criteria/CollectionJoin.html" title="interface in jakarta.persistence.criteria">CollectionJoin</a>&lt;Z,E&gt;, <a href="../../../jakarta/persistence/criteria/ListJoin.html" title="interface in jakarta.persistence.criteria">ListJoin</a>&lt;Z,E&gt;, <a href="../../../jakarta/persistence/criteria/MapJoin.html" title="interface in jakarta.persistence.criteria">MapJoin</a>&lt;Z,K,V&gt;, <a href="../../../jakarta/persistence/criteria/SetJoin.html" title="interface in jakarta.persistence.criteria">SetJoin</a>&lt;Z,E&gt;</dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">PluralJoin&lt;Z,C,E&gt;</span>
extends <a href="../../../jakarta/persistence/criteria/Join.html" title="interface in jakarta.persistence.criteria">Join</a>&lt;Z,E&gt;</pre>
<div class="block">The <code>PluralJoin</code> interface defines functionality
that is common to joins to all collection types. It is
not intended to be used directly in query construction.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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><a href="../../../jakarta/persistence/metamodel/PluralAttribute.html" title="interface in jakarta.persistence.metamodel">PluralAttribute</a>&lt;? super <a href="../../../jakarta/persistence/criteria/PluralJoin.html" title="type parameter in PluralJoin">Z</a>,<a href="../../../jakarta/persistence/criteria/PluralJoin.html" title="type parameter in PluralJoin">C</a>,<a href="../../../jakarta/persistence/criteria/PluralJoin.html" title="type parameter in PluralJoin">E</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/persistence/criteria/PluralJoin.html#getModel--">getModel</a></span>()</code>
<div class="block">Return the metamodel representation for the collection-valued
attribute corresponding to the join.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.jakarta.persistence.criteria.Join">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;jakarta.persistence.criteria.<a href="../../../jakarta/persistence/criteria/Join.html" title="interface in jakarta.persistence.criteria">Join</a></h3>
<code><a href="../../../jakarta/persistence/criteria/Join.html#getAttribute--">getAttribute</a>, <a href="../../../jakarta/persistence/criteria/Join.html#getJoinType--">getJoinType</a>, <a href="../../../jakarta/persistence/criteria/Join.html#getOn--">getOn</a>, <a href="../../../jakarta/persistence/criteria/Join.html#getParent--">getParent</a>, <a href="../../../jakarta/persistence/criteria/Join.html#on-jakarta.persistence.criteria.Expression-">on</a>, <a href="../../../jakarta/persistence/criteria/Join.html#on-jakarta.persistence.criteria.Predicate...-">on</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.jakarta.persistence.criteria.From">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;jakarta.persistence.criteria.<a href="../../../jakarta/persistence/criteria/From.html" title="interface in jakarta.persistence.criteria">From</a></h3>
<code><a href="../../../jakarta/persistence/criteria/From.html#getCorrelationParent--">getCorrelationParent</a>, <a href="../../../jakarta/persistence/criteria/From.html#getJoins--">getJoins</a>, <a href="../../../jakarta/persistence/criteria/From.html#isCorrelated--">isCorrelated</a>, <a href="../../../jakarta/persistence/criteria/From.html#join-jakarta.persistence.metamodel.CollectionAttribute-">join</a>, <a href="../../../jakarta/persistence/criteria/From.html#join-jakarta.persistence.metamodel.CollectionAttribute-jakarta.persistence.criteria.JoinType-">join</a>, <a href="../../../jakarta/persistence/criteria/From.html#join-jakarta.persistence.metamodel.ListAttribute-">join</a>, <a href="../../../jakarta/persistence/criteria/From.html#join-jakarta.persistence.metamodel.ListAttribute-jakarta.persistence.criteria.JoinType-">join</a>, <a href="../../../jakarta/persistence/criteria/From.html#join-jakarta.persistence.metamodel.MapAttribute-">join</a>, <a href="../../../jakarta/persistence/criteria/From.html#join-jakarta.persistence.metamodel.MapAttribute-jakarta.persistence.criteria.JoinType-">join</a>, <a href="../../../jakarta/persistence/criteria/From.html#join-jakarta.persistence.metamodel.SetAttribute-">join</a>, <a href="../../../jakarta/persistence/criteria/From.html#join-jakarta.persistence.metamodel.SetAttribute-jakarta.persistence.criteria.JoinType-">join</a>, <a href="../../../jakarta/persistence/criteria/From.html#join-jakarta.persistence.metamodel.SingularAttribute-">join</a>, <a href="../../../jakarta/persistence/criteria/From.html#join-jakarta.persistence.metamodel.SingularAttribute-jakarta.persistence.criteria.JoinType-">join</a>, <a href="../../../jakarta/persistence/criteria/From.html#join-java.lang.String-">join</a>, <a href="../../../jakarta/persistence/criteria/From.html#join-java.lang.String-jakarta.persistence.criteria.JoinType-">join</a>, <a href="../../../jakarta/persistence/criteria/From.html#joinCollection-java.lang.String-">joinCollection</a>, <a href="../../../jakarta/persistence/criteria/From.html#joinCollection-java.lang.String-jakarta.persistence.criteria.JoinType-">joinCollection</a>, <a href="../../../jakarta/persistence/criteria/From.html#joinList-java.lang.String-">joinList</a>, <a href="../../../jakarta/persistence/criteria/From.html#joinList-java.lang.String-jakarta.persistence.criteria.JoinType-">joinList</a>, <a href="../../../jakarta/persistence/criteria/From.html#joinMap-java.lang.String-">joinMap</a>, <a href="../../../jakarta/persistence/criteria/From.html#joinMap-java.lang.String-jakarta.persistence.criteria.JoinType-">joinMap</a>, <a href="../../../jakarta/persistence/criteria/From.html#joinSet-java.lang.String-">joinSet</a>, <a href="../../../jakarta/persistence/criteria/From.html#joinSet-java.lang.String-jakarta.persistence.criteria.JoinType-">joinSet</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.jakarta.persistence.criteria.Path">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;jakarta.persistence.criteria.<a href="../../../jakarta/persistence/criteria/Path.html" title="interface in jakarta.persistence.criteria">Path</a></h3>
<code><a href="../../../jakarta/persistence/criteria/Path.html#get-jakarta.persistence.metamodel.MapAttribute-">get</a>, <a href="../../../jakarta/persistence/criteria/Path.html#get-jakarta.persistence.metamodel.PluralAttribute-">get</a>, <a href="../../../jakarta/persistence/criteria/Path.html#get-jakarta.persistence.metamodel.SingularAttribute-">get</a>, <a href="../../../jakarta/persistence/criteria/Path.html#get-java.lang.String-">get</a>, <a href="../../../jakarta/persistence/criteria/Path.html#getParentPath--">getParentPath</a>, <a href="../../../jakarta/persistence/criteria/Path.html#type--">type</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.jakarta.persistence.criteria.Expression">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;jakarta.persistence.criteria.<a href="../../../jakarta/persistence/criteria/Expression.html" title="interface in jakarta.persistence.criteria">Expression</a></h3>
<code><a href="../../../jakarta/persistence/criteria/Expression.html#as-java.lang.Class-">as</a>, <a href="../../../jakarta/persistence/criteria/Expression.html#in-java.util.Collection-">in</a>, <a href="../../../jakarta/persistence/criteria/Expression.html#in-jakarta.persistence.criteria.Expression...-">in</a>, <a href="../../../jakarta/persistence/criteria/Expression.html#in-jakarta.persistence.criteria.Expression-">in</a>, <a href="../../../jakarta/persistence/criteria/Expression.html#in-java.lang.Object...-">in</a>, <a href="../../../jakarta/persistence/criteria/Expression.html#isNotNull--">isNotNull</a>, <a href="../../../jakarta/persistence/criteria/Expression.html#isNull--">isNull</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.jakarta.persistence.criteria.Selection">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;jakarta.persistence.criteria.<a href="../../../jakarta/persistence/criteria/Selection.html" title="interface in jakarta.persistence.criteria">Selection</a></h3>
<code><a href="../../../jakarta/persistence/criteria/Selection.html#alias-java.lang.String-">alias</a>, <a href="../../../jakarta/persistence/criteria/Selection.html#getCompoundSelectionItems--">getCompoundSelectionItems</a>, <a href="../../../jakarta/persistence/criteria/Selection.html#isCompoundSelection--">isCompoundSelection</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.jakarta.persistence.TupleElement">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;jakarta.persistence.<a href="../../../jakarta/persistence/TupleElement.html" title="interface in jakarta.persistence">TupleElement</a></h3>
<code><a href="../../../jakarta/persistence/TupleElement.html#getAlias--">getAlias</a>, <a href="../../../jakarta/persistence/TupleElement.html#getJavaType--">getJavaType</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.jakarta.persistence.criteria.FetchParent">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;jakarta.persistence.criteria.<a href="../../../jakarta/persistence/criteria/FetchParent.html" title="interface in jakarta.persistence.criteria">FetchParent</a></h3>
<code><a href="../../../jakarta/persistence/criteria/FetchParent.html#fetch-jakarta.persistence.metamodel.PluralAttribute-">fetch</a>, <a href="../../../jakarta/persistence/criteria/FetchParent.html#fetch-jakarta.persistence.metamodel.PluralAttribute-jakarta.persistence.criteria.JoinType-">fetch</a>, <a href="../../../jakarta/persistence/criteria/FetchParent.html#fetch-jakarta.persistence.metamodel.SingularAttribute-">fetch</a>, <a href="../../../jakarta/persistence/criteria/FetchParent.html#fetch-jakarta.persistence.metamodel.SingularAttribute-jakarta.persistence.criteria.JoinType-">fetch</a>, <a href="../../../jakarta/persistence/criteria/FetchParent.html#fetch-java.lang.String-">fetch</a>, <a href="../../../jakarta/persistence/criteria/FetchParent.html#fetch-java.lang.String-jakarta.persistence.criteria.JoinType-">fetch</a>, <a href="../../../jakarta/persistence/criteria/FetchParent.html#getFetches--">getFetches</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getModel--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getModel</h4>
<pre><a href="../../../jakarta/persistence/metamodel/PluralAttribute.html" title="interface in jakarta.persistence.metamodel">PluralAttribute</a>&lt;? super <a href="../../../jakarta/persistence/criteria/PluralJoin.html" title="type parameter in PluralJoin">Z</a>,<a href="../../../jakarta/persistence/criteria/PluralJoin.html" title="type parameter in PluralJoin">C</a>,<a href="../../../jakarta/persistence/criteria/PluralJoin.html" title="type parameter in PluralJoin">E</a>&gt;&nbsp;getModel()</pre>
<div class="block">Return the metamodel representation for the collection-valued
attribute corresponding to the join.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/persistence/criteria/Path.html#getModel--">getModel</a></code>&nbsp;in interface&nbsp;<code><a href="../../../jakarta/persistence/criteria/Path.html" title="interface in jakarta.persistence.criteria">Path</a>&lt;<a href="../../../jakarta/persistence/criteria/PluralJoin.html" title="type parameter in PluralJoin">E</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>metamodel collection-valued attribute corresponding
to the target of the join</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/criteria/Path.html" title="interface in jakarta.persistence.criteria"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../jakarta/persistence/criteria/Predicate.html" title="interface in jakarta.persistence.criteria"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?jakarta/persistence/criteria/PluralJoin.html" target="_top">Frames</a></li>
<li><a href="PluralJoin.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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>