blob: e327eaea1af12e0739c9c27919f782587374c8c0 [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>org.apache.nemo.examples.beam (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="org.apache.nemo.examples.beam (Nemo Project 0.4 API)";
}
}
catch(err) {
}
//-->
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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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>
<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>
<main role="main">
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.nemo.examples.beam</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="BeamWordCount.WordCountOptions.html" title="interface in org.apache.nemo.examples.beam">BeamWordCount.WordCountOptions</a></th>
<td class="colLast">
<div class="block">Options supported by <a href="WordCount.html" title="class in org.apache.nemo.examples.beam"><code>WordCount</code></a>.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="AlternatingLeastSquare.html" title="class in org.apache.nemo.examples.beam">AlternatingLeastSquare</a></th>
<td class="colLast">
<div class="block">Sample Alternating Least Square application.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="AlternatingLeastSquare.CalculateNextMatrix.html" title="class in org.apache.nemo.examples.beam">AlternatingLeastSquare.CalculateNextMatrix</a></th>
<td class="colLast">
<div class="block">DoFn for calculating next matrix at each iteration.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="AlternatingLeastSquare.CreateInitialMatrix.html" title="class in org.apache.nemo.examples.beam">AlternatingLeastSquare.CreateInitialMatrix</a></th>
<td class="colLast">
<div class="block">A DoFn that creates an initial matrix.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="AlternatingLeastSquare.ParseLine.html" title="class in org.apache.nemo.examples.beam">AlternatingLeastSquare.ParseLine</a></th>
<td class="colLast">
<div class="block">Method for parsing the input line.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="AlternatingLeastSquare.TrainingDataCombiner.html" title="class in org.apache.nemo.examples.beam">AlternatingLeastSquare.TrainingDataCombiner</a></th>
<td class="colLast">
<div class="block">Combiner for the training data.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="AlternatingLeastSquare.UngroupSingleVectorList.html" title="class in org.apache.nemo.examples.beam">AlternatingLeastSquare.UngroupSingleVectorList</a></th>
<td class="colLast">
<div class="block">A DoFn that relays a single vector list.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="AlternatingLeastSquare.UpdateUserAndItemMatrix.html" title="class in org.apache.nemo.examples.beam">AlternatingLeastSquare.UpdateUserAndItemMatrix</a></th>
<td class="colLast">
<div class="block">Composite transform that wraps the transforms inside the loop.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="AlternatingLeastSquareInefficient.html" title="class in org.apache.nemo.examples.beam">AlternatingLeastSquareInefficient</a></th>
<td class="colLast">
<div class="block">Sample Alternating Least Square application.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="AlternatingLeastSquareInefficient.UpdateUserAndItemMatrix.html" title="class in org.apache.nemo.examples.beam">AlternatingLeastSquareInefficient.UpdateUserAndItemMatrix</a></th>
<td class="colLast">
<div class="block">Composite transform that wraps the transforms inside the loop.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="BeamWordCount.html" title="class in org.apache.nemo.examples.beam">BeamWordCount</a></th>
<td class="colLast">
<div class="block">An example that counts words in Shakespeare and includes Beam best practices.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="BeamWordCount.CountWords.html" title="class in org.apache.nemo.examples.beam">BeamWordCount.CountWords</a></th>
<td class="colLast">
<div class="block">A PTransform that converts a PCollection containing lines of text into a PCollection of
formatted word counts.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="BeamWordCount.FormatAsTextFn.html" title="class in org.apache.nemo.examples.beam">BeamWordCount.FormatAsTextFn</a></th>
<td class="colLast">
<div class="block">A SimpleFunction that converts a Word and Count into a printable string.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Broadcast.html" title="class in org.apache.nemo.examples.beam">Broadcast</a></th>
<td class="colLast">
<div class="block">Sample Broadcast application.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="EDGARAvgDocSize.html" title="class in org.apache.nemo.examples.beam">EDGARAvgDocSize</a></th>
<td class="colLast">
<div class="block">Application for EDGAR dataset.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="EDGARDocumentSuccessRate.html" title="class in org.apache.nemo.examples.beam">EDGARDocumentSuccessRate</a></th>
<td class="colLast">
<div class="block">Application for EDGAR dataset.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="EDGARRequestsByCIK.html" title="class in org.apache.nemo.examples.beam">EDGARRequestsByCIK</a></th>
<td class="colLast">
<div class="block">Application for EDGAR dataset.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="EDGARTop10BadRefererDocs.html" title="class in org.apache.nemo.examples.beam">EDGARTop10BadRefererDocs</a></th>
<td class="colLast">
<div class="block">Application for EDGAR dataset.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="EDGARTop10BadRefererDocs.ValueComparator.html" title="class in org.apache.nemo.examples.beam">EDGARTop10BadRefererDocs.ValueComparator</a>&lt;K&gt;</th>
<td class="colLast">
<div class="block">Value comparator comparing the double value.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="EDGARTop10Documents.html" title="class in org.apache.nemo.examples.beam">EDGARTop10Documents</a></th>
<td class="colLast">
<div class="block">Application for EDGAR dataset.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="EDGARTop10Documents.ValueComparator.html" title="class in org.apache.nemo.examples.beam">EDGARTop10Documents.ValueComparator</a>&lt;K&gt;</th>
<td class="colLast">
<div class="block">Value comparator comparing the long value.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="FloatArrayCoder.html" title="class in org.apache.nemo.examples.beam">FloatArrayCoder</a></th>
<td class="colLast">
<div class="block">EncoderFactory for float[].</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IntArrayCoder.html" title="class in org.apache.nemo.examples.beam">IntArrayCoder</a></th>
<td class="colLast">
<div class="block">EncoderFactory for int[].</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MinimalWordCount.html" title="class in org.apache.nemo.examples.beam">MinimalWordCount</a></th>
<td class="colLast">
<div class="block">MinimalWordCount program from BEAM.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MultinomialLogisticRegression.html" title="class in org.apache.nemo.examples.beam">MultinomialLogisticRegression</a></th>
<td class="colLast">
<div class="block">Sample Multinomial Logistic Regression application.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MultinomialLogisticRegression.ApplyGradient.html" title="class in org.apache.nemo.examples.beam">MultinomialLogisticRegression.ApplyGradient</a></th>
<td class="colLast">
<div class="block">DoFn class that applies the gradient to the model.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MultinomialLogisticRegression.CalculateGradient.html" title="class in org.apache.nemo.examples.beam">MultinomialLogisticRegression.CalculateGradient</a></th>
<td class="colLast">
<div class="block">Calculate Gradient.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MultinomialLogisticRegression.CombineFunction.html" title="class in org.apache.nemo.examples.beam">MultinomialLogisticRegression.CombineFunction</a></th>
<td class="colLast">
<div class="block">Combine Function for two Double arrays.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MultinomialLogisticRegression.CombineFunctionForIterable.html" title="class in org.apache.nemo.examples.beam">MultinomialLogisticRegression.CombineFunctionForIterable</a></th>
<td class="colLast">
<div class="block">Combine Function for Iterable of gradients.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MultinomialLogisticRegression.UpdateModel.html" title="class in org.apache.nemo.examples.beam">MultinomialLogisticRegression.UpdateModel</a></th>
<td class="colLast">
<div class="block">+ Composite transform that wraps the transforms inside the loop.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="NetworkTraceAnalysis.html" title="class in org.apache.nemo.examples.beam">NetworkTraceAnalysis</a></th>
<td class="colLast">
<div class="block">An app that analyzes data flow from network trace.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ObjectCoderForString.html" title="class in org.apache.nemo.examples.beam">ObjectCoderForString</a></th>
<td class="colLast">
<div class="block">This coder acts like an object coder to conform the type, but is actually just a <code>StringUtf8Coder</code>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="PartitionWordsByLength.html" title="class in org.apache.nemo.examples.beam">PartitionWordsByLength</a></th>
<td class="colLast">
<div class="block">Partition words by length example.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="PerKeyMedian.html" title="class in org.apache.nemo.examples.beam">PerKeyMedian</a></th>
<td class="colLast">
<div class="block">IP stat analysis example used in skew experiment.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="PerPercentileAverage.html" title="class in org.apache.nemo.examples.beam">PerPercentileAverage</a></th>
<td class="colLast">
<div class="block">Per percentile statistics application.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SimpleSumSQL.html" title="class in org.apache.nemo.examples.beam">SimpleSumSQL</a></th>
<td class="colLast">
<div class="block">A simple SQL application.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="WindowedBroadcast.html" title="class in org.apache.nemo.examples.beam">WindowedBroadcast</a></th>
<td class="colLast">
<div class="block">A Windowed WordCount application.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="WindowedWordCount.html" title="class in org.apache.nemo.examples.beam">WindowedWordCount</a></th>
<td class="colLast">
<div class="block">A Windowed WordCount application.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="WordCount.html" title="class in org.apache.nemo.examples.beam">WordCount</a></th>
<td class="colLast">
<div class="block">WordCount application.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="WordCountTimeOut1Sec.html" title="class in org.apache.nemo.examples.beam">WordCountTimeOut1Sec</a></th>
<td class="colLast">
<div class="block">WordCount application, but with a timeout of 1 second.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="WriteOneFilePerWindow.html" title="class in org.apache.nemo.examples.beam">WriteOneFilePerWindow</a></th>
<td class="colLast">
<div class="block">This class is brought from beam/examples/common/WriteOneFilePerWindow.java.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="WriteOneFilePerWindow.PerWindowFiles.html" title="class in org.apache.nemo.examples.beam">WriteOneFilePerWindow.PerWindowFiles</a></th>
<td class="colLast">
<div class="block">A <code>FileBasedSink.FilenamePolicy</code> produces a base file name for a write based on metadata about the data
being written.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</main>
<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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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>
<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>