source: proiecte/HadoopJUnit/hadoop-0.20.1/docs/api/org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.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: 32.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:54 UTC 2009 -->
6<TITLE>
7TFile.Reader.Scanner (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="TFile.Reader.Scanner (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/TFile.Reader.Scanner.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/file/tfile/TFile.Reader.html" title="class in org.apache.hadoop.io.file.tfile"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html" title="class in org.apache.hadoop.io.file.tfile"><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/file/tfile/TFile.Reader.Scanner.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="TFile.Reader.Scanner.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;<A HREF="#nested_class_summary">NESTED</A>&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.file.tfile</FONT>
92<BR>
93Class TFile.Reader.Scanner</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.file.tfile.TFile.Reader.Scanner</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/file/tfile/TFile.Reader.html" title="class in org.apache.hadoop.io.file.tfile">TFile.Reader</A></DD>
103</DL>
104<HR>
105<DL>
106<DT><PRE>public static class <B>TFile.Reader.Scanner</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>
110The TFile Scanner. The Scanner has an implicit cursor, which, upon
111 creation, points to the first key-value pair in the scan range. If the
112 scan range is empty, the cursor will point to the end of the scan range.
113 <p>
114 Use <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html#atEnd()"><CODE>atEnd()</CODE></A> to test whether the cursor is at the end
115 location of the scanner.
116 <p>
117 Use <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html#advance()"><CODE>advance()</CODE></A> to move the cursor to the next key-value
118 pair (or end if none exists). Use seekTo methods (
119 <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html#seekTo(byte[])"><CODE>seekTo(byte[])</CODE></A> or
120 <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html#seekTo(byte[], int, int)"><CODE>seekTo(byte[], int, int)</CODE></A>) to seek to any arbitrary
121 location in the covered range (including backward seeking). Use
122 <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html#rewind()"><CODE>rewind()</CODE></A> to seek back to the beginning of the scanner.
123 Use <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html#seekToEnd()"><CODE>seekToEnd()</CODE></A> to seek to the end of the scanner.
124 <p>
125 Actual keys and values may be obtained through <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html" title="class in org.apache.hadoop.io.file.tfile"><CODE>TFile.Reader.Scanner.Entry</CODE></A>
126 object, which is obtained through <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html#entry()"><CODE>entry()</CODE></A>.
127<P>
128
129<P>
130<HR>
131
132<P>
133<!-- ======== NESTED CLASS SUMMARY ======== -->
134
135<A NAME="nested_class_summary"><!-- --></A>
136<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
137<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
138<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
139<B>Nested Class Summary</B></FONT></TH>
140</TR>
141<TR BGCOLOR="white" CLASS="TableRowColor">
142<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
143<CODE>&nbsp;class</CODE></FONT></TD>
144<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html" title="class in org.apache.hadoop.io.file.tfile">TFile.Reader.Scanner.Entry</A></B></CODE>
145
146<BR>
147&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Entry to a &lt;Key, Value&gt; pair.</TD>
148</TR>
149</TABLE>
150&nbsp;
151<!-- ======== CONSTRUCTOR SUMMARY ======== -->
152
153<A NAME="constructor_summary"><!-- --></A>
154<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
155<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
156<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
157<B>Constructor Summary</B></FONT></TH>
158</TR>
159<TR BGCOLOR="white" CLASS="TableRowColor">
160<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
161<CODE>protected </CODE></FONT></TD>
162<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html#TFile.Reader.Scanner(org.apache.hadoop.io.file.tfile.TFile.Reader, long, long)">TFile.Reader.Scanner</A></B>(<A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.html" title="class in org.apache.hadoop.io.file.tfile">TFile.Reader</A>&nbsp;reader,
163                     long&nbsp;offBegin,
164                     long&nbsp;offEnd)</CODE>
165
166<BR>
167&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor</TD>
168</TR>
169<TR BGCOLOR="white" CLASS="TableRowColor">
170<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
171<CODE>protected </CODE></FONT></TD>
172<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html#TFile.Reader.Scanner(org.apache.hadoop.io.file.tfile.TFile.Reader, org.apache.hadoop.io.file.tfile.RawComparable, org.apache.hadoop.io.file.tfile.RawComparable)">TFile.Reader.Scanner</A></B>(<A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.html" title="class in org.apache.hadoop.io.file.tfile">TFile.Reader</A>&nbsp;reader,
173                     <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/RawComparable.html" title="interface in org.apache.hadoop.io.file.tfile">RawComparable</A>&nbsp;beginKey,
174                     <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/RawComparable.html" title="interface in org.apache.hadoop.io.file.tfile">RawComparable</A>&nbsp;endKey)</CODE>
175
176<BR>
177&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor</TD>
178</TR>
179</TABLE>
180&nbsp;
181<!-- ========== METHOD SUMMARY =========== -->
182
183<A NAME="method_summary"><!-- --></A>
184<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
185<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
186<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
187<B>Method Summary</B></FONT></TH>
188</TR>
189<TR BGCOLOR="white" CLASS="TableRowColor">
190<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
191<CODE>&nbsp;boolean</CODE></FONT></TD>
192<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html#advance()">advance</A></B>()</CODE>
193
194<BR>
195&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Move the cursor to the next key-value pair.</TD>
196</TR>
197<TR BGCOLOR="white" CLASS="TableRowColor">
198<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
199<CODE>&nbsp;boolean</CODE></FONT></TD>
200<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html#atEnd()">atEnd</A></B>()</CODE>
201
202<BR>
203&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Is cursor at the end location?</TD>
204</TR>
205<TR BGCOLOR="white" CLASS="TableRowColor">
206<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
207<CODE>&nbsp;void</CODE></FONT></TD>
208<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html#close()">close</A></B>()</CODE>
209
210<BR>
211&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Close the scanner.</TD>
212</TR>
213<TR BGCOLOR="white" CLASS="TableRowColor">
214<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
215<CODE>&nbsp;<A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html" title="class in org.apache.hadoop.io.file.tfile">TFile.Reader.Scanner.Entry</A></CODE></FONT></TD>
216<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html#entry()">entry</A></B>()</CODE>
217
218<BR>
219&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get an entry to access the key and value.</TD>
220</TR>
221<TR BGCOLOR="white" CLASS="TableRowColor">
222<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
223<CODE>&nbsp;void</CODE></FONT></TD>
224<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html#lowerBound(byte[])">lowerBound</A></B>(byte[]&nbsp;key)</CODE>
225
226<BR>
227&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Move the cursor to the first entry whose key is greater than or equal
228 to the input key.</TD>
229</TR>
230<TR BGCOLOR="white" CLASS="TableRowColor">
231<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
232<CODE>&nbsp;void</CODE></FONT></TD>
233<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html#lowerBound(byte[], int, int)">lowerBound</A></B>(byte[]&nbsp;key,
234           int&nbsp;keyOffset,
235           int&nbsp;keyLen)</CODE>
236
237<BR>
238&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Move the cursor to the first entry whose key is greater than or equal
239 to the input key.</TD>
240</TR>
241<TR BGCOLOR="white" CLASS="TableRowColor">
242<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
243<CODE>&nbsp;void</CODE></FONT></TD>
244<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html#rewind()">rewind</A></B>()</CODE>
245
246<BR>
247&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Rewind to the first entry in the scanner.</TD>
248</TR>
249<TR BGCOLOR="white" CLASS="TableRowColor">
250<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
251<CODE>&nbsp;boolean</CODE></FONT></TD>
252<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html#seekTo(byte[])">seekTo</A></B>(byte[]&nbsp;key)</CODE>
253
254<BR>
255&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Move the cursor to the first entry whose key is greater than or equal
256 to the input key.</TD>
257</TR>
258<TR BGCOLOR="white" CLASS="TableRowColor">
259<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
260<CODE>&nbsp;boolean</CODE></FONT></TD>
261<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html#seekTo(byte[], int, int)">seekTo</A></B>(byte[]&nbsp;key,
262       int&nbsp;keyOffset,
263       int&nbsp;keyLen)</CODE>
264
265<BR>
266&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Move the cursor to the first entry whose key is greater than or equal
267 to the input key.</TD>
268</TR>
269<TR BGCOLOR="white" CLASS="TableRowColor">
270<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
271<CODE>&nbsp;void</CODE></FONT></TD>
272<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html#seekToEnd()">seekToEnd</A></B>()</CODE>
273
274<BR>
275&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Seek to the end of the scanner.</TD>
276</TR>
277<TR BGCOLOR="white" CLASS="TableRowColor">
278<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
279<CODE>&nbsp;void</CODE></FONT></TD>
280<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html#upperBound(byte[])">upperBound</A></B>(byte[]&nbsp;key)</CODE>
281
282<BR>
283&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Move the cursor to the first entry whose key is strictly greater than
284 the input key.</TD>
285</TR>
286<TR BGCOLOR="white" CLASS="TableRowColor">
287<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
288<CODE>&nbsp;void</CODE></FONT></TD>
289<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html#upperBound(byte[], int, int)">upperBound</A></B>(byte[]&nbsp;key,
290           int&nbsp;keyOffset,
291           int&nbsp;keyLen)</CODE>
292
293<BR>
294&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Move the cursor to the first entry whose key is strictly greater than
295 the input key.</TD>
296</TR>
297</TABLE>
298&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
299<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
300<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
301<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>
302</TR>
303<TR BGCOLOR="white" CLASS="TableRowColor">
304<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>
305</TR>
306</TABLE>
307&nbsp;
308<P>
309
310<!-- ========= CONSTRUCTOR DETAIL ======== -->
311
312<A NAME="constructor_detail"><!-- --></A>
313<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
314<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
315<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
316<B>Constructor Detail</B></FONT></TH>
317</TR>
318</TABLE>
319
320<A NAME="TFile.Reader.Scanner(org.apache.hadoop.io.file.tfile.TFile.Reader, long, long)"><!-- --></A><H3>
321TFile.Reader.Scanner</H3>
322<PRE>
323protected <B>TFile.Reader.Scanner</B>(<A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.html" title="class in org.apache.hadoop.io.file.tfile">TFile.Reader</A>&nbsp;reader,
324                               long&nbsp;offBegin,
325                               long&nbsp;offEnd)
326                        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>
327<DL>
328<DD>Constructor
329<P>
330<DL>
331<DT><B>Parameters:</B><DD><CODE>reader</CODE> - The TFile reader object.<DD><CODE>offBegin</CODE> - Begin byte-offset of the scan.<DD><CODE>offEnd</CODE> - End byte-offset of the scan.
332<DT><B>Throws:</B>
333<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> - The offsets will be rounded to the beginning of a compressed
334           block whose offset is greater than or equal to the specified
335           offset.</DL>
336</DL>
337<HR>
338
339<A NAME="TFile.Reader.Scanner(org.apache.hadoop.io.file.tfile.TFile.Reader, org.apache.hadoop.io.file.tfile.RawComparable, org.apache.hadoop.io.file.tfile.RawComparable)"><!-- --></A><H3>
340TFile.Reader.Scanner</H3>
341<PRE>
342protected <B>TFile.Reader.Scanner</B>(<A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.html" title="class in org.apache.hadoop.io.file.tfile">TFile.Reader</A>&nbsp;reader,
343                               <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/RawComparable.html" title="interface in org.apache.hadoop.io.file.tfile">RawComparable</A>&nbsp;beginKey,
344                               <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/RawComparable.html" title="interface in org.apache.hadoop.io.file.tfile">RawComparable</A>&nbsp;endKey)
345                        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>
346<DL>
347<DD>Constructor
348<P>
349<DL>
350<DT><B>Parameters:</B><DD><CODE>reader</CODE> - The TFile reader object.<DD><CODE>beginKey</CODE> - Begin key of the scan. If null, scan from the first <K,V>
351          entry of the TFile.<DD><CODE>endKey</CODE> - End key of the scan. If null, scan up to the last <K, V> entry
352          of the TFile.
353<DT><B>Throws:</B>
354<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>
355</DL>
356
357<!-- ============ METHOD DETAIL ========== -->
358
359<A NAME="method_detail"><!-- --></A>
360<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
361<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
362<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
363<B>Method Detail</B></FONT></TH>
364</TR>
365</TABLE>
366
367<A NAME="seekTo(byte[])"><!-- --></A><H3>
368seekTo</H3>
369<PRE>
370public boolean <B>seekTo</B>(byte[]&nbsp;key)
371               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>
372<DL>
373<DD>Move the cursor to the first entry whose key is greater than or equal
374 to the input key. Synonymous to seekTo(key, 0, key.length). The entry
375 returned by the previous entry() call will be invalid.
376<P>
377<DD><DL>
378</DL>
379</DD>
380<DD><DL>
381<DT><B>Parameters:</B><DD><CODE>key</CODE> - The input key
382<DT><B>Returns:</B><DD>true if we find an equal key.
383<DT><B>Throws:</B>
384<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>
385</DD>
386</DL>
387<HR>
388
389<A NAME="seekTo(byte[], int, int)"><!-- --></A><H3>
390seekTo</H3>
391<PRE>
392public boolean <B>seekTo</B>(byte[]&nbsp;key,
393                      int&nbsp;keyOffset,
394                      int&nbsp;keyLen)
395               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>
396<DL>
397<DD>Move the cursor to the first entry whose key is greater than or equal
398 to the input key. The entry returned by the previous entry() call will
399 be invalid.
400<P>
401<DD><DL>
402</DL>
403</DD>
404<DD><DL>
405<DT><B>Parameters:</B><DD><CODE>key</CODE> - The input key<DD><CODE>keyOffset</CODE> - offset in the key buffer.<DD><CODE>keyLen</CODE> - key buffer length.
406<DT><B>Returns:</B><DD>true if we find an equal key; false otherwise.
407<DT><B>Throws:</B>
408<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>
409</DD>
410</DL>
411<HR>
412
413<A NAME="rewind()"><!-- --></A><H3>
414rewind</H3>
415<PRE>
416public void <B>rewind</B>()
417            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>
418<DL>
419<DD>Rewind to the first entry in the scanner. The entry returned by the
420 previous entry() call will be invalid.
421<P>
422<DD><DL>
423</DL>
424</DD>
425<DD><DL>
426
427<DT><B>Throws:</B>
428<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>
429</DD>
430</DL>
431<HR>
432
433<A NAME="seekToEnd()"><!-- --></A><H3>
434seekToEnd</H3>
435<PRE>
436public void <B>seekToEnd</B>()
437               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>
438<DL>
439<DD>Seek to the end of the scanner. The entry returned by the previous
440 entry() call will be invalid.
441<P>
442<DD><DL>
443</DL>
444</DD>
445<DD><DL>
446
447<DT><B>Throws:</B>
448<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>
449</DD>
450</DL>
451<HR>
452
453<A NAME="lowerBound(byte[])"><!-- --></A><H3>
454lowerBound</H3>
455<PRE>
456public void <B>lowerBound</B>(byte[]&nbsp;key)
457                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>
458<DL>
459<DD>Move the cursor to the first entry whose key is greater than or equal
460 to the input key. Synonymous to lowerBound(key, 0, key.length). The
461 entry returned by the previous entry() call will be invalid.
462<P>
463<DD><DL>
464</DL>
465</DD>
466<DD><DL>
467<DT><B>Parameters:</B><DD><CODE>key</CODE> - The input key
468<DT><B>Throws:</B>
469<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>
470</DD>
471</DL>
472<HR>
473
474<A NAME="lowerBound(byte[], int, int)"><!-- --></A><H3>
475lowerBound</H3>
476<PRE>
477public void <B>lowerBound</B>(byte[]&nbsp;key,
478                       int&nbsp;keyOffset,
479                       int&nbsp;keyLen)
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>Move the cursor to the first entry whose key is greater than or equal
483 to the input key. The entry returned by the previous entry() call will
484 be invalid.
485<P>
486<DD><DL>
487</DL>
488</DD>
489<DD><DL>
490<DT><B>Parameters:</B><DD><CODE>key</CODE> - The input key<DD><CODE>keyOffset</CODE> - offset in the key buffer.<DD><CODE>keyLen</CODE> - key buffer length.
491<DT><B>Throws:</B>
492<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>
493</DD>
494</DL>
495<HR>
496
497<A NAME="upperBound(byte[])"><!-- --></A><H3>
498upperBound</H3>
499<PRE>
500public void <B>upperBound</B>(byte[]&nbsp;key)
501                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>
502<DL>
503<DD>Move the cursor to the first entry whose key is strictly greater than
504 the input key. Synonymous to upperBound(key, 0, key.length). The entry
505 returned by the previous entry() call will be invalid.
506<P>
507<DD><DL>
508</DL>
509</DD>
510<DD><DL>
511<DT><B>Parameters:</B><DD><CODE>key</CODE> - The input key
512<DT><B>Throws:</B>
513<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>
514</DD>
515</DL>
516<HR>
517
518<A NAME="upperBound(byte[], int, int)"><!-- --></A><H3>
519upperBound</H3>
520<PRE>
521public void <B>upperBound</B>(byte[]&nbsp;key,
522                       int&nbsp;keyOffset,
523                       int&nbsp;keyLen)
524                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>
525<DL>
526<DD>Move the cursor to the first entry whose key is strictly greater than
527 the input key. The entry returned by the previous entry() call will be
528 invalid.
529<P>
530<DD><DL>
531</DL>
532</DD>
533<DD><DL>
534<DT><B>Parameters:</B><DD><CODE>key</CODE> - The input key<DD><CODE>keyOffset</CODE> - offset in the key buffer.<DD><CODE>keyLen</CODE> - key buffer length.
535<DT><B>Throws:</B>
536<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>
537</DD>
538</DL>
539<HR>
540
541<A NAME="advance()"><!-- --></A><H3>
542advance</H3>
543<PRE>
544public boolean <B>advance</B>()
545                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>
546<DL>
547<DD>Move the cursor to the next key-value pair. The entry returned by the
548 previous entry() call will be invalid.
549<P>
550<DD><DL>
551</DL>
552</DD>
553<DD><DL>
554
555<DT><B>Returns:</B><DD>true if the cursor successfully moves. False when cursor is
556         already at the end location and cannot be advanced.
557<DT><B>Throws:</B>
558<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>
559</DD>
560</DL>
561<HR>
562
563<A NAME="close()"><!-- --></A><H3>
564close</H3>
565<PRE>
566public void <B>close</B>()
567           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>
568<DL>
569<DD>Close the scanner. Release all resources. The behavior of using the
570 scanner after calling close is not defined. The entry returned by the
571 previous entry() call will be invalid.
572<P>
573<DD><DL>
574<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>
575</DD>
576<DD><DL>
577
578<DT><B>Throws:</B>
579<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>
580</DD>
581</DL>
582<HR>
583
584<A NAME="atEnd()"><!-- --></A><H3>
585atEnd</H3>
586<PRE>
587public boolean <B>atEnd</B>()</PRE>
588<DL>
589<DD>Is cursor at the end location?
590<P>
591<DD><DL>
592</DL>
593</DD>
594<DD><DL>
595
596<DT><B>Returns:</B><DD>true if the cursor is at the end location.</DL>
597</DD>
598</DL>
599<HR>
600
601<A NAME="entry()"><!-- --></A><H3>
602entry</H3>
603<PRE>
604public <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html" title="class in org.apache.hadoop.io.file.tfile">TFile.Reader.Scanner.Entry</A> <B>entry</B>()
605                                 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>
606<DL>
607<DD>Get an entry to access the key and value.
608<P>
609<DD><DL>
610</DL>
611</DD>
612<DD><DL>
613
614<DT><B>Returns:</B><DD>The Entry object to access the key and value.
615<DT><B>Throws:</B>
616<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>
617</DD>
618</DL>
619<!-- ========= END OF CLASS DATA ========= -->
620<HR>
621
622
623<!-- ======= START OF BOTTOM NAVBAR ====== -->
624<A NAME="navbar_bottom"><!-- --></A>
625<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
626<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
627<TR>
628<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
629<A NAME="navbar_bottom_firstrow"><!-- --></A>
630<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
631  <TR ALIGN="center" VALIGN="top">
632  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
633  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
634  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
635  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/TFile.Reader.Scanner.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
636  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
637  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
638  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
639  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
640  </TR>
641</TABLE>
642</TD>
643<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
644</EM>
645</TD>
646</TR>
647
648<TR>
649<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
650&nbsp;<A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.html" title="class in org.apache.hadoop.io.file.tfile"><B>PREV CLASS</B></A>&nbsp;
651&nbsp;<A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html" title="class in org.apache.hadoop.io.file.tfile"><B>NEXT CLASS</B></A></FONT></TD>
652<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
653  <A HREF="../../../../../../index.html?org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html" target="_top"><B>FRAMES</B></A>  &nbsp;
654&nbsp;<A HREF="TFile.Reader.Scanner.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
655&nbsp;<SCRIPT type="text/javascript">
656  <!--
657  if(window==top) {
658    document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
659  }
660  //-->
661</SCRIPT>
662<NOSCRIPT>
663  <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
664</NOSCRIPT>
665
666
667</FONT></TD>
668</TR>
669<TR>
670<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
671  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
672<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
673DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
674</TR>
675</TABLE>
676<A NAME="skip-navbar_bottom"></A>
677<!-- ======== END OF BOTTOM NAVBAR ======= -->
678
679<HR>
680Copyright &copy; 2009 The Apache Software Foundation
681</BODY>
682</HTML>
Note: See TracBrowser for help on using the repository browser.