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