Google Git
Sign in
apache / incubator-nemo-website / ee5ccb31dfe6523e6550f715cbf4913d9db75dcc / . / apidocs / org / apache / nemo / common / ir / vertex / transform / Transform.html
blob: 1ce746b05aad1a093dfa21ee07118ad32de22142 [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>Transform (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="Transform (Nemo Project 0.4 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":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";
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/Transform.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><a href="#nested.class.summary">Nested</a>&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.vertex.transform</a></div>
<h2 title="Interface Transform" class="title">Interface Transform&lt;I,&#8203;O&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>I</code> - input type.</dd>
<dd><code>O</code> - output type.</dd>
</dl>
<dl>
<dt>All Superinterfaces:</dt>
<dd><code>java.io.Serializable</code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../../../../compiler/frontend/beam/transform/AbstractDoFnTransform.html" title="class in org.apache.nemo.compiler.frontend.beam.transform">AbstractDoFnTransform</a></code>, <code><a href="../../../../compiler/frontend/beam/transform/CombineFnFinalTransform.html" title="class in org.apache.nemo.compiler.frontend.beam.transform">CombineFnFinalTransform</a></code>, <code><a href="../../../../compiler/frontend/beam/transform/CombineFnPartialTransform.html" title="class in org.apache.nemo.compiler.frontend.beam.transform">CombineFnPartialTransform</a></code>, <code><a href="../../../../compiler/frontend/beam/transform/CreateViewTransform.html" title="class in org.apache.nemo.compiler.frontend.beam.transform">CreateViewTransform</a></code>, <code><a href="../../../../compiler/frontend/beam/transform/DoFnTransform.html" title="class in org.apache.nemo.compiler.frontend.beam.transform">DoFnTransform</a></code>, <code><a href="../../../test/EmptyComponents.EmptyTransform.html" title="class in org.apache.nemo.common.test">EmptyComponents.EmptyTransform</a></code>, <code><a href="../../../../compiler/frontend/beam/transform/FlattenTransform.html" title="class in org.apache.nemo.compiler.frontend.beam.transform">FlattenTransform</a></code>, <code><a href="../../../../compiler/frontend/beam/transform/GBKTransform.html" title="class in org.apache.nemo.compiler.frontend.beam.transform">GBKTransform</a></code>, <code><a href="../../../../compiler/frontend/beam/transform/GroupByKeyTransform.html" title="class in org.apache.nemo.compiler.frontend.beam.transform">GroupByKeyTransform</a></code>, <code><a href="LatencymarkEmitTransform.html" title="class in org.apache.nemo.common.ir.vertex.transform">LatencymarkEmitTransform</a></code>, <code><a href="MessageAggregatorTransform.html" title="class in org.apache.nemo.common.ir.vertex.transform">MessageAggregatorTransform</a></code>, <code><a href="MessageGeneratorTransform.html" title="class in org.apache.nemo.common.ir.vertex.transform">MessageGeneratorTransform</a></code>, <code><a href="NoWatermarkEmitTransform.html" title="class in org.apache.nemo.common.ir.vertex.transform">NoWatermarkEmitTransform</a></code>, <code><a href="../../../../compiler/frontend/beam/transform/PushBackDoFnTransform.html" title="class in org.apache.nemo.compiler.frontend.beam.transform">PushBackDoFnTransform</a></code>, <code><a href="../../../../compiler/frontend/beam/transform/SideInputTransform.html" title="class in org.apache.nemo.compiler.frontend.beam.transform">SideInputTransform</a></code>, <code><a href="SignalTransform.html" title="class in org.apache.nemo.common.ir.vertex.transform">SignalTransform</a></code>, <code><a href="StreamTransform.html" title="class in org.apache.nemo.common.ir.vertex.transform">StreamTransform</a></code>, <code><a href="../../../../compiler/frontend/beam/transform/WindowFnTransform.html" title="class in org.apache.nemo.compiler.frontend.beam.transform">WindowFnTransform</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">Transform&lt;I,&#8203;O&gt;</span>
extends java.io.Serializable</pre>
<div class="block">Interface for specifying 'What' to do with data.
It is to be implemented in the compiler frontend, possibly for every operator in a dataflow language.
'How' and 'When' to do with its input/output data are up to the runtime.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Transform.Context.html" title="interface in org.apache.nemo.common.ir.vertex.transform">Transform.Context</a></span></code></th>
<td class="colLast">
<div class="block">Context of the transform.</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="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="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="#close()">close</a></span>()</code></th>
<td class="colLast">
<div class="block">Close the transform.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onData(I)">onData</a></span>&#8203;(<a href="Transform.html" title="type parameter in Transform">I</a>&nbsp;element)</code></th>
<td class="colLast">
<div class="block">On data received.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onLatencymark(org.apache.nemo.common.punctuation.LatencyMark)">onLatencymark</a></span>&#8203;(<a href="../../../punctuation/LatencyMark.html" title="class in org.apache.nemo.common.punctuation">LatencyMark</a>&nbsp;latencymark)</code></th>
<td class="colLast">
<div class="block">On latencymark received.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onWatermark(org.apache.nemo.common.punctuation.Watermark)">onWatermark</a></span>&#8203;(<a href="../../../punctuation/Watermark.html" title="class in org.apache.nemo.common.punctuation">Watermark</a>&nbsp;watermark)</code></th>
<td class="colLast">
<div class="block">On watermark received.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#prepare(org.apache.nemo.common.ir.vertex.transform.Transform.Context,org.apache.nemo.common.ir.OutputCollector)">prepare</a></span>&#8203;(<a href="Transform.Context.html" title="interface in org.apache.nemo.common.ir.vertex.transform">Transform.Context</a>&nbsp;context,
<a href="../../OutputCollector.html" title="interface in org.apache.nemo.common.ir">OutputCollector</a>&lt;<a href="Transform.html" title="type parameter in Transform">O</a>&gt;&nbsp;outputCollector)</code></th>
<td class="colLast">
<div class="block">Prepare the transform.</div>
</td>
</tr>
</table>
</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="prepare(org.apache.nemo.common.ir.vertex.transform.Transform.Context,org.apache.nemo.common.ir.OutputCollector)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prepare</h4>
<pre class="methodSignature">void&nbsp;prepare&#8203;(<a href="Transform.Context.html" title="interface in org.apache.nemo.common.ir.vertex.transform">Transform.Context</a>&nbsp;context,
<a href="../../OutputCollector.html" title="interface in org.apache.nemo.common.ir">OutputCollector</a>&lt;<a href="Transform.html" title="type parameter in Transform">O</a>&gt;&nbsp;outputCollector)</pre>
<div class="block">Prepare the transform.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - of the transform.</dd>
<dd><code>outputCollector</code> - that collects outputs.</dd>
</dl>
</li>
</ul>
<a id="onData(java.lang.Object)">
<!-- -->
</a><a id="onData(I)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onData</h4>
<pre class="methodSignature">void&nbsp;onData&#8203;(<a href="Transform.html" title="type parameter in Transform">I</a>&nbsp;element)</pre>
<div class="block">On data received.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>element</code> - data received.</dd>
</dl>
</li>
</ul>
<a id="onWatermark(org.apache.nemo.common.punctuation.Watermark)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onWatermark</h4>
<pre class="methodSignature">void&nbsp;onWatermark&#8203;(<a href="../../../punctuation/Watermark.html" title="class in org.apache.nemo.common.punctuation">Watermark</a>&nbsp;watermark)</pre>
<div class="block">On watermark received.
This method should be called for the minimum watermark among input streams (input watermark).
Transform may emit collected data after receiving watermarks.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>watermark</code> - watermark</dd>
</dl>
</li>
</ul>
<a id="onLatencymark(org.apache.nemo.common.punctuation.LatencyMark)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onLatencymark</h4>
<pre class="methodSignature">void&nbsp;onLatencymark&#8203;(<a href="../../../punctuation/LatencyMark.html" title="class in org.apache.nemo.common.punctuation">LatencyMark</a>&nbsp;latencymark)</pre>
<div class="block">On latencymark received.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>latencymark</code> - latencymark.</dd>
</dl>
</li>
</ul>
<a id="close()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>close</h4>
<pre class="methodSignature">void&nbsp;close()</pre>
<div class="block">Close the transform.</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/Transform.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><a href="#nested.class.summary">Nested</a>&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>