zzg/pj2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
master
pj2/doc/edu/rit/pjmr/Customizer.html
T
Zack Zatkin-Gold c2c773e0c3 initial revision
2016-04-27 01:07:35 -04:00

368 lines
19 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_51) on Wed Apr 06 13:11:06 EDT 2016 -->
<title>Customizer (Parallel Java 2 Library Documentation)</title>
<meta name="date" content="2016-04-06">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Customizer (Parallel Java 2 Library Documentation)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="class-use/Customizer.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-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../edu/rit/pjmr/Combiner.html" title="class in edu.rit.pjmr"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../edu/rit/pjmr/Mapper.html" title="class in edu.rit.pjmr"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?edu/rit/pjmr/Customizer.html" target="_top">Frames</a></li>
<li><a href="Customizer.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All 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><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 name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">edu.rit.pjmr</div>
<h2 title="Class Customizer" class="title">Class Customizer&lt;K,V extends <a href="../../../edu/rit/pj2/Vbl.html" title="interface in edu.rit.pj2">Vbl</a>&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>edu.rit.pjmr.Customizer&lt;K,V&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>K</code> - Mapper output key data type.</dd><dd><code>V</code> - Mapper output value data type; must implement interface
<a href="../../../edu/rit/pj2/Vbl.html" title="interface in edu.rit.pj2">Vbl</a>.</dd></dl>
<hr>
<br>
<pre>public class <span class="strong">Customizer&lt;K,V extends <a href="../../../edu/rit/pj2/Vbl.html" title="interface in edu.rit.pj2">Vbl</a>&gt;</span>
extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Class Customizer is the base class for a customizer in the Parallel Java Map
Reduce Framework. See class <a href="../../../edu/rit/pjmr/PjmrJob.html" title="class in edu.rit.pjmr">PjmrJob</a> for further information
about configuring customizers as part of a PJMR job.
<P>
A <a href="../../../edu/rit/pjmr/MapperTask.html" title="class in edu.rit.pjmr">MapperTask</a> calls a customizer's methods as follows:
<OL TYPE=1>
<P><LI>
The mapper task calls the customizer's <a href="../../../edu/rit/pjmr/Customizer.html#start(java.lang.String[], edu.rit.pjmr.Combiner)"><code>start()</code></a> method, in a single thread, before running the <a href="../../../edu/rit/pjmr/Mapper.html" title="class in edu.rit.pjmr">Mapper</a>s.
The arguments are the customizer's argument strings if any, and the
<a href="../../../edu/rit/pjmr/Combiner.html" title="class in edu.rit.pjmr">Combiner</a> that will accumulate the mappers' results. The
<TT>start()</TT> method may initialize the customizer based on the argument
strings. The <TT>start()</TT> method may do preprocessing operations on the
combiner.
<P><LI>
The mapper task calls the customizer's <a href="../../../edu/rit/pjmr/Customizer.html#finish(edu.rit.pjmr.Combiner)"><code>finish()</code></a>
method, in a single thread, after all the <a href="../../../edu/rit/pjmr/Mapper.html" title="class in edu.rit.pjmr">Mapper</a>s have finished.
The argument is the <a href="../../../edu/rit/pjmr/Combiner.html" title="class in edu.rit.pjmr">Combiner</a>. The <TT>finish()</TT> method may
do postprocessing operations on the combiner.
</OL>
<P>
A <a href="../../../edu/rit/pjmr/ReducerTask.html" title="class in edu.rit.pjmr">ReducerTask</a> calls a customizer's methods as follows:
<OL TYPE=1>
<P><LI>
The reducer task calls the customizer's <a href="../../../edu/rit/pjmr/Customizer.html#start(java.lang.String[], edu.rit.pjmr.Combiner)"><code>start()</code></a> method, in a single thread, before running the <a href="../../../edu/rit/pjmr/Reducer.html" title="class in edu.rit.pjmr">Reducer</a>s. The arguments are the customizer's argument strings if any, and
the <a href="../../../edu/rit/pjmr/Combiner.html" title="class in edu.rit.pjmr">Combiner</a> that contains all the mappers' results. The
<TT>start()</TT> method may initialize the customizer based on the argument
strings. The <TT>start()</TT> method may do preprocessing operations on the
combiner.
<P><LI>
If the customizer's <a href="../../../edu/rit/pjmr/Customizer.html#comesBefore(K, V, K, V)"><code>comesBefore()</code></a>
method has been overridden, the reducer task sorts the combiner's (key,
value) pairs, in a single thread, before running the <a href="../../../edu/rit/pjmr/Reducer.html" title="class in edu.rit.pjmr">Reducer</a>s.
The reducer task calls the customizer's <a href="../../../edu/rit/pjmr/Customizer.html#comesBefore(K, V, K, V)"><code>comesBefore()</code></a> method to determine the
ordering of the pairs. The reducer task passes the pairs to the <a href="../../../edu/rit/pjmr/Reducer.html" title="class in edu.rit.pjmr">Reducer</a>s in the resulting sorted order. If the customizer's <a href="../../../edu/rit/pjmr/Customizer.html#comesBefore(K, V, K, V)"><code>comesBefore()</code></a> method has not been
overridden, the reducer task does not sort the combiner's pairs, and the
reducer task passes the pairs to the <a href="../../../edu/rit/pjmr/Reducer.html" title="class in edu.rit.pjmr">Reducer</a>s in an unspecified
order.
<P><LI>
The reducer task calls the customizer's <a href="../../../edu/rit/pjmr/Customizer.html#finish(edu.rit.pjmr.Combiner)"><code>finish()</code></a>
method, in a single thread, after all the <a href="../../../edu/rit/pjmr/Reducer.html" title="class in edu.rit.pjmr">Reducer</a>s have
finished. The argument is the <a href="../../../edu/rit/pjmr/Combiner.html" title="class in edu.rit.pjmr">Combiner</a>. The <TT>finish()</TT>
method may do postprocessing operations on the combiner.
</OL></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../edu/rit/pjmr/Customizer.html#Customizer()">Customizer</a></strong>()</code>
<div class="block">Construct a new customizer.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../edu/rit/pjmr/Customizer.html#comesBefore(K, V, K, V)">comesBefore</a></strong>(<a href="../../../edu/rit/pjmr/Customizer.html" title="type parameter in Customizer">K</a>&nbsp;key_1,
<a href="../../../edu/rit/pjmr/Customizer.html" title="type parameter in Customizer">V</a>&nbsp;value_1,
<a href="../../../edu/rit/pjmr/Customizer.html" title="type parameter in Customizer">K</a>&nbsp;key_2,
<a href="../../../edu/rit/pjmr/Customizer.html" title="type parameter in Customizer">V</a>&nbsp;value_2)</code>
<div class="block">Determine if the first (key, value) pair comes before the second (key,
value) pair in the desired sorted order.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../edu/rit/pjmr/Customizer.html#finish(edu.rit.pjmr.Combiner)">finish</a></strong>(<a href="../../../edu/rit/pjmr/Combiner.html" title="class in edu.rit.pjmr">Combiner</a>&lt;<a href="../../../edu/rit/pjmr/Customizer.html" title="type parameter in Customizer">K</a>,<a href="../../../edu/rit/pjmr/Customizer.html" title="type parameter in Customizer">V</a>&gt;&nbsp;combiner)</code>
<div class="block">Finish this customizer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../edu/rit/pjmr/Customizer.html#start(java.lang.String[], edu.rit.pjmr.Combiner)">start</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;args,
<a href="../../../edu/rit/pjmr/Combiner.html" title="class in edu.rit.pjmr">Combiner</a>&lt;<a href="../../../edu/rit/pjmr/Customizer.html" title="type parameter in Customizer">K</a>,<a href="../../../edu/rit/pjmr/Customizer.html" title="type parameter in Customizer">V</a>&gt;&nbsp;combiner)</code>
<div class="block">Start this customizer.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Customizer()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Customizer</h4>
<pre>public&nbsp;Customizer()</pre>
<div class="block">Construct a new customizer.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="start(java.lang.String[], edu.rit.pjmr.Combiner)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre>public&nbsp;void&nbsp;start(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;args,
<a href="../../../edu/rit/pjmr/Combiner.html" title="class in edu.rit.pjmr">Combiner</a>&lt;<a href="../../../edu/rit/pjmr/Customizer.html" title="type parameter in Customizer">K</a>,<a href="../../../edu/rit/pjmr/Customizer.html" title="type parameter in Customizer">V</a>&gt;&nbsp;combiner)</pre>
<div class="block">Start this customizer.
<P>
The base class <TT>start()</TT> method does nothing. A subclass may
override the <TT>start()</TT> method to do something.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - Array of zero or more argument strings.</dd><dd><code>combiner</code> - Combiner.</dd></dl>
</li>
</ul>
<a name="comesBefore(java.lang.Object,edu.rit.pj2.Vbl,java.lang.Object,edu.rit.pj2.Vbl)">
<!-- -->
</a><a name="comesBefore(K, V, K, V)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>comesBefore</h4>
<pre>public&nbsp;boolean&nbsp;comesBefore(<a href="../../../edu/rit/pjmr/Customizer.html" title="type parameter in Customizer">K</a>&nbsp;key_1,
<a href="../../../edu/rit/pjmr/Customizer.html" title="type parameter in Customizer">V</a>&nbsp;value_1,
<a href="../../../edu/rit/pjmr/Customizer.html" title="type parameter in Customizer">K</a>&nbsp;key_2,
<a href="../../../edu/rit/pjmr/Customizer.html" title="type parameter in Customizer">V</a>&nbsp;value_2)</pre>
<div class="block">Determine if the first (key, value) pair comes before the second (key,
value) pair in the desired sorted order.
<P>
The Customizer base class does not sort the pairs. A subclass may
override the <TT>comesBefore()</TT> method to sort the pairs into the
desired order.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key_1</code> - Key from first pair.</dd><dd><code>value_1</code> - Value from first pair.</dd><dd><code>key_2</code> - Key from second pair.</dd><dd><code>value_2</code> - Value from second pair.</dd>
<dt><span class="strong">Returns:</span></dt><dd>True if the first pair comes before the second pair, false
otherwise.</dd></dl>
</li>
</ul>
<a name="finish(edu.rit.pjmr.Combiner)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>finish</h4>
<pre>public&nbsp;void&nbsp;finish(<a href="../../../edu/rit/pjmr/Combiner.html" title="class in edu.rit.pjmr">Combiner</a>&lt;<a href="../../../edu/rit/pjmr/Customizer.html" title="type parameter in Customizer">K</a>,<a href="../../../edu/rit/pjmr/Customizer.html" title="type parameter in Customizer">V</a>&gt;&nbsp;combiner)</pre>
<div class="block">Finish this customizer.
<P>
The base class <TT>finish()</TT> method does nothing. A subclass may
override the <TT>finish()</TT> method to do something.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>combiner</code> - Combiner.</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="class-use/Customizer.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-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../edu/rit/pjmr/Combiner.html" title="class in edu.rit.pjmr"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../edu/rit/pjmr/Mapper.html" title="class in edu.rit.pjmr"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?edu/rit/pjmr/Customizer.html" target="_top">Frames</a></li>
<li><a href="Customizer.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All 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><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 name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><FONT SIZE="-2">Copyright &copy; 2013&ndash;2016 by Alan Kaminsky. All rights reserved. Send comments to ark</FONT><FONT SIZE="1" COLOR="#FFFFFF">&shy;</FONT><FONT SIZE="-2">&#64;</FONT><FONT SIZE="1" COLOR="#FFFFFF">&shy;</FONT><FONT SIZE="-2">cs.rit.edu.</FONT></small></p>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink