blob: 2d10624aa1760fa2fc5b55effc1a43d9d9bbcd77 [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>IRVertex (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="IRVertex (Nemo Project 0.4 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":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";
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/IRVertex.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><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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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.vertex</a></div>
<h2 title="Class IRVertex" class="title">Class IRVertex</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../dag/Vertex.html" title="class in org.apache.nemo.common.dag">org.apache.nemo.common.dag.Vertex</a></li>
<li>
<ul class="inheritance">
<li>org.apache.nemo.common.ir.vertex.IRVertex</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.io.Serializable</code>, <code><a href="../../Cloneable.html" title="interface in org.apache.nemo.common">Cloneable</a>&lt;<a href="IRVertex.html" title="class in org.apache.nemo.common.ir.vertex">IRVertex</a>&gt;</code></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="LoopVertex.html" title="class in org.apache.nemo.common.ir.vertex">LoopVertex</a></code>, <code><a href="OperatorVertex.html" title="class in org.apache.nemo.common.ir.vertex">OperatorVertex</a></code>, <code><a href="utility/SamplingVertex.html" title="class in org.apache.nemo.common.ir.vertex.utility">SamplingVertex</a></code>, <code><a href="SourceVertex.html" title="class in org.apache.nemo.common.ir.vertex">SourceVertex</a></code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">IRVertex</span>
extends <a href="../../dag/Vertex.html" title="class in org.apache.nemo.common.dag">Vertex</a>
implements <a href="../../Cloneable.html" title="interface in org.apache.nemo.common">Cloneable</a>&lt;<a href="IRVertex.html" title="class in org.apache.nemo.common.ir.vertex">IRVertex</a>&gt;</pre>
<div class="block">The basic unit of operation in a dataflow program, as well as the most important data structure in Nemo.
An IRVertex is created and modified in the compiler, and executed in the runtime.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../serialized-form.html#org.apache.nemo.common.ir.vertex.IRVertex">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">IRVertex</a></span>()</code></th>
<td class="colLast">
<div class="block">Constructor of IRVertex.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.nemo.common.ir.vertex.IRVertex)">IRVertex</a></span>&#8203;(<a href="IRVertex.html" title="class in org.apache.nemo.common.ir.vertex">IRVertex</a>&nbsp;that)</code></th>
<td class="colLast">
<div class="block">Copy Constructor for IRVertex.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== 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="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="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copyExecutionPropertiesTo(org.apache.nemo.common.ir.vertex.IRVertex)">copyExecutionPropertiesTo</a></span>&#8203;(<a href="IRVertex.html" title="class in org.apache.nemo.common.ir.vertex">IRVertex</a>&nbsp;thatVertex)</code></th>
<td class="colLast">
<div class="block">Static function to copy executionProperties from a vertex to the other.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../executionproperty/ExecutionPropertyMap.html" title="class in org.apache.nemo.common.ir.executionproperty">ExecutionPropertyMap</a>&lt;<a href="../executionproperty/VertexExecutionProperty.html" title="class in org.apache.nemo.common.ir.executionproperty">VertexExecutionProperty</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExecutionProperties()">getExecutionProperties</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected com.fasterxml.jackson.databind.node.ObjectNode</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIRVertexPropertiesAsJsonNode()">getIRVertexPropertiesAsJsonNode</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>&lt;T extends java.io.Serializable&gt;<br>java.util.Optional&lt;T&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPropertyValue(java.lang.Class)">getPropertyValue</a></span>&#8203;(java.lang.Class&lt;? extends <a href="../executionproperty/VertexExecutionProperty.html" title="class in org.apache.nemo.common.ir.executionproperty">VertexExecutionProperty</a>&lt;T&gt;&gt;&nbsp;executionPropertyKey)</code></th>
<td class="colLast">
<div class="block">Get the executionProperty of the IRVertex.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.Boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isUtilityVertex()">isUtilityVertex</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="IRVertex.html" title="class in org.apache.nemo.common.ir.vertex">IRVertex</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setProperty(org.apache.nemo.common.ir.executionproperty.VertexExecutionProperty)">setProperty</a></span>&#8203;(<a href="../executionproperty/VertexExecutionProperty.html" title="class in org.apache.nemo.common.ir.executionproperty">VertexExecutionProperty</a>&lt;?&gt;&nbsp;executionProperty)</code></th>
<td class="colLast">
<div class="block">Set an executionProperty of the IRVertex.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="IRVertex.html" title="class in org.apache.nemo.common.ir.vertex">IRVertex</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPropertyPermanently(org.apache.nemo.common.ir.executionproperty.VertexExecutionProperty)">setPropertyPermanently</a></span>&#8203;(<a href="../executionproperty/VertexExecutionProperty.html" title="class in org.apache.nemo.common.ir.executionproperty">VertexExecutionProperty</a>&lt;?&gt;&nbsp;executionProperty)</code></th>
<td class="colLast">
<div class="block">Set an executionProperty of the IRVertex, permanently.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.nemo.common.dag.Vertex">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.nemo.common.dag.<a href="../../dag/Vertex.html" title="class in org.apache.nemo.common.dag">Vertex</a></h3>
<code><a href="../../dag/Vertex.html#getId()">getId</a>, <a href="../../dag/Vertex.html#getNumericId()">getNumericId</a>, <a href="../../dag/Vertex.html#getPropertiesAsJsonNode()">getPropertiesAsJsonNode</a></code></li>
</ul>
<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>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.nemo.common.Cloneable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.nemo.common.<a href="../../Cloneable.html" title="interface in org.apache.nemo.common">Cloneable</a></h3>
<code><a href="../../Cloneable.html#getClone()">getClone</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>IRVertex</h4>
<pre>public&nbsp;IRVertex()</pre>
<div class="block">Constructor of IRVertex.</div>
</li>
</ul>
<a id="&lt;init&gt;(org.apache.nemo.common.ir.vertex.IRVertex)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>IRVertex</h4>
<pre>public&nbsp;IRVertex&#8203;(<a href="IRVertex.html" title="class in org.apache.nemo.common.ir.vertex">IRVertex</a>&nbsp;that)</pre>
<div class="block">Copy Constructor for IRVertex.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>that</code> - the source object for copying</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="copyExecutionPropertiesTo(org.apache.nemo.common.ir.vertex.IRVertex)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copyExecutionPropertiesTo</h4>
<pre class="methodSignature">public final&nbsp;void&nbsp;copyExecutionPropertiesTo&#8203;(<a href="IRVertex.html" title="class in org.apache.nemo.common.ir.vertex">IRVertex</a>&nbsp;thatVertex)</pre>
<div class="block">Static function to copy executionProperties from a vertex to the other.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>thatVertex</code> - the edge to copy executionProperties to.</dd>
</dl>
</li>
</ul>
<a id="setProperty(org.apache.nemo.common.ir.executionproperty.VertexExecutionProperty)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProperty</h4>
<pre class="methodSignature">public final&nbsp;<a href="IRVertex.html" title="class in org.apache.nemo.common.ir.vertex">IRVertex</a>&nbsp;setProperty&#8203;(<a href="../executionproperty/VertexExecutionProperty.html" title="class in org.apache.nemo.common.ir.executionproperty">VertexExecutionProperty</a>&lt;?&gt;&nbsp;executionProperty)</pre>
<div class="block">Set an executionProperty of the IRVertex.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>executionProperty</code> - new execution property.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the IRVertex with the execution property set.</dd>
</dl>
</li>
</ul>
<a id="setPropertyPermanently(org.apache.nemo.common.ir.executionproperty.VertexExecutionProperty)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPropertyPermanently</h4>
<pre class="methodSignature">public final&nbsp;<a href="IRVertex.html" title="class in org.apache.nemo.common.ir.vertex">IRVertex</a>&nbsp;setPropertyPermanently&#8203;(<a href="../executionproperty/VertexExecutionProperty.html" title="class in org.apache.nemo.common.ir.executionproperty">VertexExecutionProperty</a>&lt;?&gt;&nbsp;executionProperty)</pre>
<div class="block">Set an executionProperty of the IRVertex, permanently.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>executionProperty</code> - new execution property.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the IRVertex with the execution property set.</dd>
</dl>
</li>
</ul>
<a id="isUtilityVertex()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isUtilityVertex</h4>
<pre class="methodSignature">public final&nbsp;java.lang.Boolean&nbsp;isUtilityVertex()</pre>
</li>
</ul>
<a id="getPropertyValue(java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPropertyValue</h4>
<pre class="methodSignature">public final&nbsp;&lt;T extends java.io.Serializable&gt;&nbsp;java.util.Optional&lt;T&gt;&nbsp;getPropertyValue&#8203;(java.lang.Class&lt;? extends <a href="../executionproperty/VertexExecutionProperty.html" title="class in org.apache.nemo.common.ir.executionproperty">VertexExecutionProperty</a>&lt;T&gt;&gt;&nbsp;executionPropertyKey)</pre>
<div class="block">Get the executionProperty of the IRVertex.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Type of the return value.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>executionPropertyKey</code> - key of the execution property.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the execution property.</dd>
</dl>
</li>
</ul>
<a id="getExecutionProperties()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExecutionProperties</h4>
<pre class="methodSignature">public final&nbsp;<a href="../executionproperty/ExecutionPropertyMap.html" title="class in org.apache.nemo.common.ir.executionproperty">ExecutionPropertyMap</a>&lt;<a href="../executionproperty/VertexExecutionProperty.html" title="class in org.apache.nemo.common.ir.executionproperty">VertexExecutionProperty</a>&gt;&nbsp;getExecutionProperties()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the ExecutionPropertyMap of the IRVertex.</dd>
</dl>
</li>
</ul>
<a id="getIRVertexPropertiesAsJsonNode()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getIRVertexPropertiesAsJsonNode</h4>
<pre class="methodSignature">protected final&nbsp;com.fasterxml.jackson.databind.node.ObjectNode&nbsp;getIRVertexPropertiesAsJsonNode()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>IRVertex properties as JSON node.</dd>
</dl>
</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/IRVertex.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><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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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>