source: proiecte/HadoopJUnit/hadoop-0.20.1/docs/api/org/apache/hadoop/io/SequenceFile.Reader.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: 42.0 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.Reader (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.Reader (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.Reader.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.Metadata.html" title="class in org.apache.hadoop.io"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../org/apache/hadoop/io/SequenceFile.Sorter.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.Reader.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="SequenceFile.Reader.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;<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;FIELD&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.io</FONT>
92<BR>
93Class SequenceFile.Reader</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 "><B>org.apache.hadoop.io.SequenceFile.Reader</B>
97</PRE>
98<DL>
99<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></DD>
100</DL>
101<DL>
102<DT><B>Enclosing class:</B><DD><A HREF="../../../../org/apache/hadoop/io/SequenceFile.html" title="class in org.apache.hadoop.io">SequenceFile</A></DD>
103</DL>
104<HR>
105<DL>
106<DT><PRE>public static class <B>SequenceFile.Reader</B><DT>extends <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><DT>implements <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></DL>
107</PRE>
108
109<P>
110Reads key/value pairs from a sequence-format file.
111<P>
112
113<P>
114<HR>
115
116<P>
117
118<!-- ======== CONSTRUCTOR SUMMARY ======== -->
119
120<A NAME="constructor_summary"><!-- --></A>
121<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
122<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
123<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
124<B>Constructor Summary</B></FONT></TH>
125</TR>
126<TR BGCOLOR="white" CLASS="TableRowColor">
127<TD><CODE><B><A HREF="../../../../org/apache/hadoop/io/SequenceFile.Reader.html#SequenceFile.Reader(org.apache.hadoop.fs.FileSystem, org.apache.hadoop.fs.Path, org.apache.hadoop.conf.Configuration)">SequenceFile.Reader</A></B>(<A HREF="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</A>&nbsp;fs,
128                    <A HREF="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</A>&nbsp;file,
129                    <A HREF="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</A>&nbsp;conf)</CODE>
130
131<BR>
132&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Open the named file.</TD>
133</TR>
134</TABLE>
135&nbsp;
136<!-- ========== METHOD SUMMARY =========== -->
137
138<A NAME="method_summary"><!-- --></A>
139<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
140<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
141<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
142<B>Method Summary</B></FONT></TH>
143</TR>
144<TR BGCOLOR="white" CLASS="TableRowColor">
145<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
146<CODE>&nbsp;void</CODE></FONT></TD>
147<TD><CODE><B><A HREF="../../../../org/apache/hadoop/io/SequenceFile.Reader.html#close()">close</A></B>()</CODE>
148
149<BR>
150&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Close the file.</TD>
151</TR>
152<TR BGCOLOR="white" CLASS="TableRowColor">
153<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
154<CODE>&nbsp;<A HREF="../../../../org/apache/hadoop/io/SequenceFile.ValueBytes.html" title="interface in org.apache.hadoop.io">SequenceFile.ValueBytes</A></CODE></FONT></TD>
155<TD><CODE><B><A HREF="../../../../org/apache/hadoop/io/SequenceFile.Reader.html#createValueBytes()">createValueBytes</A></B>()</CODE>
156
157<BR>
158&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
159</TR>
160<TR BGCOLOR="white" CLASS="TableRowColor">
161<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
162<CODE>&nbsp;<A HREF="../../../../org/apache/hadoop/io/compress/CompressionCodec.html" title="interface in org.apache.hadoop.io.compress">CompressionCodec</A></CODE></FONT></TD>
163<TD><CODE><B><A HREF="../../../../org/apache/hadoop/io/SequenceFile.Reader.html#getCompressionCodec()">getCompressionCodec</A></B>()</CODE>
164
165<BR>
166&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the compression codec of data in this file.</TD>
167</TR>
168<TR BGCOLOR="white" CLASS="TableRowColor">
169<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
170<CODE>&nbsp;<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></CODE></FONT></TD>
171<TD><CODE><B><A HREF="../../../../org/apache/hadoop/io/SequenceFile.Reader.html#getCurrentValue(java.lang.Object)">getCurrentValue</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;val)</CODE>
172
173<BR>
174&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the 'value' corresponding to the last read 'key'.</TD>
175</TR>
176<TR BGCOLOR="white" CLASS="TableRowColor">
177<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
178<CODE>&nbsp;void</CODE></FONT></TD>
179<TD><CODE><B><A HREF="../../../../org/apache/hadoop/io/SequenceFile.Reader.html#getCurrentValue(org.apache.hadoop.io.Writable)">getCurrentValue</A></B>(<A HREF="../../../../org/apache/hadoop/io/Writable.html" title="interface in org.apache.hadoop.io">Writable</A>&nbsp;val)</CODE>
180
181<BR>
182&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the 'value' corresponding to the last read 'key'.</TD>
183</TR>
184<TR BGCOLOR="white" CLASS="TableRowColor">
185<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
186<CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A>&lt;?&gt;</CODE></FONT></TD>
187<TD><CODE><B><A HREF="../../../../org/apache/hadoop/io/SequenceFile.Reader.html#getKeyClass()">getKeyClass</A></B>()</CODE>
188
189<BR>
190&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the class of keys in this file.</TD>
191</TR>
192<TR BGCOLOR="white" CLASS="TableRowColor">
193<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
194<CODE>&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>
195<TD><CODE><B><A HREF="../../../../org/apache/hadoop/io/SequenceFile.Reader.html#getKeyClassName()">getKeyClassName</A></B>()</CODE>
196
197<BR>
198&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the name of the key class.</TD>
199</TR>
200<TR BGCOLOR="white" CLASS="TableRowColor">
201<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
202<CODE>&nbsp;<A HREF="../../../../org/apache/hadoop/io/SequenceFile.Metadata.html" title="class in org.apache.hadoop.io">SequenceFile.Metadata</A></CODE></FONT></TD>
203<TD><CODE><B><A HREF="../../../../org/apache/hadoop/io/SequenceFile.Reader.html#getMetadata()">getMetadata</A></B>()</CODE>
204
205<BR>
206&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the metadata object of the file</TD>
207</TR>
208<TR BGCOLOR="white" CLASS="TableRowColor">
209<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
210<CODE>&nbsp;long</CODE></FONT></TD>
211<TD><CODE><B><A HREF="../../../../org/apache/hadoop/io/SequenceFile.Reader.html#getPosition()">getPosition</A></B>()</CODE>
212
213<BR>
214&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the current byte position in the input file.</TD>
215</TR>
216<TR BGCOLOR="white" CLASS="TableRowColor">
217<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
218<CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A>&lt;?&gt;</CODE></FONT></TD>
219<TD><CODE><B><A HREF="../../../../org/apache/hadoop/io/SequenceFile.Reader.html#getValueClass()">getValueClass</A></B>()</CODE>
220
221<BR>
222&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the class of values in this file.</TD>
223</TR>
224<TR BGCOLOR="white" CLASS="TableRowColor">
225<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
226<CODE>&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>
227<TD><CODE><B><A HREF="../../../../org/apache/hadoop/io/SequenceFile.Reader.html#getValueClassName()">getValueClassName</A></B>()</CODE>
228
229<BR>
230&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the name of the value class.</TD>
231</TR>
232<TR BGCOLOR="white" CLASS="TableRowColor">
233<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
234<CODE>&nbsp;boolean</CODE></FONT></TD>
235<TD><CODE><B><A HREF="../../../../org/apache/hadoop/io/SequenceFile.Reader.html#isBlockCompressed()">isBlockCompressed</A></B>()</CODE>
236
237<BR>
238&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if records are block-compressed.</TD>
239</TR>
240<TR BGCOLOR="white" CLASS="TableRowColor">
241<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
242<CODE>&nbsp;boolean</CODE></FONT></TD>
243<TD><CODE><B><A HREF="../../../../org/apache/hadoop/io/SequenceFile.Reader.html#isCompressed()">isCompressed</A></B>()</CODE>
244
245<BR>
246&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if values are compressed.</TD>
247</TR>
248<TR BGCOLOR="white" CLASS="TableRowColor">
249<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
250<CODE>&nbsp;int</CODE></FONT></TD>
251<TD><CODE><B><A HREF="../../../../org/apache/hadoop/io/SequenceFile.Reader.html#next(org.apache.hadoop.io.DataOutputBuffer)">next</A></B>(<A HREF="../../../../org/apache/hadoop/io/DataOutputBuffer.html" title="class in org.apache.hadoop.io">DataOutputBuffer</A>&nbsp;buffer)</CODE>
252
253<BR>
254&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Call <A HREF="../../../../org/apache/hadoop/io/SequenceFile.Reader.html#nextRaw(org.apache.hadoop.io.DataOutputBuffer, org.apache.hadoop.io.SequenceFile.ValueBytes)"><CODE>nextRaw(DataOutputBuffer,SequenceFile.ValueBytes)</CODE></A>.</I></TD>
255</TR>
256<TR BGCOLOR="white" CLASS="TableRowColor">
257<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
258<CODE>&nbsp;<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></CODE></FONT></TD>
259<TD><CODE><B><A HREF="../../../../org/apache/hadoop/io/SequenceFile.Reader.html#next(java.lang.Object)">next</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)</CODE>
260
261<BR>
262&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Read the next key in the file, skipping its
263 value.</TD>
264</TR>
265<TR BGCOLOR="white" CLASS="TableRowColor">
266<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
267<CODE>&nbsp;boolean</CODE></FONT></TD>
268<TD><CODE><B><A HREF="../../../../org/apache/hadoop/io/SequenceFile.Reader.html#next(org.apache.hadoop.io.Writable)">next</A></B>(<A HREF="../../../../org/apache/hadoop/io/Writable.html" title="interface in org.apache.hadoop.io">Writable</A>&nbsp;key)</CODE>
269
270<BR>
271&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Read the next key in the file into <code>key</code>, skipping its
272 value.</TD>
273</TR>
274<TR BGCOLOR="white" CLASS="TableRowColor">
275<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
276<CODE>&nbsp;boolean</CODE></FONT></TD>
277<TD><CODE><B><A HREF="../../../../org/apache/hadoop/io/SequenceFile.Reader.html#next(org.apache.hadoop.io.Writable, org.apache.hadoop.io.Writable)">next</A></B>(<A HREF="../../../../org/apache/hadoop/io/Writable.html" title="interface in org.apache.hadoop.io">Writable</A>&nbsp;key,
278     <A HREF="../../../../org/apache/hadoop/io/Writable.html" title="interface in org.apache.hadoop.io">Writable</A>&nbsp;val)</CODE>
279
280<BR>
281&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Read the next key/value pair in the file into <code>key</code> and
282 <code>val</code>.</TD>
283</TR>
284<TR BGCOLOR="white" CLASS="TableRowColor">
285<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
286<CODE>&nbsp;int</CODE></FONT></TD>
287<TD><CODE><B><A HREF="../../../../org/apache/hadoop/io/SequenceFile.Reader.html#nextRaw(org.apache.hadoop.io.DataOutputBuffer, org.apache.hadoop.io.SequenceFile.ValueBytes)">nextRaw</A></B>(<A HREF="../../../../org/apache/hadoop/io/DataOutputBuffer.html" title="class in org.apache.hadoop.io">DataOutputBuffer</A>&nbsp;key,
288        <A HREF="../../../../org/apache/hadoop/io/SequenceFile.ValueBytes.html" title="interface in org.apache.hadoop.io">SequenceFile.ValueBytes</A>&nbsp;val)</CODE>
289
290<BR>
291&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Read 'raw' records.</TD>
292</TR>
293<TR BGCOLOR="white" CLASS="TableRowColor">
294<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
295<CODE>&nbsp;int</CODE></FONT></TD>
296<TD><CODE><B><A HREF="../../../../org/apache/hadoop/io/SequenceFile.Reader.html#nextRawKey(org.apache.hadoop.io.DataOutputBuffer)">nextRawKey</A></B>(<A HREF="../../../../org/apache/hadoop/io/DataOutputBuffer.html" title="class in org.apache.hadoop.io">DataOutputBuffer</A>&nbsp;key)</CODE>
297
298<BR>
299&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Read 'raw' keys.</TD>
300</TR>
301<TR BGCOLOR="white" CLASS="TableRowColor">
302<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
303<CODE>&nbsp;int</CODE></FONT></TD>
304<TD><CODE><B><A HREF="../../../../org/apache/hadoop/io/SequenceFile.Reader.html#nextRawValue(org.apache.hadoop.io.SequenceFile.ValueBytes)">nextRawValue</A></B>(<A HREF="../../../../org/apache/hadoop/io/SequenceFile.ValueBytes.html" title="interface in org.apache.hadoop.io">SequenceFile.ValueBytes</A>&nbsp;val)</CODE>
305
306<BR>
307&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Read 'raw' values.</TD>
308</TR>
309<TR BGCOLOR="white" CLASS="TableRowColor">
310<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
311<CODE>protected &nbsp;<A HREF="../../../../org/apache/hadoop/fs/FSDataInputStream.html" title="class in org.apache.hadoop.fs">FSDataInputStream</A></CODE></FONT></TD>
312<TD><CODE><B><A HREF="../../../../org/apache/hadoop/io/SequenceFile.Reader.html#openFile(org.apache.hadoop.fs.FileSystem, org.apache.hadoop.fs.Path, int, long)">openFile</A></B>(<A HREF="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</A>&nbsp;fs,
313         <A HREF="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</A>&nbsp;file,
314         int&nbsp;bufferSize,
315         long&nbsp;length)</CODE>
316
317<BR>
318&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Override this method to specialize the type of
319 <A HREF="../../../../org/apache/hadoop/fs/FSDataInputStream.html" title="class in org.apache.hadoop.fs"><CODE>FSDataInputStream</CODE></A> returned.</TD>
320</TR>
321<TR BGCOLOR="white" CLASS="TableRowColor">
322<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
323<CODE>&nbsp;void</CODE></FONT></TD>
324<TD><CODE><B><A HREF="../../../../org/apache/hadoop/io/SequenceFile.Reader.html#seek(long)">seek</A></B>(long&nbsp;position)</CODE>
325
326<BR>
327&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the current byte position in the input file.</TD>
328</TR>
329<TR BGCOLOR="white" CLASS="TableRowColor">
330<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
331<CODE>&nbsp;void</CODE></FONT></TD>
332<TD><CODE><B><A HREF="../../../../org/apache/hadoop/io/SequenceFile.Reader.html#sync(long)">sync</A></B>(long&nbsp;position)</CODE>
333
334<BR>
335&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Seek to the next sync mark past a given position.</TD>
336</TR>
337<TR BGCOLOR="white" CLASS="TableRowColor">
338<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
339<CODE>&nbsp;boolean</CODE></FONT></TD>
340<TD><CODE><B><A HREF="../../../../org/apache/hadoop/io/SequenceFile.Reader.html#syncSeen()">syncSeen</A></B>()</CODE>
341
342<BR>
343&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true iff the previous call to next passed a sync mark.</TD>
344</TR>
345<TR BGCOLOR="white" CLASS="TableRowColor">
346<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
347<CODE>&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>
348<TD><CODE><B><A HREF="../../../../org/apache/hadoop/io/SequenceFile.Reader.html#toString()">toString</A></B>()</CODE>
349
350<BR>
351&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the name of the file.</TD>
352</TR>
353</TABLE>
354&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
355<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
356<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
357<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>
358</TR>
359<TR BGCOLOR="white" CLASS="TableRowColor">
360<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#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>
361</TR>
362</TABLE>
363&nbsp;
364<P>
365
366<!-- ========= CONSTRUCTOR DETAIL ======== -->
367
368<A NAME="constructor_detail"><!-- --></A>
369<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
370<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
371<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
372<B>Constructor Detail</B></FONT></TH>
373</TR>
374</TABLE>
375
376<A NAME="SequenceFile.Reader(org.apache.hadoop.fs.FileSystem, org.apache.hadoop.fs.Path, org.apache.hadoop.conf.Configuration)"><!-- --></A><H3>
377SequenceFile.Reader</H3>
378<PRE>
379public <B>SequenceFile.Reader</B>(<A HREF="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</A>&nbsp;fs,
380                           <A HREF="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</A>&nbsp;file,
381                           <A HREF="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</A>&nbsp;conf)
382                    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>
383<DL>
384<DD>Open the named file.
385<P>
386<DL>
387
388<DT><B>Throws:</B>
389<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>
390</DL>
391
392<!-- ============ METHOD DETAIL ========== -->
393
394<A NAME="method_detail"><!-- --></A>
395<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
396<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
397<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
398<B>Method Detail</B></FONT></TH>
399</TR>
400</TABLE>
401
402<A NAME="openFile(org.apache.hadoop.fs.FileSystem, org.apache.hadoop.fs.Path, int, long)"><!-- --></A><H3>
403openFile</H3>
404<PRE>
405protected <A HREF="../../../../org/apache/hadoop/fs/FSDataInputStream.html" title="class in org.apache.hadoop.fs">FSDataInputStream</A> <B>openFile</B>(<A HREF="../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs">FileSystem</A>&nbsp;fs,
406                                     <A HREF="../../../../org/apache/hadoop/fs/Path.html" title="class in org.apache.hadoop.fs">Path</A>&nbsp;file,
407                                     int&nbsp;bufferSize,
408                                     long&nbsp;length)
409                              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>
410<DL>
411<DD>Override this method to specialize the type of
412 <A HREF="../../../../org/apache/hadoop/fs/FSDataInputStream.html" title="class in org.apache.hadoop.fs"><CODE>FSDataInputStream</CODE></A> returned.
413<P>
414<DD><DL>
415</DL>
416</DD>
417<DD><DL>
418
419<DT><B>Throws:</B>
420<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>
421</DD>
422</DL>
423<HR>
424
425<A NAME="close()"><!-- --></A><H3>
426close</H3>
427<PRE>
428public void <B>close</B>()
429           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>
430<DL>
431<DD>Close the file.
432<P>
433<DD><DL>
434<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/Closeable.html?is-external=true#close()" title="class or interface in java.io">close</A></CODE> in interface <CODE><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></CODE></DL>
435</DD>
436<DD><DL>
437
438<DT><B>Throws:</B>
439<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>
440</DD>
441</DL>
442<HR>
443
444<A NAME="getKeyClassName()"><!-- --></A><H3>
445getKeyClassName</H3>
446<PRE>
447public <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>getKeyClassName</B>()</PRE>
448<DL>
449<DD>Returns the name of the key class.
450<P>
451<DD><DL>
452</DL>
453</DD>
454<DD><DL>
455</DL>
456</DD>
457</DL>
458<HR>
459
460<A NAME="getKeyClass()"><!-- --></A><H3>
461getKeyClass</H3>
462<PRE>
463public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A>&lt;?&gt; <B>getKeyClass</B>()</PRE>
464<DL>
465<DD>Returns the class of keys in this file.
466<P>
467<DD><DL>
468</DL>
469</DD>
470<DD><DL>
471</DL>
472</DD>
473</DL>
474<HR>
475
476<A NAME="getValueClassName()"><!-- --></A><H3>
477getValueClassName</H3>
478<PRE>
479public <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>getValueClassName</B>()</PRE>
480<DL>
481<DD>Returns the name of the value class.
482<P>
483<DD><DL>
484</DL>
485</DD>
486<DD><DL>
487</DL>
488</DD>
489</DL>
490<HR>
491
492<A NAME="getValueClass()"><!-- --></A><H3>
493getValueClass</H3>
494<PRE>
495public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A>&lt;?&gt; <B>getValueClass</B>()</PRE>
496<DL>
497<DD>Returns the class of values in this file.
498<P>
499<DD><DL>
500</DL>
501</DD>
502<DD><DL>
503</DL>
504</DD>
505</DL>
506<HR>
507
508<A NAME="isCompressed()"><!-- --></A><H3>
509isCompressed</H3>
510<PRE>
511public boolean <B>isCompressed</B>()</PRE>
512<DL>
513<DD>Returns true if values are compressed.
514<P>
515<DD><DL>
516</DL>
517</DD>
518<DD><DL>
519</DL>
520</DD>
521</DL>
522<HR>
523
524<A NAME="isBlockCompressed()"><!-- --></A><H3>
525isBlockCompressed</H3>
526<PRE>
527public boolean <B>isBlockCompressed</B>()</PRE>
528<DL>
529<DD>Returns true if records are block-compressed.
530<P>
531<DD><DL>
532</DL>
533</DD>
534<DD><DL>
535</DL>
536</DD>
537</DL>
538<HR>
539
540<A NAME="getCompressionCodec()"><!-- --></A><H3>
541getCompressionCodec</H3>
542<PRE>
543public <A HREF="../../../../org/apache/hadoop/io/compress/CompressionCodec.html" title="interface in org.apache.hadoop.io.compress">CompressionCodec</A> <B>getCompressionCodec</B>()</PRE>
544<DL>
545<DD>Returns the compression codec of data in this file.
546<P>
547<DD><DL>
548</DL>
549</DD>
550<DD><DL>
551</DL>
552</DD>
553</DL>
554<HR>
555
556<A NAME="getMetadata()"><!-- --></A><H3>
557getMetadata</H3>
558<PRE>
559public <A HREF="../../../../org/apache/hadoop/io/SequenceFile.Metadata.html" title="class in org.apache.hadoop.io">SequenceFile.Metadata</A> <B>getMetadata</B>()</PRE>
560<DL>
561<DD>Returns the metadata object of the file
562<P>
563<DD><DL>
564</DL>
565</DD>
566<DD><DL>
567</DL>
568</DD>
569</DL>
570<HR>
571
572<A NAME="getCurrentValue(org.apache.hadoop.io.Writable)"><!-- --></A><H3>
573getCurrentValue</H3>
574<PRE>
575public void <B>getCurrentValue</B>(<A HREF="../../../../org/apache/hadoop/io/Writable.html" title="interface in org.apache.hadoop.io">Writable</A>&nbsp;val)
576                     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>
577<DL>
578<DD>Get the 'value' corresponding to the last read 'key'.
579<P>
580<DD><DL>
581</DL>
582</DD>
583<DD><DL>
584<DT><B>Parameters:</B><DD><CODE>val</CODE> - : The 'value' to be read.
585<DT><B>Throws:</B>
586<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>
587</DD>
588</DL>
589<HR>
590
591<A NAME="getCurrentValue(java.lang.Object)"><!-- --></A><H3>
592getCurrentValue</H3>
593<PRE>
594public <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>getCurrentValue</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;val)
595                       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>
596<DL>
597<DD>Get the 'value' corresponding to the last read 'key'.
598<P>
599<DD><DL>
600</DL>
601</DD>
602<DD><DL>
603<DT><B>Parameters:</B><DD><CODE>val</CODE> - : The 'value' to be read.
604<DT><B>Throws:</B>
605<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>
606</DD>
607</DL>
608<HR>
609
610<A NAME="next(org.apache.hadoop.io.Writable)"><!-- --></A><H3>
611next</H3>
612<PRE>
613public boolean <B>next</B>(<A HREF="../../../../org/apache/hadoop/io/Writable.html" title="interface in org.apache.hadoop.io">Writable</A>&nbsp;key)
614             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>
615<DL>
616<DD>Read the next key in the file into <code>key</code>, skipping its
617 value.  True if another entry exists, and false at end of file.
618<P>
619<DD><DL>
620</DL>
621</DD>
622<DD><DL>
623
624<DT><B>Throws:</B>
625<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>
626</DD>
627</DL>
628<HR>
629
630<A NAME="next(org.apache.hadoop.io.Writable, org.apache.hadoop.io.Writable)"><!-- --></A><H3>
631next</H3>
632<PRE>
633public boolean <B>next</B>(<A HREF="../../../../org/apache/hadoop/io/Writable.html" title="interface in org.apache.hadoop.io">Writable</A>&nbsp;key,
634                    <A HREF="../../../../org/apache/hadoop/io/Writable.html" title="interface in org.apache.hadoop.io">Writable</A>&nbsp;val)
635             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>
636<DL>
637<DD>Read the next key/value pair in the file into <code>key</code> and
638 <code>val</code>.  Returns true if such a pair exists and false when at
639 end of file
640<P>
641<DD><DL>
642</DL>
643</DD>
644<DD><DL>
645
646<DT><B>Throws:</B>
647<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>
648</DD>
649</DL>
650<HR>
651
652<A NAME="next(org.apache.hadoop.io.DataOutputBuffer)"><!-- --></A><H3>
653next</H3>
654<PRE>
655public int <B>next</B>(<A HREF="../../../../org/apache/hadoop/io/DataOutputBuffer.html" title="class in org.apache.hadoop.io">DataOutputBuffer</A>&nbsp;buffer)
656         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>
657<DL>
658<DD><B>Deprecated.</B>&nbsp;<I>Call <A HREF="../../../../org/apache/hadoop/io/SequenceFile.Reader.html#nextRaw(org.apache.hadoop.io.DataOutputBuffer, org.apache.hadoop.io.SequenceFile.ValueBytes)"><CODE>nextRaw(DataOutputBuffer,SequenceFile.ValueBytes)</CODE></A>.</I>
659<P>
660<DD><DL>
661</DL>
662</DD>
663<DD><DL>
664
665<DT><B>Throws:</B>
666<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>
667</DD>
668</DL>
669<HR>
670
671<A NAME="createValueBytes()"><!-- --></A><H3>
672createValueBytes</H3>
673<PRE>
674public <A HREF="../../../../org/apache/hadoop/io/SequenceFile.ValueBytes.html" title="interface in org.apache.hadoop.io">SequenceFile.ValueBytes</A> <B>createValueBytes</B>()</PRE>
675<DL>
676<DD><DL>
677</DL>
678</DD>
679<DD><DL>
680</DL>
681</DD>
682</DL>
683<HR>
684
685<A NAME="nextRaw(org.apache.hadoop.io.DataOutputBuffer, org.apache.hadoop.io.SequenceFile.ValueBytes)"><!-- --></A><H3>
686nextRaw</H3>
687<PRE>
688public int <B>nextRaw</B>(<A HREF="../../../../org/apache/hadoop/io/DataOutputBuffer.html" title="class in org.apache.hadoop.io">DataOutputBuffer</A>&nbsp;key,
689                   <A HREF="../../../../org/apache/hadoop/io/SequenceFile.ValueBytes.html" title="interface in org.apache.hadoop.io">SequenceFile.ValueBytes</A>&nbsp;val)
690            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>
691<DL>
692<DD>Read 'raw' records.
693<P>
694<DD><DL>
695</DL>
696</DD>
697<DD><DL>
698<DT><B>Parameters:</B><DD><CODE>key</CODE> - - The buffer into which the key is read<DD><CODE>val</CODE> - - The 'raw' value
699<DT><B>Returns:</B><DD>Returns the total record length or -1 for end of file
700<DT><B>Throws:</B>
701<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>
702</DD>
703</DL>
704<HR>
705
706<A NAME="nextRawKey(org.apache.hadoop.io.DataOutputBuffer)"><!-- --></A><H3>
707nextRawKey</H3>
708<PRE>
709public int <B>nextRawKey</B>(<A HREF="../../../../org/apache/hadoop/io/DataOutputBuffer.html" title="class in org.apache.hadoop.io">DataOutputBuffer</A>&nbsp;key)
710               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>
711<DL>
712<DD>Read 'raw' keys.
713<P>
714<DD><DL>
715</DL>
716</DD>
717<DD><DL>
718<DT><B>Parameters:</B><DD><CODE>key</CODE> - - The buffer into which the key is read
719<DT><B>Returns:</B><DD>Returns the key length or -1 for end of file
720<DT><B>Throws:</B>
721<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>
722</DD>
723</DL>
724<HR>
725
726<A NAME="next(java.lang.Object)"><!-- --></A><H3>
727next</H3>
728<PRE>
729public <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>next</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)
730            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>
731<DL>
732<DD>Read the next key in the file, skipping its
733 value.  Return null at end of file.
734<P>
735<DD><DL>
736</DL>
737</DD>
738<DD><DL>
739
740<DT><B>Throws:</B>
741<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>
742</DD>
743</DL>
744<HR>
745
746<A NAME="nextRawValue(org.apache.hadoop.io.SequenceFile.ValueBytes)"><!-- --></A><H3>
747nextRawValue</H3>
748<PRE>
749public int <B>nextRawValue</B>(<A HREF="../../../../org/apache/hadoop/io/SequenceFile.ValueBytes.html" title="interface in org.apache.hadoop.io">SequenceFile.ValueBytes</A>&nbsp;val)
750                 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>
751<DL>
752<DD>Read 'raw' values.
753<P>
754<DD><DL>
755</DL>
756</DD>
757<DD><DL>
758<DT><B>Parameters:</B><DD><CODE>val</CODE> - - The 'raw' value
759<DT><B>Returns:</B><DD>Returns the value length
760<DT><B>Throws:</B>
761<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>
762</DD>
763</DL>
764<HR>
765
766<A NAME="seek(long)"><!-- --></A><H3>
767seek</H3>
768<PRE>
769public void <B>seek</B>(long&nbsp;position)
770          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>
771<DL>
772<DD>Set the current byte position in the input file.
773
774 <p>The position passed must be a position returned by <A HREF="../../../../org/apache/hadoop/io/SequenceFile.Writer.html#getLength()"><CODE>SequenceFile.Writer.getLength()</CODE></A> when writing this file.  To seek to an arbitrary
775 position, use <A HREF="../../../../org/apache/hadoop/io/SequenceFile.Reader.html#sync(long)"><CODE>sync(long)</CODE></A>.
776<P>
777<DD><DL>
778</DL>
779</DD>
780<DD><DL>
781
782<DT><B>Throws:</B>
783<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>
784</DD>
785</DL>
786<HR>
787
788<A NAME="sync(long)"><!-- --></A><H3>
789sync</H3>
790<PRE>
791public void <B>sync</B>(long&nbsp;position)
792          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>
793<DL>
794<DD>Seek to the next sync mark past a given position.
795<P>
796<DD><DL>
797</DL>
798</DD>
799<DD><DL>
800
801<DT><B>Throws:</B>
802<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>
803</DD>
804</DL>
805<HR>
806
807<A NAME="syncSeen()"><!-- --></A><H3>
808syncSeen</H3>
809<PRE>
810public boolean <B>syncSeen</B>()</PRE>
811<DL>
812<DD>Returns true iff the previous call to next passed a sync mark.
813<P>
814<DD><DL>
815</DL>
816</DD>
817<DD><DL>
818</DL>
819</DD>
820</DL>
821<HR>
822
823<A NAME="getPosition()"><!-- --></A><H3>
824getPosition</H3>
825<PRE>
826public long <B>getPosition</B>()
827                 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>
828<DL>
829<DD>Return the current byte position in the input file.
830<P>
831<DD><DL>
832</DL>
833</DD>
834<DD><DL>
835
836<DT><B>Throws:</B>
837<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>
838</DD>
839</DL>
840<HR>
841
842<A NAME="toString()"><!-- --></A><H3>
843toString</H3>
844<PRE>
845public <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>toString</B>()</PRE>
846<DL>
847<DD>Returns the name of the file.
848<P>
849<DD><DL>
850<DT><B>Overrides:</B><DD><CODE><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></CODE> in class <CODE><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></CODE></DL>
851</DD>
852<DD><DL>
853</DL>
854</DD>
855</DL>
856<!-- ========= END OF CLASS DATA ========= -->
857<HR>
858
859
860<!-- ======= START OF BOTTOM NAVBAR ====== -->
861<A NAME="navbar_bottom"><!-- --></A>
862<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
863<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
864<TR>
865<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
866<A NAME="navbar_bottom_firstrow"><!-- --></A>
867<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
868  <TR ALIGN="center" VALIGN="top">
869  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
870  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
871  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
872  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/SequenceFile.Reader.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
873  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
874  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
875  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
876  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
877  </TR>
878</TABLE>
879</TD>
880<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
881</EM>
882</TD>
883</TR>
884
885<TR>
886<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
887&nbsp;<A HREF="../../../../org/apache/hadoop/io/SequenceFile.Metadata.html" title="class in org.apache.hadoop.io"><B>PREV CLASS</B></A>&nbsp;
888&nbsp;<A HREF="../../../../org/apache/hadoop/io/SequenceFile.Sorter.html" title="class in org.apache.hadoop.io"><B>NEXT CLASS</B></A></FONT></TD>
889<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
890  <A HREF="../../../../index.html?org/apache/hadoop/io/SequenceFile.Reader.html" target="_top"><B>FRAMES</B></A>  &nbsp;
891&nbsp;<A HREF="SequenceFile.Reader.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
892&nbsp;<SCRIPT type="text/javascript">
893  <!--
894  if(window==top) {
895    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
896  }
897  //-->
898</SCRIPT>
899<NOSCRIPT>
900  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
901</NOSCRIPT>
902
903
904</FONT></TD>
905</TR>
906<TR>
907<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
908  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
909<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
910DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
911</TR>
912</TABLE>
913<A NAME="skip-navbar_bottom"></A>
914<!-- ======== END OF BOTTOM NAVBAR ======= -->
915
916<HR>
917Copyright &copy; 2009 The Apache Software Foundation
918</BODY>
919</HTML>
Note: See TracBrowser for help on using the repository browser.