blob: 2afd7ce017add18424b7d833a6dbfb32b5dbd715 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.9.1) on Fri Sep 09 19:30:40 KST 2022 -->
<title>IdManager (Nemo Project 0.4 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-09-09">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="IdManager (Nemo Project 0.4 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/IdManager.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>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 id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.nemo.common.ir</a></div>
<h2 title="Class IdManager" class="title">Class IdManager</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.nemo.common.ir.IdManager</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public final class <span class="typeNameLabel">IdManager</span>
extends java.lang.Object</pre>
<div class="block">ID manager.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static java.lang.Integer</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#generateDuplicatedEdgeGroupId()">generateDuplicatedEdgeGroupId</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static java.lang.Integer</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#generateMessageId()">generateMessageId</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#generateResourceSpecId()">generateResourceSpecId</a></span>()</code></th>
<td class="colLast">
<div class="block">Generates the ID for a resource specification.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVertexId(org.apache.nemo.common.dag.Vertex)">getVertexId</a></span>&#8203;(<a href="../dag/Vertex.html" title="class in org.apache.nemo.common.dag">Vertex</a>&nbsp;v)</code></th>
<td class="colLast">
<div class="block">Used for cloning vertices.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newEdgeId()">newEdgeId</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newVertexId()">newVertexId</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#saveVertexId(org.apache.nemo.common.dag.Vertex,java.lang.String)">saveVertexId</a></span>&#8203;(<a href="../dag/Vertex.html" title="class in org.apache.nemo.common.dag">Vertex</a>&nbsp;v,
java.lang.String&nbsp;id)</code></th>
<td class="colLast">
<div class="block">Save the vertex id for the vertices that can be cloned later on.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setInDriver()">setInDriver</a></span>()</code></th>
<td class="colLast">
<div class="block">Set the realm of the loaded class as REEF driver.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="newVertexId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newVertexId</h4>
<pre class="methodSignature">public static&nbsp;java.lang.String&nbsp;newVertexId()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new operator ID.</dd>
</dl>
</li>
</ul>
<a id="saveVertexId(org.apache.nemo.common.dag.Vertex,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>saveVertexId</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;saveVertexId&#8203;(<a href="../dag/Vertex.html" title="class in org.apache.nemo.common.dag">Vertex</a>&nbsp;v,
java.lang.String&nbsp;id)</pre>
<div class="block">Save the vertex id for the vertices that can be cloned later on.
WARN: this should guarantee that the vertex is no longer used, otherwise, it would result in duplicate IDs.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>v</code> - the original vertex that is to be cloned later on (RootLoopVertex's vertex).</dd>
<dd><code>id</code> - The IDs of the identical vertices.</dd>
</dl>
</li>
</ul>
<a id="getVertexId(org.apache.nemo.common.dag.Vertex)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVertexId</h4>
<pre class="methodSignature">public static&nbsp;java.lang.String&nbsp;getVertexId&#8203;(<a href="../dag/Vertex.html" title="class in org.apache.nemo.common.dag">Vertex</a>&nbsp;v)</pre>
<div class="block">Used for cloning vertices. If an existing ID exists, it returns the unused ID,
otherwise simply acts as the newVertexId method.
WARN: the #saveVertexId method should no longer use the ID saved at that moment,
in order for this method to work correctly.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>v</code> - the vertex to get the ID for.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the ID for the vertex.</dd>
</dl>
</li>
</ul>
<a id="newEdgeId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newEdgeId</h4>
<pre class="methodSignature">public static&nbsp;java.lang.String&nbsp;newEdgeId()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new edge ID.</dd>
</dl>
</li>
</ul>
<a id="generateResourceSpecId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateResourceSpecId</h4>
<pre class="methodSignature">public static&nbsp;java.lang.String&nbsp;generateResourceSpecId()</pre>
<div class="block">Generates the ID for a resource specification.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the generated ID</dd>
</dl>
</li>
</ul>
<a id="generateDuplicatedEdgeGroupId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateDuplicatedEdgeGroupId</h4>
<pre class="methodSignature">public static&nbsp;java.lang.Integer&nbsp;generateDuplicatedEdgeGroupId()</pre>
</li>
</ul>
<a id="generateMessageId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateMessageId</h4>
<pre class="methodSignature">public static&nbsp;java.lang.Integer&nbsp;generateMessageId()</pre>
</li>
</ul>
<a id="setInDriver()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setInDriver</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;setInDriver()</pre>
<div class="block">Set the realm of the loaded class as REEF driver.</div>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/IdManager.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>