source: proiecte/HadoopJUnit/hadoop-0.20.1/docs/api/org/apache/hadoop/mapred/RawKeyValueIterator.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: 12.8 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:56 UTC 2009 -->
6<TITLE>
7RawKeyValueIterator (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="RawKeyValueIterator (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/RawKeyValueIterator.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/mapred/Partitioner.html" title="interface in org.apache.hadoop.mapred"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../org/apache/hadoop/mapred/RecordReader.html" title="interface in org.apache.hadoop.mapred"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../index.html?org/apache/hadoop/mapred/RawKeyValueIterator.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="RawKeyValueIterator.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;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&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.mapred</FONT>
92<BR>
93Interface RawKeyValueIterator</H2>
94<HR>
95<DL>
96<DT><PRE>public interface <B>RawKeyValueIterator</B></DL>
97</PRE>
98
99<P>
100<code>RawKeyValueIterator</code> is an iterator used to iterate over
101 the raw keys and values during sort/merge of intermediate data.
102<P>
103
104<P>
105<HR>
106
107<P>
108
109<!-- ========== METHOD SUMMARY =========== -->
110
111<A NAME="method_summary"><!-- --></A>
112<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
113<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
114<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
115<B>Method Summary</B></FONT></TH>
116</TR>
117<TR BGCOLOR="white" CLASS="TableRowColor">
118<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
119<CODE>&nbsp;void</CODE></FONT></TD>
120<TD><CODE><B><A HREF="../../../../org/apache/hadoop/mapred/RawKeyValueIterator.html#close()">close</A></B>()</CODE>
121
122<BR>
123&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Closes the iterator so that the underlying streams can be closed.</TD>
124</TR>
125<TR BGCOLOR="white" CLASS="TableRowColor">
126<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
127<CODE>&nbsp;<A HREF="../../../../org/apache/hadoop/io/DataInputBuffer.html" title="class in org.apache.hadoop.io">DataInputBuffer</A></CODE></FONT></TD>
128<TD><CODE><B><A HREF="../../../../org/apache/hadoop/mapred/RawKeyValueIterator.html#getKey()">getKey</A></B>()</CODE>
129
130<BR>
131&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the current raw key.</TD>
132</TR>
133<TR BGCOLOR="white" CLASS="TableRowColor">
134<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
135<CODE>&nbsp;<A HREF="../../../../org/apache/hadoop/util/Progress.html" title="class in org.apache.hadoop.util">Progress</A></CODE></FONT></TD>
136<TD><CODE><B><A HREF="../../../../org/apache/hadoop/mapred/RawKeyValueIterator.html#getProgress()">getProgress</A></B>()</CODE>
137
138<BR>
139&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the Progress object; this has a float (0.0 - 1.0)
140 indicating the bytes processed by the iterator so far</TD>
141</TR>
142<TR BGCOLOR="white" CLASS="TableRowColor">
143<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
144<CODE>&nbsp;<A HREF="../../../../org/apache/hadoop/io/DataInputBuffer.html" title="class in org.apache.hadoop.io">DataInputBuffer</A></CODE></FONT></TD>
145<TD><CODE><B><A HREF="../../../../org/apache/hadoop/mapred/RawKeyValueIterator.html#getValue()">getValue</A></B>()</CODE>
146
147<BR>
148&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the current raw value.</TD>
149</TR>
150<TR BGCOLOR="white" CLASS="TableRowColor">
151<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
152<CODE>&nbsp;boolean</CODE></FONT></TD>
153<TD><CODE><B><A HREF="../../../../org/apache/hadoop/mapred/RawKeyValueIterator.html#next()">next</A></B>()</CODE>
154
155<BR>
156&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets up the current key and value (for getKey and getValue).</TD>
157</TR>
158</TABLE>
159&nbsp;
160<P>
161
162<!-- ============ METHOD DETAIL ========== -->
163
164<A NAME="method_detail"><!-- --></A>
165<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
166<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
167<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
168<B>Method Detail</B></FONT></TH>
169</TR>
170</TABLE>
171
172<A NAME="getKey()"><!-- --></A><H3>
173getKey</H3>
174<PRE>
175<A HREF="../../../../org/apache/hadoop/io/DataInputBuffer.html" title="class in org.apache.hadoop.io">DataInputBuffer</A> <B>getKey</B>()
176                       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>
177<DL>
178<DD>Gets the current raw key.
179<P>
180<DD><DL>
181
182<DT><B>Returns:</B><DD>Gets the current raw key as a DataInputBuffer
183<DT><B>Throws:</B>
184<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>
185</DD>
186</DL>
187<HR>
188
189<A NAME="getValue()"><!-- --></A><H3>
190getValue</H3>
191<PRE>
192<A HREF="../../../../org/apache/hadoop/io/DataInputBuffer.html" title="class in org.apache.hadoop.io">DataInputBuffer</A> <B>getValue</B>()
193                         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>
194<DL>
195<DD>Gets the current raw value.
196<P>
197<DD><DL>
198
199<DT><B>Returns:</B><DD>Gets the current raw value as a DataInputBuffer
200<DT><B>Throws:</B>
201<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>
202</DD>
203</DL>
204<HR>
205
206<A NAME="next()"><!-- --></A><H3>
207next</H3>
208<PRE>
209boolean <B>next</B>()
210             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>
211<DL>
212<DD>Sets up the current key and value (for getKey and getValue).
213<P>
214<DD><DL>
215
216<DT><B>Returns:</B><DD><code>true</code> if there exists a key/value,
217         <code>false</code> otherwise.
218<DT><B>Throws:</B>
219<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>
220</DD>
221</DL>
222<HR>
223
224<A NAME="close()"><!-- --></A><H3>
225close</H3>
226<PRE>
227void <B>close</B>()
228           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>
229<DL>
230<DD>Closes the iterator so that the underlying streams can be closed.
231<P>
232<DD><DL>
233
234<DT><B>Throws:</B>
235<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>
236</DD>
237</DL>
238<HR>
239
240<A NAME="getProgress()"><!-- --></A><H3>
241getProgress</H3>
242<PRE>
243<A HREF="../../../../org/apache/hadoop/util/Progress.html" title="class in org.apache.hadoop.util">Progress</A> <B>getProgress</B>()</PRE>
244<DL>
245<DD>Gets the Progress object; this has a float (0.0 - 1.0)
246 indicating the bytes processed by the iterator so far
247<P>
248<DD><DL>
249</DL>
250</DD>
251</DL>
252<!-- ========= END OF CLASS DATA ========= -->
253<HR>
254
255
256<!-- ======= START OF BOTTOM NAVBAR ====== -->
257<A NAME="navbar_bottom"><!-- --></A>
258<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
259<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
260<TR>
261<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
262<A NAME="navbar_bottom_firstrow"><!-- --></A>
263<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
264  <TR ALIGN="center" VALIGN="top">
265  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
266  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
267  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
268  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/RawKeyValueIterator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
269  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
270  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
271  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
272  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
273  </TR>
274</TABLE>
275</TD>
276<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
277</EM>
278</TD>
279</TR>
280
281<TR>
282<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
283&nbsp;<A HREF="../../../../org/apache/hadoop/mapred/Partitioner.html" title="interface in org.apache.hadoop.mapred"><B>PREV CLASS</B></A>&nbsp;
284&nbsp;<A HREF="../../../../org/apache/hadoop/mapred/RecordReader.html" title="interface in org.apache.hadoop.mapred"><B>NEXT CLASS</B></A></FONT></TD>
285<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
286  <A HREF="../../../../index.html?org/apache/hadoop/mapred/RawKeyValueIterator.html" target="_top"><B>FRAMES</B></A>  &nbsp;
287&nbsp;<A HREF="RawKeyValueIterator.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
288&nbsp;<SCRIPT type="text/javascript">
289  <!--
290  if(window==top) {
291    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
292  }
293  //-->
294</SCRIPT>
295<NOSCRIPT>
296  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
297</NOSCRIPT>
298
299
300</FONT></TD>
301</TR>
302<TR>
303<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
304  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
305<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
306DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
307</TR>
308</TABLE>
309<A NAME="skip-navbar_bottom"></A>
310<!-- ======== END OF BOTTOM NAVBAR ======= -->
311
312<HR>
313Copyright &copy; 2009 The Apache Software Foundation
314</BODY>
315</HTML>
Note: See TracBrowser for help on using the repository browser.