source: proiecte/HadoopJUnit/hadoop-0.20.1/docs/api/org/apache/hadoop/contrib/utils/join/DataJoinMapperBase.html @ 120

Last change on this file since 120 was 120, checked in by (none), 14 years ago

Added the mail files for the Hadoop JUNit Project
  • Property svn:executable set to *
File size: 33.7 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.6.0_07) on Tue Sep 01 20:56:59 UTC 2009 -->
6<TITLE>
7DataJoinMapperBase (Hadoop 0.20.1 API)
8</TITLE>
9
10<META NAME="date" CONTENT="2009-09-01">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17    if (location.href.indexOf('is-external=true') == -1) {
18        parent.document.title="DataJoinMapperBase (Hadoop 0.20.1 API)";
19    }
20}
21</SCRIPT>
22<NOSCRIPT>
23</NOSCRIPT>
24
25</HEAD>
26
27<BODY BGCOLOR="white" onload="windowTitle();">
28<HR>
29
30
31<!-- ========= START OF TOP NAVBAR ======= -->
32<A NAME="navbar_top"><!-- --></A>
33<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
34<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
35<TR>
36<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
37<A NAME="navbar_top_firstrow"><!-- --></A>
38<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
39  <TR ALIGN="center" VALIGN="top">
40  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
43  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/DataJoinMapperBase.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
47  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
48  </TR>
49</TABLE>
50</TD>
51<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
52</EM>
53</TD>
54</TR>
55
56<TR>
57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
58&nbsp;<A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/DataJoinJob.html" title="class in org.apache.hadoop.contrib.utils.join"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/DataJoinReducerBase.html" title="class in org.apache.hadoop.contrib.utils.join"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../../../index.html?org/apache/hadoop/contrib/utils/join/DataJoinMapperBase.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="DataJoinMapperBase.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
63&nbsp;<SCRIPT type="text/javascript">
64  <!--
65  if(window==top) {
66    document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
67  }
68  //-->
69</SCRIPT>
70<NOSCRIPT>
71  <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
72</NOSCRIPT>
73
74
75</FONT></TD>
76</TR>
77<TR>
78<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
79  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
82</TR>
83</TABLE>
84<A NAME="skip-navbar_top"></A>
85<!-- ========= END OF TOP NAVBAR ========= -->
86
87<HR>
88<!-- ======== START OF CLASS DATA ======== -->
89<H2>
90<FONT SIZE="-1">
91org.apache.hadoop.contrib.utils.join</FONT>
92<BR>
93Class DataJoinMapperBase</H2>
94<PRE>
95<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
96  <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/JobBase.html" title="class in org.apache.hadoop.contrib.utils.join">org.apache.hadoop.contrib.utils.join.JobBase</A>
97      <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.hadoop.contrib.utils.join.DataJoinMapperBase</B>
98</PRE>
99<DL>
100<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/javase/6/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</A>, <A HREF="../../../../../../org/apache/hadoop/mapred/JobConfigurable.html" title="interface in org.apache.hadoop.mapred">JobConfigurable</A>, <A HREF="../../../../../../org/apache/hadoop/mapred/Mapper.html" title="interface in org.apache.hadoop.mapred">Mapper</A>, <A HREF="../../../../../../org/apache/hadoop/mapred/Reducer.html" title="interface in org.apache.hadoop.mapred">Reducer</A></DD>
101</DL>
102<HR>
103<DL>
104<DT><PRE>public abstract class <B>DataJoinMapperBase</B><DT>extends <A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/JobBase.html" title="class in org.apache.hadoop.contrib.utils.join">JobBase</A></DL>
105</PRE>
106
107<P>
108This abstract class serves as the base class for the mapper class of a data
109 join job. This class expects its subclasses to implement methods for the
110 following functionalities:
111 
112 1. Compute the source tag of input values 2. Compute the map output value
113 object 3. Compute the map output key object
114 
115 The source tag will be used by the reducer to determine from which source
116 (which table in SQL terminology) a value comes. Computing the map output
117 value object amounts to performing projecting/filtering work in a SQL
118 statement (through the select/where clauses). Computing the map output key
119 amounts to choosing the join key. This class provides the appropriate plugin
120 points for the user defined subclasses to implement the appropriate logic.
121<P>
122
123<P>
124<HR>
125
126<P>
127<!-- =========== FIELD SUMMARY =========== -->
128
129<A NAME="field_summary"><!-- --></A>
130<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
131<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
132<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
133<B>Field Summary</B></FONT></TH>
134</TR>
135<TR BGCOLOR="white" CLASS="TableRowColor">
136<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
137<CODE>protected &nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
138<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/DataJoinMapperBase.html#inputFile">inputFile</A></B></CODE>
139
140<BR>
141&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
142</TR>
143<TR BGCOLOR="white" CLASS="TableRowColor">
144<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
145<CODE>protected &nbsp;<A HREF="../../../../../../org/apache/hadoop/io/Text.html" title="class in org.apache.hadoop.io">Text</A></CODE></FONT></TD>
146<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/DataJoinMapperBase.html#inputTag">inputTag</A></B></CODE>
147
148<BR>
149&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
150</TR>
151<TR BGCOLOR="white" CLASS="TableRowColor">
152<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
153<CODE>protected &nbsp;<A HREF="../../../../../../org/apache/hadoop/mapred/JobConf.html" title="class in org.apache.hadoop.mapred">JobConf</A></CODE></FONT></TD>
154<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/DataJoinMapperBase.html#job">job</A></B></CODE>
155
156<BR>
157&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
158</TR>
159<TR BGCOLOR="white" CLASS="TableRowColor">
160<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
161<CODE>protected &nbsp;<A HREF="../../../../../../org/apache/hadoop/mapred/Reporter.html" title="interface in org.apache.hadoop.mapred">Reporter</A></CODE></FONT></TD>
162<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/DataJoinMapperBase.html#reporter">reporter</A></B></CODE>
163
164<BR>
165&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
166</TR>
167</TABLE>
168&nbsp;<A NAME="fields_inherited_from_class_org.apache.hadoop.contrib.utils.join.JobBase"><!-- --></A>
169<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
170<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
171<TH ALIGN="left"><B>Fields inherited from class org.apache.hadoop.contrib.utils.join.<A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/JobBase.html" title="class in org.apache.hadoop.contrib.utils.join">JobBase</A></B></TH>
172</TR>
173<TR BGCOLOR="white" CLASS="TableRowColor">
174<TD><CODE><A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/JobBase.html#LOG">LOG</A></CODE></TD>
175</TR>
176</TABLE>
177&nbsp;
178<!-- ======== CONSTRUCTOR SUMMARY ======== -->
179
180<A NAME="constructor_summary"><!-- --></A>
181<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
182<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
183<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
184<B>Constructor Summary</B></FONT></TH>
185</TR>
186<TR BGCOLOR="white" CLASS="TableRowColor">
187<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/DataJoinMapperBase.html#DataJoinMapperBase()">DataJoinMapperBase</A></B>()</CODE>
188
189<BR>
190&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
191</TR>
192</TABLE>
193&nbsp;
194<!-- ========== METHOD SUMMARY =========== -->
195
196<A NAME="method_summary"><!-- --></A>
197<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
198<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
199<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
200<B>Method Summary</B></FONT></TH>
201</TR>
202<TR BGCOLOR="white" CLASS="TableRowColor">
203<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
204<CODE>&nbsp;void</CODE></FONT></TD>
205<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/DataJoinMapperBase.html#close()">close</A></B>()</CODE>
206
207<BR>
208&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
209</TR>
210<TR BGCOLOR="white" CLASS="TableRowColor">
211<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
212<CODE>&nbsp;void</CODE></FONT></TD>
213<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/DataJoinMapperBase.html#configure(org.apache.hadoop.mapred.JobConf)">configure</A></B>(<A HREF="../../../../../../org/apache/hadoop/mapred/JobConf.html" title="class in org.apache.hadoop.mapred">JobConf</A>&nbsp;job)</CODE>
214
215<BR>
216&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Initializes a new instance from a <A HREF="../../../../../../org/apache/hadoop/mapred/JobConf.html" title="class in org.apache.hadoop.mapred"><CODE>JobConf</CODE></A>.</TD>
217</TR>
218<TR BGCOLOR="white" CLASS="TableRowColor">
219<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
220<CODE>protected abstract &nbsp;<A HREF="../../../../../../org/apache/hadoop/io/Text.html" title="class in org.apache.hadoop.io">Text</A></CODE></FONT></TD>
221<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/DataJoinMapperBase.html#generateGroupKey(org.apache.hadoop.contrib.utils.join.TaggedMapOutput)">generateGroupKey</A></B>(<A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/TaggedMapOutput.html" title="class in org.apache.hadoop.contrib.utils.join">TaggedMapOutput</A>&nbsp;aRecord)</CODE>
222
223<BR>
224&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Generate a map output key.</TD>
225</TR>
226<TR BGCOLOR="white" CLASS="TableRowColor">
227<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
228<CODE>protected abstract &nbsp;<A HREF="../../../../../../org/apache/hadoop/io/Text.html" title="class in org.apache.hadoop.io">Text</A></CODE></FONT></TD>
229<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/DataJoinMapperBase.html#generateInputTag(java.lang.String)">generateInputTag</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;inputFile)</CODE>
230
231<BR>
232&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determine the source tag based on the input file name.</TD>
233</TR>
234<TR BGCOLOR="white" CLASS="TableRowColor">
235<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
236<CODE>protected abstract &nbsp;<A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/TaggedMapOutput.html" title="class in org.apache.hadoop.contrib.utils.join">TaggedMapOutput</A></CODE></FONT></TD>
237<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/DataJoinMapperBase.html#generateTaggedMapOutput(java.lang.Object)">generateTaggedMapOutput</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;value)</CODE>
238
239<BR>
240&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Generate a tagged map output value.</TD>
241</TR>
242<TR BGCOLOR="white" CLASS="TableRowColor">
243<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
244<CODE>&nbsp;void</CODE></FONT></TD>
245<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/DataJoinMapperBase.html#map(java.lang.Object, java.lang.Object, org.apache.hadoop.mapred.OutputCollector, org.apache.hadoop.mapred.Reporter)">map</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;key,
246    <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;value,
247    <A HREF="../../../../../../org/apache/hadoop/mapred/OutputCollector.html" title="interface in org.apache.hadoop.mapred">OutputCollector</A>&nbsp;output,
248    <A HREF="../../../../../../org/apache/hadoop/mapred/Reporter.html" title="interface in org.apache.hadoop.mapred">Reporter</A>&nbsp;reporter)</CODE>
249
250<BR>
251&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Maps a single input key/value pair into an intermediate key/value pair.</TD>
252</TR>
253<TR BGCOLOR="white" CLASS="TableRowColor">
254<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
255<CODE>&nbsp;void</CODE></FONT></TD>
256<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/DataJoinMapperBase.html#reduce(java.lang.Object, java.util.Iterator, org.apache.hadoop.mapred.OutputCollector, org.apache.hadoop.mapred.Reporter)">reduce</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;arg0,
257       <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A>&nbsp;arg1,
258       <A HREF="../../../../../../org/apache/hadoop/mapred/OutputCollector.html" title="interface in org.apache.hadoop.mapred">OutputCollector</A>&nbsp;arg2,
259       <A HREF="../../../../../../org/apache/hadoop/mapred/Reporter.html" title="interface in org.apache.hadoop.mapred">Reporter</A>&nbsp;arg3)</CODE>
260
261<BR>
262&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<i>Reduces</i> values for a given key.</TD>
263</TR>
264</TABLE>
265&nbsp;<A NAME="methods_inherited_from_class_org.apache.hadoop.contrib.utils.join.JobBase"><!-- --></A>
266<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
267<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
268<TH ALIGN="left"><B>Methods inherited from class org.apache.hadoop.contrib.utils.join.<A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/JobBase.html" title="class in org.apache.hadoop.contrib.utils.join">JobBase</A></B></TH>
269</TR>
270<TR BGCOLOR="white" CLASS="TableRowColor">
271<TD><CODE><A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/JobBase.html#addDoubleValue(java.lang.Object, double)">addDoubleValue</A>, <A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/JobBase.html#addLongValue(java.lang.Object, long)">addLongValue</A>, <A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/JobBase.html#getDoubleValue(java.lang.Object)">getDoubleValue</A>, <A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/JobBase.html#getLongValue(java.lang.Object)">getLongValue</A>, <A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/JobBase.html#getReport()">getReport</A>, <A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/JobBase.html#report()">report</A>, <A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/JobBase.html#setDoubleValue(java.lang.Object, double)">setDoubleValue</A>, <A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/JobBase.html#setLongValue(java.lang.Object, long)">setLongValue</A></CODE></TD>
272</TR>
273</TABLE>
274&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
275<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
276<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
277<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
278</TR>
279<TR BGCOLOR="white" CLASS="TableRowColor">
280<TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/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://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
281</TR>
282</TABLE>
283&nbsp;
284<P>
285
286<!-- ============ FIELD DETAIL =========== -->
287
288<A NAME="field_detail"><!-- --></A>
289<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
290<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
291<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
292<B>Field Detail</B></FONT></TH>
293</TR>
294</TABLE>
295
296<A NAME="inputFile"><!-- --></A><H3>
297inputFile</H3>
298<PRE>
299protected <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>inputFile</B></PRE>
300<DL>
301<DL>
302</DL>
303</DL>
304<HR>
305
306<A NAME="job"><!-- --></A><H3>
307job</H3>
308<PRE>
309protected <A HREF="../../../../../../org/apache/hadoop/mapred/JobConf.html" title="class in org.apache.hadoop.mapred">JobConf</A> <B>job</B></PRE>
310<DL>
311<DL>
312</DL>
313</DL>
314<HR>
315
316<A NAME="inputTag"><!-- --></A><H3>
317inputTag</H3>
318<PRE>
319protected <A HREF="../../../../../../org/apache/hadoop/io/Text.html" title="class in org.apache.hadoop.io">Text</A> <B>inputTag</B></PRE>
320<DL>
321<DL>
322</DL>
323</DL>
324<HR>
325
326<A NAME="reporter"><!-- --></A><H3>
327reporter</H3>
328<PRE>
329protected <A HREF="../../../../../../org/apache/hadoop/mapred/Reporter.html" title="interface in org.apache.hadoop.mapred">Reporter</A> <B>reporter</B></PRE>
330<DL>
331<DL>
332</DL>
333</DL>
334
335<!-- ========= CONSTRUCTOR DETAIL ======== -->
336
337<A NAME="constructor_detail"><!-- --></A>
338<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
339<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
340<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
341<B>Constructor Detail</B></FONT></TH>
342</TR>
343</TABLE>
344
345<A NAME="DataJoinMapperBase()"><!-- --></A><H3>
346DataJoinMapperBase</H3>
347<PRE>
348public <B>DataJoinMapperBase</B>()</PRE>
349<DL>
350</DL>
351
352<!-- ============ METHOD DETAIL ========== -->
353
354<A NAME="method_detail"><!-- --></A>
355<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
356<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
357<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
358<B>Method Detail</B></FONT></TH>
359</TR>
360</TABLE>
361
362<A NAME="configure(org.apache.hadoop.mapred.JobConf)"><!-- --></A><H3>
363configure</H3>
364<PRE>
365public void <B>configure</B>(<A HREF="../../../../../../org/apache/hadoop/mapred/JobConf.html" title="class in org.apache.hadoop.mapred">JobConf</A>&nbsp;job)</PRE>
366<DL>
367<DD><B>Description copied from class: <CODE><A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/JobBase.html#configure(org.apache.hadoop.mapred.JobConf)">JobBase</A></CODE></B></DD>
368<DD>Initializes a new instance from a <A HREF="../../../../../../org/apache/hadoop/mapred/JobConf.html" title="class in org.apache.hadoop.mapred"><CODE>JobConf</CODE></A>.
369<P>
370<DD><DL>
371<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/hadoop/mapred/JobConfigurable.html#configure(org.apache.hadoop.mapred.JobConf)">configure</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/hadoop/mapred/JobConfigurable.html" title="interface in org.apache.hadoop.mapred">JobConfigurable</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/JobBase.html#configure(org.apache.hadoop.mapred.JobConf)">configure</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/JobBase.html" title="class in org.apache.hadoop.contrib.utils.join">JobBase</A></CODE></DL>
372</DD>
373<DD><DL>
374<DT><B>Parameters:</B><DD><CODE>job</CODE> - the configuration</DL>
375</DD>
376</DL>
377<HR>
378
379<A NAME="generateInputTag(java.lang.String)"><!-- --></A><H3>
380generateInputTag</H3>
381<PRE>
382protected abstract <A HREF="../../../../../../org/apache/hadoop/io/Text.html" title="class in org.apache.hadoop.io">Text</A> <B>generateInputTag</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;inputFile)</PRE>
383<DL>
384<DD>Determine the source tag based on the input file name.
385<P>
386<DD><DL>
387<DT><B>Parameters:</B><DD><CODE>inputFile</CODE> -
388<DT><B>Returns:</B><DD>the source tag computed from the given file name.</DL>
389</DD>
390</DL>
391<HR>
392
393<A NAME="generateTaggedMapOutput(java.lang.Object)"><!-- --></A><H3>
394generateTaggedMapOutput</H3>
395<PRE>
396protected abstract <A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/TaggedMapOutput.html" title="class in org.apache.hadoop.contrib.utils.join">TaggedMapOutput</A> <B>generateTaggedMapOutput</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;value)</PRE>
397<DL>
398<DD>Generate a tagged map output value. The user code can also perform
399 projection/filtering. If it decides to discard the input record when
400 certain conditions are met,it can simply return a null.
401<P>
402<DD><DL>
403<DT><B>Parameters:</B><DD><CODE>value</CODE> -
404<DT><B>Returns:</B><DD>an object of TaggedMapOutput computed from the given value.</DL>
405</DD>
406</DL>
407<HR>
408
409<A NAME="generateGroupKey(org.apache.hadoop.contrib.utils.join.TaggedMapOutput)"><!-- --></A><H3>
410generateGroupKey</H3>
411<PRE>
412protected abstract <A HREF="../../../../../../org/apache/hadoop/io/Text.html" title="class in org.apache.hadoop.io">Text</A> <B>generateGroupKey</B>(<A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/TaggedMapOutput.html" title="class in org.apache.hadoop.contrib.utils.join">TaggedMapOutput</A>&nbsp;aRecord)</PRE>
413<DL>
414<DD>Generate a map output key. The user code can compute the key
415 programmatically, not just selecting the values of some fields. In this
416 sense, it is more general than the joining capabilities of SQL.
417<P>
418<DD><DL>
419<DT><B>Parameters:</B><DD><CODE>aRecord</CODE> -
420<DT><B>Returns:</B><DD>the group key for the given record</DL>
421</DD>
422</DL>
423<HR>
424
425<A NAME="map(java.lang.Object, java.lang.Object, org.apache.hadoop.mapred.OutputCollector, org.apache.hadoop.mapred.Reporter)"><!-- --></A><H3>
426map</H3>
427<PRE>
428public void <B>map</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;key,
429                <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;value,
430                <A HREF="../../../../../../org/apache/hadoop/mapred/OutputCollector.html" title="interface in org.apache.hadoop.mapred">OutputCollector</A>&nbsp;output,
431                <A HREF="../../../../../../org/apache/hadoop/mapred/Reporter.html" title="interface in org.apache.hadoop.mapred">Reporter</A>&nbsp;reporter)
432         throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
433<DL>
434<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/hadoop/mapred/Mapper.html#map(K1, V1, org.apache.hadoop.mapred.OutputCollector, org.apache.hadoop.mapred.Reporter)">Mapper</A></CODE></B></DD>
435<DD>Maps a single input key/value pair into an intermediate key/value pair.
436 
437 <p>Output pairs need not be of the same types as input pairs.  A given
438 input pair may map to zero or many output pairs.  Output pairs are
439 collected with calls to
440 <A HREF="../../../../../../org/apache/hadoop/mapred/OutputCollector.html#collect(K, V)"><CODE>OutputCollector.collect(Object,Object)</CODE></A>.</p>
441
442 <p>Applications can use the <A HREF="../../../../../../org/apache/hadoop/mapred/Reporter.html" title="interface in org.apache.hadoop.mapred"><CODE>Reporter</CODE></A> provided to report progress
443 or just indicate that they are alive. In scenarios where the application
444 takes an insignificant amount of time to process individual key/value
445 pairs, this is crucial since the framework might assume that the task has
446 timed-out and kill that task. The other way of avoiding this is to set
447 <a href="../../../../../../../mapred-default.html#mapred.task.timeout">
448 mapred.task.timeout</a> to a high-enough value (or even zero for no
449 time-outs).</p>
450<P>
451<DD><DL>
452<DT><B>Parameters:</B><DD><CODE>key</CODE> - the input key.<DD><CODE>value</CODE> - the input value.<DD><CODE>output</CODE> - collects mapped keys and values.<DD><CODE>reporter</CODE> - facility to report progress.
453<DT><B>Throws:</B>
454<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
455</DD>
456</DL>
457<HR>
458
459<A NAME="close()"><!-- --></A><H3>
460close</H3>
461<PRE>
462public void <B>close</B>()
463           throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
464<DL>
465<DD><DL>
466
467<DT><B>Throws:</B>
468<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
469</DD>
470</DL>
471<HR>
472
473<A NAME="reduce(java.lang.Object, java.util.Iterator, org.apache.hadoop.mapred.OutputCollector, org.apache.hadoop.mapred.Reporter)"><!-- --></A><H3>
474reduce</H3>
475<PRE>
476public void <B>reduce</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;arg0,
477                   <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A>&nbsp;arg1,
478                   <A HREF="../../../../../../org/apache/hadoop/mapred/OutputCollector.html" title="interface in org.apache.hadoop.mapred">OutputCollector</A>&nbsp;arg2,
479                   <A HREF="../../../../../../org/apache/hadoop/mapred/Reporter.html" title="interface in org.apache.hadoop.mapred">Reporter</A>&nbsp;arg3)
480            throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
481<DL>
482<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/hadoop/mapred/Reducer.html#reduce(K2, java.util.Iterator, org.apache.hadoop.mapred.OutputCollector, org.apache.hadoop.mapred.Reporter)">Reducer</A></CODE></B></DD>
483<DD><i>Reduces</i> values for a given key. 
484 
485 <p>The framework calls this method for each
486 <code>&lt;key, (list of values)></code> pair in the grouped inputs.
487 Output values must be of the same type as input values.  Input keys must
488 not be altered. The framework will <b>reuse</b> the key and value objects
489 that are passed into the reduce, therefore the application should clone
490 the objects they want to keep a copy of. In many cases, all values are
491 combined into zero or one value.
492 </p>
493   
494 <p>Output pairs are collected with calls to 
495 <A HREF="../../../../../../org/apache/hadoop/mapred/OutputCollector.html#collect(K, V)"><CODE>OutputCollector.collect(Object,Object)</CODE></A>.</p>
496
497 <p>Applications can use the <A HREF="../../../../../../org/apache/hadoop/mapred/Reporter.html" title="interface in org.apache.hadoop.mapred"><CODE>Reporter</CODE></A> provided to report progress
498 or just indicate that they are alive. In scenarios where the application
499 takes an insignificant amount of time to process individual key/value
500 pairs, this is crucial since the framework might assume that the task has
501 timed-out and kill that task. The other way of avoiding this is to set
502 <a href="../../../../../../../mapred-default.html#mapred.task.timeout">
503 mapred.task.timeout</a> to a high-enough value (or even zero for no
504 time-outs).</p>
505<P>
506<DD><DL>
507<DT><B>Parameters:</B><DD><CODE>arg0</CODE> - the key.<DD><CODE>arg1</CODE> - the list of values to reduce.<DD><CODE>arg2</CODE> - to collect keys and combined values.<DD><CODE>arg3</CODE> - facility to report progress.
508<DT><B>Throws:</B>
509<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
510</DD>
511</DL>
512<!-- ========= END OF CLASS DATA ========= -->
513<HR>
514
515
516<!-- ======= START OF BOTTOM NAVBAR ====== -->
517<A NAME="navbar_bottom"><!-- --></A>
518<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
519<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
520<TR>
521<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
522<A NAME="navbar_bottom_firstrow"><!-- --></A>
523<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
524  <TR ALIGN="center" VALIGN="top">
525  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
526  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
527  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
528  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/DataJoinMapperBase.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
529  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
530  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
531  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
532  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
533  </TR>
534</TABLE>
535</TD>
536<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
537</EM>
538</TD>
539</TR>
540
541<TR>
542<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
543&nbsp;<A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/DataJoinJob.html" title="class in org.apache.hadoop.contrib.utils.join"><B>PREV CLASS</B></A>&nbsp;
544&nbsp;<A HREF="../../../../../../org/apache/hadoop/contrib/utils/join/DataJoinReducerBase.html" title="class in org.apache.hadoop.contrib.utils.join"><B>NEXT CLASS</B></A></FONT></TD>
545<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
546  <A HREF="../../../../../../index.html?org/apache/hadoop/contrib/utils/join/DataJoinMapperBase.html" target="_top"><B>FRAMES</B></A>  &nbsp;
547&nbsp;<A HREF="DataJoinMapperBase.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
548&nbsp;<SCRIPT type="text/javascript">
549  <!--
550  if(window==top) {
551    document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
552  }
553  //-->
554</SCRIPT>
555<NOSCRIPT>
556  <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
557</NOSCRIPT>
558
559
560</FONT></TD>
561</TR>
562<TR>
563<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
564  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
565<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
566DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
567</TR>
568</TABLE>
569<A NAME="skip-navbar_bottom"></A>
570<!-- ======== END OF BOTTOM NAVBAR ======= -->
571
572<HR>
573Copyright &copy; 2009 The Apache Software Foundation
574</BODY>
575</HTML>
Note: See TracBrowser for help on using the repository browser.