source: proiecte/HadoopJUnit/hadoop-0.20.1/docs/api/org/apache/hadoop/io/file/tfile/TFile.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: 35.4 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 (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 (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.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.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.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.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="TFile.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;<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</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</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.html" title="class in org.apache.hadoop.io.file.tfile">TFile</A></DD>
103</DL>
104<HR>
105<DL>
106<DT><PRE>public static class <B>TFile.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>
110TFile Reader. Users may only read TFiles by creating TFile.Reader.Scanner.
111 objects. A scanner may scan the whole TFile (<A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.html#createScanner()"><CODE>createScanner()</CODE></A>
112 ) , a portion of TFile based on byte offsets (
113 <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.html#createScanner(long, long)"><CODE>createScanner(long, long)</CODE></A>), or a portion of TFile with keys
114 fall in a certain key range (for sorted TFile only,
115 <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.html#createScanner(byte[], byte[])"><CODE>createScanner(byte[], byte[])</CODE></A> or
116 <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.html#createScanner(org.apache.hadoop.io.file.tfile.RawComparable, org.apache.hadoop.io.file.tfile.RawComparable)"><CODE>createScanner(RawComparable, RawComparable)</CODE></A>).
117<P>
118
119<P>
120<HR>
121
122<P>
123<!-- ======== NESTED CLASS SUMMARY ======== -->
124
125<A NAME="nested_class_summary"><!-- --></A>
126<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
127<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
128<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
129<B>Nested Class Summary</B></FONT></TH>
130</TR>
131<TR BGCOLOR="white" CLASS="TableRowColor">
132<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
133<CODE>static&nbsp;class</CODE></FONT></TD>
134<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html" title="class in org.apache.hadoop.io.file.tfile">TFile.Reader.Scanner</A></B></CODE>
135
136<BR>
137&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The TFile Scanner.</TD>
138</TR>
139</TABLE>
140&nbsp;
141<!-- ======== CONSTRUCTOR SUMMARY ======== -->
142
143<A NAME="constructor_summary"><!-- --></A>
144<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
145<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
146<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
147<B>Constructor Summary</B></FONT></TH>
148</TR>
149<TR BGCOLOR="white" CLASS="TableRowColor">
150<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.html#TFile.Reader(org.apache.hadoop.fs.FSDataInputStream, long, org.apache.hadoop.conf.Configuration)">TFile.Reader</A></B>(<A HREF="../../../../../../org/apache/hadoop/fs/FSDataInputStream.html" title="class in org.apache.hadoop.fs">FSDataInputStream</A>&nbsp;fsdis,
151             long&nbsp;fileLength,
152             <A HREF="../../../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</A>&nbsp;conf)</CODE>
153
154<BR>
155&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor</TD>
156</TR>
157</TABLE>
158&nbsp;
159<!-- ========== METHOD SUMMARY =========== -->
160
161<A NAME="method_summary"><!-- --></A>
162<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
163<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
164<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
165<B>Method Summary</B></FONT></TH>
166</TR>
167<TR BGCOLOR="white" CLASS="TableRowColor">
168<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
169<CODE>&nbsp;void</CODE></FONT></TD>
170<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.html#close()">close</A></B>()</CODE>
171
172<BR>
173&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Close the reader.</TD>
174</TR>
175<TR BGCOLOR="white" CLASS="TableRowColor">
176<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
177<CODE>&nbsp;<A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html" title="class in org.apache.hadoop.io.file.tfile">TFile.Reader.Scanner</A></CODE></FONT></TD>
178<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.html#createScanner()">createScanner</A></B>()</CODE>
179
180<BR>
181&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a scanner than can scan the whole TFile.</TD>
182</TR>
183<TR BGCOLOR="white" CLASS="TableRowColor">
184<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
185<CODE>&nbsp;<A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html" title="class in org.apache.hadoop.io.file.tfile">TFile.Reader.Scanner</A></CODE></FONT></TD>
186<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.html#createScanner(byte[], byte[])">createScanner</A></B>(byte[]&nbsp;beginKey,
187              byte[]&nbsp;endKey)</CODE>
188
189<BR>
190&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a scanner that covers a portion of TFile based on keys.</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="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html" title="class in org.apache.hadoop.io.file.tfile">TFile.Reader.Scanner</A></CODE></FONT></TD>
195<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.html#createScanner(long, long)">createScanner</A></B>(long&nbsp;offset,
196              long&nbsp;length)</CODE>
197
198<BR>
199&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a scanner that covers a portion of TFile based on byte offsets.</TD>
200</TR>
201<TR BGCOLOR="white" CLASS="TableRowColor">
202<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
203<CODE>&nbsp;<A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html" title="class in org.apache.hadoop.io.file.tfile">TFile.Reader.Scanner</A></CODE></FONT></TD>
204<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.html#createScanner(org.apache.hadoop.io.file.tfile.RawComparable, org.apache.hadoop.io.file.tfile.RawComparable)">createScanner</A></B>(<A HREF="../../../../../../org/apache/hadoop/io/file/tfile/RawComparable.html" title="interface in org.apache.hadoop.io.file.tfile">RawComparable</A>&nbsp;beginKey,
205              <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/RawComparable.html" title="interface in org.apache.hadoop.io.file.tfile">RawComparable</A>&nbsp;endKey)</CODE>
206
207<BR>
208&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a scanner that covers a specific key range.</TD>
209</TR>
210<TR BGCOLOR="white" CLASS="TableRowColor">
211<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
212<CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A>&lt;<A HREF="../../../../../../org/apache/hadoop/io/file/tfile/RawComparable.html" title="interface in org.apache.hadoop.io.file.tfile">RawComparable</A>&gt;</CODE></FONT></TD>
213<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.html#getComparator()">getComparator</A></B>()</CODE>
214
215<BR>
216&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get an instance of the RawComparator that is constructed based on the
217 string comparator representation.</TD>
218</TR>
219<TR BGCOLOR="white" CLASS="TableRowColor">
220<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
221<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>
222<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.html#getComparatorName()">getComparatorName</A></B>()</CODE>
223
224<BR>
225&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the string representation of the comparator.</TD>
226</TR>
227<TR BGCOLOR="white" CLASS="TableRowColor">
228<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
229<CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A>&lt;<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>&gt;</CODE></FONT></TD>
230<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.html#getEntryComparator()">getEntryComparator</A></B>()</CODE>
231
232<BR>
233&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a Comparator object to compare Entries.</TD>
234</TR>
235<TR BGCOLOR="white" CLASS="TableRowColor">
236<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
237<CODE>&nbsp;long</CODE></FONT></TD>
238<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.html#getEntryCount()">getEntryCount</A></B>()</CODE>
239
240<BR>
241&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the number of key-value pair entries in TFile.</TD>
242</TR>
243<TR BGCOLOR="white" CLASS="TableRowColor">
244<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
245<CODE>&nbsp;<A HREF="../../../../../../org/apache/hadoop/io/file/tfile/RawComparable.html" title="interface in org.apache.hadoop.io.file.tfile">RawComparable</A></CODE></FONT></TD>
246<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.html#getFirstKey()">getFirstKey</A></B>()</CODE>
247
248<BR>
249&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the first key in the TFile.</TD>
250</TR>
251<TR BGCOLOR="white" CLASS="TableRowColor">
252<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
253<CODE>&nbsp;<A HREF="../../../../../../org/apache/hadoop/io/file/tfile/RawComparable.html" title="interface in org.apache.hadoop.io.file.tfile">RawComparable</A></CODE></FONT></TD>
254<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.html#getKeyNear(long)">getKeyNear</A></B>(long&nbsp;offset)</CODE>
255
256<BR>
257&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a sample key that is within a block whose starting offset is greater
258 than or equal to the specified offset.</TD>
259</TR>
260<TR BGCOLOR="white" CLASS="TableRowColor">
261<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
262<CODE>&nbsp;<A HREF="../../../../../../org/apache/hadoop/io/file/tfile/RawComparable.html" title="interface in org.apache.hadoop.io.file.tfile">RawComparable</A></CODE></FONT></TD>
263<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.html#getLastKey()">getLastKey</A></B>()</CODE>
264
265<BR>
266&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the last key in the TFile.</TD>
267</TR>
268<TR BGCOLOR="white" CLASS="TableRowColor">
269<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
270<CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/io/DataInputStream.html?is-external=true" title="class or interface in java.io">DataInputStream</A></CODE></FONT></TD>
271<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.html#getMetaBlock(java.lang.String)">getMetaBlock</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name)</CODE>
272
273<BR>
274&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Stream access to a meta block.``</TD>
275</TR>
276<TR BGCOLOR="white" CLASS="TableRowColor">
277<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
278<CODE>&nbsp;boolean</CODE></FONT></TD>
279<TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.html#isSorted()">isSorted</A></B>()</CODE>
280
281<BR>
282&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Is the TFile sorted?</TD>
283</TR>
284</TABLE>
285&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
286<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
287<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
288<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>
289</TR>
290<TR BGCOLOR="white" CLASS="TableRowColor">
291<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>
292</TR>
293</TABLE>
294&nbsp;
295<P>
296
297<!-- ========= CONSTRUCTOR DETAIL ======== -->
298
299<A NAME="constructor_detail"><!-- --></A>
300<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
301<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
302<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
303<B>Constructor Detail</B></FONT></TH>
304</TR>
305</TABLE>
306
307<A NAME="TFile.Reader(org.apache.hadoop.fs.FSDataInputStream, long, org.apache.hadoop.conf.Configuration)"><!-- --></A><H3>
308TFile.Reader</H3>
309<PRE>
310public <B>TFile.Reader</B>(<A HREF="../../../../../../org/apache/hadoop/fs/FSDataInputStream.html" title="class in org.apache.hadoop.fs">FSDataInputStream</A>&nbsp;fsdis,
311                    long&nbsp;fileLength,
312                    <A HREF="../../../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</A>&nbsp;conf)
313             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>
314<DL>
315<DD>Constructor
316<P>
317<DL>
318<DT><B>Parameters:</B><DD><CODE>fsdis</CODE> - FS input stream of the TFile.<DD><CODE>fileLength</CODE> - The length of TFile. This is required because we have no easy
319          way of knowing the actual size of the input file through the
320          File input stream.<DD><CODE>conf</CODE> -
321<DT><B>Throws:</B>
322<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>
323</DL>
324
325<!-- ============ METHOD DETAIL ========== -->
326
327<A NAME="method_detail"><!-- --></A>
328<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
329<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
330<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
331<B>Method Detail</B></FONT></TH>
332</TR>
333</TABLE>
334
335<A NAME="close()"><!-- --></A><H3>
336close</H3>
337<PRE>
338public void <B>close</B>()
339           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>
340<DL>
341<DD>Close the reader. The state of the Reader object is undefined after
342 close. Calling close() for multiple times has no effect.
343<P>
344<DD><DL>
345<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>
346</DD>
347<DD><DL>
348
349<DT><B>Throws:</B>
350<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>
351</DD>
352</DL>
353<HR>
354
355<A NAME="getComparatorName()"><!-- --></A><H3>
356getComparatorName</H3>
357<PRE>
358public <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>getComparatorName</B>()</PRE>
359<DL>
360<DD>Get the string representation of the comparator.
361<P>
362<DD><DL>
363</DL>
364</DD>
365<DD><DL>
366
367<DT><B>Returns:</B><DD>If the TFile is not sorted by keys, an empty string will be
368         returned. Otherwise, the actual comparator string that is
369         provided during the TFile creation time will be returned.</DL>
370</DD>
371</DL>
372<HR>
373
374<A NAME="isSorted()"><!-- --></A><H3>
375isSorted</H3>
376<PRE>
377public boolean <B>isSorted</B>()</PRE>
378<DL>
379<DD>Is the TFile sorted?
380<P>
381<DD><DL>
382</DL>
383</DD>
384<DD><DL>
385
386<DT><B>Returns:</B><DD>true if TFile is sorted.</DL>
387</DD>
388</DL>
389<HR>
390
391<A NAME="getEntryCount()"><!-- --></A><H3>
392getEntryCount</H3>
393<PRE>
394public long <B>getEntryCount</B>()</PRE>
395<DL>
396<DD>Get the number of key-value pair entries in TFile.
397<P>
398<DD><DL>
399</DL>
400</DD>
401<DD><DL>
402
403<DT><B>Returns:</B><DD>the number of key-value pairs in TFile</DL>
404</DD>
405</DL>
406<HR>
407
408<A NAME="getFirstKey()"><!-- --></A><H3>
409getFirstKey</H3>
410<PRE>
411public <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/RawComparable.html" title="interface in org.apache.hadoop.io.file.tfile">RawComparable</A> <B>getFirstKey</B>()
412                          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>
413<DL>
414<DD>Get the first key in the TFile.
415<P>
416<DD><DL>
417</DL>
418</DD>
419<DD><DL>
420
421<DT><B>Returns:</B><DD>The first key in the TFile.
422<DT><B>Throws:</B>
423<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>
424</DD>
425</DL>
426<HR>
427
428<A NAME="getLastKey()"><!-- --></A><H3>
429getLastKey</H3>
430<PRE>
431public <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/RawComparable.html" title="interface in org.apache.hadoop.io.file.tfile">RawComparable</A> <B>getLastKey</B>()
432                         throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
433<DL>
434<DD>Get the last key in the TFile.
435<P>
436<DD><DL>
437</DL>
438</DD>
439<DD><DL>
440
441<DT><B>Returns:</B><DD>The last key in the TFile.
442<DT><B>Throws:</B>
443<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>
444</DD>
445</DL>
446<HR>
447
448<A NAME="getEntryComparator()"><!-- --></A><H3>
449getEntryComparator</H3>
450<PRE>
451public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A>&lt;<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>&gt; <B>getEntryComparator</B>()</PRE>
452<DL>
453<DD>Get a Comparator object to compare Entries. It is useful when you want
454 stores the entries in a collection (such as PriorityQueue) and perform
455 sorting or comparison among entries based on the keys without copying out
456 the key.
457<P>
458<DD><DL>
459</DL>
460</DD>
461<DD><DL>
462
463<DT><B>Returns:</B><DD>An Entry Comparator..</DL>
464</DD>
465</DL>
466<HR>
467
468<A NAME="getComparator()"><!-- --></A><H3>
469getComparator</H3>
470<PRE>
471public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A>&lt;<A HREF="../../../../../../org/apache/hadoop/io/file/tfile/RawComparable.html" title="interface in org.apache.hadoop.io.file.tfile">RawComparable</A>&gt; <B>getComparator</B>()</PRE>
472<DL>
473<DD>Get an instance of the RawComparator that is constructed based on the
474 string comparator representation.
475<P>
476<DD><DL>
477</DL>
478</DD>
479<DD><DL>
480
481<DT><B>Returns:</B><DD>a Comparator that can compare RawComparable's.</DL>
482</DD>
483</DL>
484<HR>
485
486<A NAME="getMetaBlock(java.lang.String)"><!-- --></A><H3>
487getMetaBlock</H3>
488<PRE>
489public <A HREF="http://java.sun.com/javase/6/docs/api/java/io/DataInputStream.html?is-external=true" title="class or interface in java.io">DataInputStream</A> <B>getMetaBlock</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name)
490                             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>,
491                                    <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/MetaBlockDoesNotExist.html" title="class in org.apache.hadoop.io.file.tfile">MetaBlockDoesNotExist</A></PRE>
492<DL>
493<DD>Stream access to a meta block.``
494<P>
495<DD><DL>
496</DL>
497</DD>
498<DD><DL>
499<DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of the meta block.
500<DT><B>Returns:</B><DD>The input stream.
501<DT><B>Throws:</B>
502<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> - on I/O error.
503<DD><CODE><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/MetaBlockDoesNotExist.html" title="class in org.apache.hadoop.io.file.tfile">MetaBlockDoesNotExist</A></CODE> - If the meta block with the name does not exist.</DL>
504</DD>
505</DL>
506<HR>
507
508<A NAME="getKeyNear(long)"><!-- --></A><H3>
509getKeyNear</H3>
510<PRE>
511public <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/RawComparable.html" title="interface in org.apache.hadoop.io.file.tfile">RawComparable</A> <B>getKeyNear</B>(long&nbsp;offset)
512                         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>
513<DL>
514<DD>Get a sample key that is within a block whose starting offset is greater
515 than or equal to the specified offset.
516<P>
517<DD><DL>
518</DL>
519</DD>
520<DD><DL>
521<DT><B>Parameters:</B><DD><CODE>offset</CODE> - The file offset.
522<DT><B>Returns:</B><DD>the key that fits the requirement; or null if no such key exists
523         (which could happen if the offset is close to the end of the
524         TFile).
525<DT><B>Throws:</B>
526<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>
527</DD>
528</DL>
529<HR>
530
531<A NAME="createScanner()"><!-- --></A><H3>
532createScanner</H3>
533<PRE>
534public <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html" title="class in org.apache.hadoop.io.file.tfile">TFile.Reader.Scanner</A> <B>createScanner</B>()
535                                   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>
536<DL>
537<DD>Get a scanner than can scan the whole TFile.
538<P>
539<DD><DL>
540</DL>
541</DD>
542<DD><DL>
543
544<DT><B>Returns:</B><DD>The scanner object. A valid Scanner is always returned even if
545         the TFile is empty.
546<DT><B>Throws:</B>
547<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>
548</DD>
549</DL>
550<HR>
551
552<A NAME="createScanner(long, long)"><!-- --></A><H3>
553createScanner</H3>
554<PRE>
555public <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html" title="class in org.apache.hadoop.io.file.tfile">TFile.Reader.Scanner</A> <B>createScanner</B>(long&nbsp;offset,
556                                          long&nbsp;length)
557                                   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>
558<DL>
559<DD>Get a scanner that covers a portion of TFile based on byte offsets.
560<P>
561<DD><DL>
562</DL>
563</DD>
564<DD><DL>
565<DT><B>Parameters:</B><DD><CODE>offset</CODE> - The beginning byte offset in the TFile.<DD><CODE>length</CODE> - The length of the region.
566<DT><B>Returns:</B><DD>The actual coverage of the returned scanner tries to match the
567         specified byte-region but always round up to the compression
568         block boundaries. It is possible that the returned scanner
569         contains zero key-value pairs even if length is positive.
570<DT><B>Throws:</B>
571<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>
572</DD>
573</DL>
574<HR>
575
576<A NAME="createScanner(byte[], byte[])"><!-- --></A><H3>
577createScanner</H3>
578<PRE>
579public <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html" title="class in org.apache.hadoop.io.file.tfile">TFile.Reader.Scanner</A> <B>createScanner</B>(byte[]&nbsp;beginKey,
580                                          byte[]&nbsp;endKey)
581                                   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>
582<DL>
583<DD>Get a scanner that covers a portion of TFile based on keys.
584<P>
585<DD><DL>
586</DL>
587</DD>
588<DD><DL>
589<DT><B>Parameters:</B><DD><CODE>beginKey</CODE> - Begin key of the scan (inclusive). If null, scan from the first
590          key-value entry of the TFile.<DD><CODE>endKey</CODE> - End key of the scan (exclusive). If null, scan up to the last
591          key-value entry of the TFile.
592<DT><B>Returns:</B><DD>The actual coverage of the returned scanner will cover all keys
593         greater than or equal to the beginKey and less than the endKey.
594<DT><B>Throws:</B>
595<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>
596</DD>
597</DL>
598<HR>
599
600<A NAME="createScanner(org.apache.hadoop.io.file.tfile.RawComparable, org.apache.hadoop.io.file.tfile.RawComparable)"><!-- --></A><H3>
601createScanner</H3>
602<PRE>
603public <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html" title="class in org.apache.hadoop.io.file.tfile">TFile.Reader.Scanner</A> <B>createScanner</B>(<A HREF="../../../../../../org/apache/hadoop/io/file/tfile/RawComparable.html" title="interface in org.apache.hadoop.io.file.tfile">RawComparable</A>&nbsp;beginKey,
604                                          <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/RawComparable.html" title="interface in org.apache.hadoop.io.file.tfile">RawComparable</A>&nbsp;endKey)
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 a scanner that covers a specific key range.
608<P>
609<DD><DL>
610</DL>
611</DD>
612<DD><DL>
613<DT><B>Parameters:</B><DD><CODE>beginKey</CODE> - Begin key of the scan (inclusive). If null, scan from the first
614          key-value entry of the TFile.<DD><CODE>endKey</CODE> - End key of the scan (exclusive). If null, scan up to the last
615          key-value entry of the TFile.
616<DT><B>Returns:</B><DD>The actual coverage of the returned scanner will cover all keys
617         greater than or equal to the beginKey and less than the endKey.
618<DT><B>Throws:</B>
619<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>
620</DD>
621</DL>
622<!-- ========= END OF CLASS DATA ========= -->
623<HR>
624
625
626<!-- ======= START OF BOTTOM NAVBAR ====== -->
627<A NAME="navbar_bottom"><!-- --></A>
628<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
629<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
630<TR>
631<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
632<A NAME="navbar_bottom_firstrow"><!-- --></A>
633<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
634  <TR ALIGN="center" VALIGN="top">
635  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
636  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
637  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
638  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/TFile.Reader.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
639  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
640  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
641  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
642  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
643  </TR>
644</TABLE>
645</TD>
646<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
647</EM>
648</TD>
649</TR>
650
651<TR>
652<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
653&nbsp;<A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.html" title="class in org.apache.hadoop.io.file.tfile"><B>PREV CLASS</B></A>&nbsp;
654&nbsp;<A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html" title="class in org.apache.hadoop.io.file.tfile"><B>NEXT CLASS</B></A></FONT></TD>
655<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
656  <A HREF="../../../../../../index.html?org/apache/hadoop/io/file/tfile/TFile.Reader.html" target="_top"><B>FRAMES</B></A>  &nbsp;
657&nbsp;<A HREF="TFile.Reader.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
658&nbsp;<SCRIPT type="text/javascript">
659  <!--
660  if(window==top) {
661    document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
662  }
663  //-->
664</SCRIPT>
665<NOSCRIPT>
666  <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
667</NOSCRIPT>
668
669
670</FONT></TD>
671</TR>
672<TR>
673<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
674  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>
675<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
676DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
677</TR>
678</TABLE>
679<A NAME="skip-navbar_bottom"></A>
680<!-- ======== END OF BOTTOM NAVBAR ======= -->
681
682<HR>
683Copyright &copy; 2009 The Apache Software Foundation
684</BODY>
685</HTML>
Note: See TracBrowser for help on using the repository browser.