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> |
---|
7 | TFile.Reader.Scanner.Entry (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"> |
---|
15 | function windowTitle() |
---|
16 | { |
---|
17 | if (location.href.indexOf('is-external=true') == -1) { |
---|
18 | parent.document.title="TFile.Reader.Scanner.Entry (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> </TD> |
---|
41 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
42 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
43 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/TFile.Reader.Scanner.Entry.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
---|
44 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
45 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
46 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
---|
47 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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 | <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html" title="class in org.apache.hadoop.io.file.tfile"><B>PREV CLASS</B></A> |
---|
59 | <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Writer.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.Entry.html" target="_top"><B>FRAMES</B></A> |
---|
62 | <A HREF="TFile.Reader.Scanner.Entry.html" target="_top"><B>NO FRAMES</B></A> |
---|
63 | <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: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
80 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
81 | DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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"> |
---|
91 | org.apache.hadoop.io.file.tfile</FONT> |
---|
92 | <BR> |
---|
93 | Class TFile.Reader.Scanner.Entry</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.Entry</B> |
---|
97 | </PRE> |
---|
98 | <DL> |
---|
99 | <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A><<A HREF="../../../../../../org/apache/hadoop/io/file/tfile/RawComparable.html" title="interface in org.apache.hadoop.io.file.tfile">RawComparable</A>></DD> |
---|
100 | </DL> |
---|
101 | <DL> |
---|
102 | <DT><B>Enclosing class:</B><DD><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></DD> |
---|
103 | </DL> |
---|
104 | <HR> |
---|
105 | <DL> |
---|
106 | <DT><PRE>public class <B>TFile.Reader.Scanner.Entry</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/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A><<A HREF="../../../../../../org/apache/hadoop/io/file/tfile/RawComparable.html" title="interface in org.apache.hadoop.io.file.tfile">RawComparable</A>></DL> |
---|
107 | </PRE> |
---|
108 | |
---|
109 | <P> |
---|
110 | Entry to a <Key, Value> pair. |
---|
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/file/tfile/TFile.Reader.Scanner.Entry.html#TFile.Reader.Scanner.Entry()">TFile.Reader.Scanner.Entry</A></B>()</CODE> |
---|
128 | |
---|
129 | <BR> |
---|
130 | </TD> |
---|
131 | </TR> |
---|
132 | </TABLE> |
---|
133 | |
---|
134 | <!-- ========== METHOD SUMMARY =========== --> |
---|
135 | |
---|
136 | <A NAME="method_summary"><!-- --></A> |
---|
137 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
138 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
139 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
140 | <B>Method Summary</B></FONT></TH> |
---|
141 | </TR> |
---|
142 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
143 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
144 | <CODE> int</CODE></FONT></TD> |
---|
145 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html#compareTo(byte[])">compareTo</A></B>(byte[] buf)</CODE> |
---|
146 | |
---|
147 | <BR> |
---|
148 | Compare the entry key to another key.</TD> |
---|
149 | </TR> |
---|
150 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
151 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
152 | <CODE> int</CODE></FONT></TD> |
---|
153 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html#compareTo(byte[], int, int)">compareTo</A></B>(byte[] buf, |
---|
154 | int offset, |
---|
155 | int length)</CODE> |
---|
156 | |
---|
157 | <BR> |
---|
158 | Compare the entry key to another key.</TD> |
---|
159 | </TR> |
---|
160 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
161 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
162 | <CODE> int</CODE></FONT></TD> |
---|
163 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html#compareTo(org.apache.hadoop.io.file.tfile.RawComparable)">compareTo</A></B>(<A HREF="../../../../../../org/apache/hadoop/io/file/tfile/RawComparable.html" title="interface in org.apache.hadoop.io.file.tfile">RawComparable</A> key)</CODE> |
---|
164 | |
---|
165 | <BR> |
---|
166 | Compare an entry with a RawComparable object.</TD> |
---|
167 | </TR> |
---|
168 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
169 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
170 | <CODE> boolean</CODE></FONT></TD> |
---|
171 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html#equals(java.lang.Object)">equals</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> other)</CODE> |
---|
172 | |
---|
173 | <BR> |
---|
174 | Compare whether this and other points to the same key value.</TD> |
---|
175 | </TR> |
---|
176 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
177 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
178 | <CODE> void</CODE></FONT></TD> |
---|
179 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html#get(org.apache.hadoop.io.BytesWritable, org.apache.hadoop.io.BytesWritable)">get</A></B>(<A HREF="../../../../../../org/apache/hadoop/io/BytesWritable.html" title="class in org.apache.hadoop.io">BytesWritable</A> key, |
---|
180 | <A HREF="../../../../../../org/apache/hadoop/io/BytesWritable.html" title="class in org.apache.hadoop.io">BytesWritable</A> value)</CODE> |
---|
181 | |
---|
182 | <BR> |
---|
183 | Copy the key and value in one shot into BytesWritables.</TD> |
---|
184 | </TR> |
---|
185 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
186 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
187 | <CODE> int</CODE></FONT></TD> |
---|
188 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html#getKey(byte[])">getKey</A></B>(byte[] buf)</CODE> |
---|
189 | |
---|
190 | <BR> |
---|
191 | Copy the key into user supplied buffer.</TD> |
---|
192 | </TR> |
---|
193 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
194 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
195 | <CODE> int</CODE></FONT></TD> |
---|
196 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html#getKey(byte[], int)">getKey</A></B>(byte[] buf, |
---|
197 | int offset)</CODE> |
---|
198 | |
---|
199 | <BR> |
---|
200 | Copy the key into user supplied buffer.</TD> |
---|
201 | </TR> |
---|
202 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
203 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
204 | <CODE> int</CODE></FONT></TD> |
---|
205 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html#getKey(org.apache.hadoop.io.BytesWritable)">getKey</A></B>(<A HREF="../../../../../../org/apache/hadoop/io/BytesWritable.html" title="class in org.apache.hadoop.io">BytesWritable</A> key)</CODE> |
---|
206 | |
---|
207 | <BR> |
---|
208 | Copy the key into BytesWritable.</TD> |
---|
209 | </TR> |
---|
210 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
211 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
212 | <CODE> int</CODE></FONT></TD> |
---|
213 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html#getKeyLength()">getKeyLength</A></B>()</CODE> |
---|
214 | |
---|
215 | <BR> |
---|
216 | Get the length of the key.</TD> |
---|
217 | </TR> |
---|
218 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
219 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
220 | <CODE> <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> |
---|
221 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html#getKeyStream()">getKeyStream</A></B>()</CODE> |
---|
222 | |
---|
223 | <BR> |
---|
224 | Streaming access to the key.</TD> |
---|
225 | </TR> |
---|
226 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
227 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
228 | <CODE> int</CODE></FONT></TD> |
---|
229 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html#getValue(byte[])">getValue</A></B>(byte[] buf)</CODE> |
---|
230 | |
---|
231 | <BR> |
---|
232 | Copy value into user-supplied buffer.</TD> |
---|
233 | </TR> |
---|
234 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
235 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
236 | <CODE> int</CODE></FONT></TD> |
---|
237 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html#getValue(byte[], int)">getValue</A></B>(byte[] buf, |
---|
238 | int offset)</CODE> |
---|
239 | |
---|
240 | <BR> |
---|
241 | Copy value into user-supplied buffer.</TD> |
---|
242 | </TR> |
---|
243 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
244 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
245 | <CODE> long</CODE></FONT></TD> |
---|
246 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html#getValue(org.apache.hadoop.io.BytesWritable)">getValue</A></B>(<A HREF="../../../../../../org/apache/hadoop/io/BytesWritable.html" title="class in org.apache.hadoop.io">BytesWritable</A> value)</CODE> |
---|
247 | |
---|
248 | <BR> |
---|
249 | Copy the value into BytesWritable.</TD> |
---|
250 | </TR> |
---|
251 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
252 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
253 | <CODE> int</CODE></FONT></TD> |
---|
254 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html#getValueLength()">getValueLength</A></B>()</CODE> |
---|
255 | |
---|
256 | <BR> |
---|
257 | Get the length of the value.</TD> |
---|
258 | </TR> |
---|
259 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
260 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
261 | <CODE> <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> |
---|
262 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html#getValueStream()">getValueStream</A></B>()</CODE> |
---|
263 | |
---|
264 | <BR> |
---|
265 | Stream access to value.</TD> |
---|
266 | </TR> |
---|
267 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
268 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
269 | <CODE> int</CODE></FONT></TD> |
---|
270 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html#hashCode()">hashCode</A></B>()</CODE> |
---|
271 | |
---|
272 | <BR> |
---|
273 | </TD> |
---|
274 | </TR> |
---|
275 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
276 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
277 | <CODE> boolean</CODE></FONT></TD> |
---|
278 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html#isValueLengthKnown()">isValueLengthKnown</A></B>()</CODE> |
---|
279 | |
---|
280 | <BR> |
---|
281 | Check whether it is safe to call getValueLength().</TD> |
---|
282 | </TR> |
---|
283 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
284 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
285 | <CODE> int</CODE></FONT></TD> |
---|
286 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html#writeKey(java.io.OutputStream)">writeKey</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> out)</CODE> |
---|
287 | |
---|
288 | <BR> |
---|
289 | Writing the key to the output stream.</TD> |
---|
290 | </TR> |
---|
291 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
292 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
293 | <CODE> long</CODE></FONT></TD> |
---|
294 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html#writeValue(java.io.OutputStream)">writeValue</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> out)</CODE> |
---|
295 | |
---|
296 | <BR> |
---|
297 | Writing the value to the output stream.</TD> |
---|
298 | </TR> |
---|
299 | </TABLE> |
---|
300 | <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
---|
301 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
302 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
---|
303 | <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> |
---|
304 | </TR> |
---|
305 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
306 | <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#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#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> |
---|
307 | </TR> |
---|
308 | </TABLE> |
---|
309 | |
---|
310 | <P> |
---|
311 | |
---|
312 | <!-- ========= CONSTRUCTOR DETAIL ======== --> |
---|
313 | |
---|
314 | <A NAME="constructor_detail"><!-- --></A> |
---|
315 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
316 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
317 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
318 | <B>Constructor Detail</B></FONT></TH> |
---|
319 | </TR> |
---|
320 | </TABLE> |
---|
321 | |
---|
322 | <A NAME="TFile.Reader.Scanner.Entry()"><!-- --></A><H3> |
---|
323 | TFile.Reader.Scanner.Entry</H3> |
---|
324 | <PRE> |
---|
325 | public <B>TFile.Reader.Scanner.Entry</B>()</PRE> |
---|
326 | <DL> |
---|
327 | </DL> |
---|
328 | |
---|
329 | <!-- ============ METHOD DETAIL ========== --> |
---|
330 | |
---|
331 | <A NAME="method_detail"><!-- --></A> |
---|
332 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
333 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
334 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
335 | <B>Method Detail</B></FONT></TH> |
---|
336 | </TR> |
---|
337 | </TABLE> |
---|
338 | |
---|
339 | <A NAME="getKeyLength()"><!-- --></A><H3> |
---|
340 | getKeyLength</H3> |
---|
341 | <PRE> |
---|
342 | public int <B>getKeyLength</B>()</PRE> |
---|
343 | <DL> |
---|
344 | <DD>Get the length of the key. |
---|
345 | <P> |
---|
346 | <DD><DL> |
---|
347 | </DL> |
---|
348 | </DD> |
---|
349 | <DD><DL> |
---|
350 | |
---|
351 | <DT><B>Returns:</B><DD>the length of the key.</DL> |
---|
352 | </DD> |
---|
353 | </DL> |
---|
354 | <HR> |
---|
355 | |
---|
356 | <A NAME="get(org.apache.hadoop.io.BytesWritable, org.apache.hadoop.io.BytesWritable)"><!-- --></A><H3> |
---|
357 | get</H3> |
---|
358 | <PRE> |
---|
359 | public void <B>get</B>(<A HREF="../../../../../../org/apache/hadoop/io/BytesWritable.html" title="class in org.apache.hadoop.io">BytesWritable</A> key, |
---|
360 | <A HREF="../../../../../../org/apache/hadoop/io/BytesWritable.html" title="class in org.apache.hadoop.io">BytesWritable</A> value) |
---|
361 | 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> |
---|
362 | <DL> |
---|
363 | <DD>Copy the key and value in one shot into BytesWritables. This is |
---|
364 | equivalent to getKey(key); getValue(value); |
---|
365 | <P> |
---|
366 | <DD><DL> |
---|
367 | </DL> |
---|
368 | </DD> |
---|
369 | <DD><DL> |
---|
370 | <DT><B>Parameters:</B><DD><CODE>key</CODE> - BytesWritable to hold key.<DD><CODE>value</CODE> - BytesWritable to hold value |
---|
371 | <DT><B>Throws:</B> |
---|
372 | <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> |
---|
373 | </DD> |
---|
374 | </DL> |
---|
375 | <HR> |
---|
376 | |
---|
377 | <A NAME="getKey(org.apache.hadoop.io.BytesWritable)"><!-- --></A><H3> |
---|
378 | getKey</H3> |
---|
379 | <PRE> |
---|
380 | public int <B>getKey</B>(<A HREF="../../../../../../org/apache/hadoop/io/BytesWritable.html" title="class in org.apache.hadoop.io">BytesWritable</A> key) |
---|
381 | 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> |
---|
382 | <DL> |
---|
383 | <DD>Copy the key into BytesWritable. The input BytesWritable will be |
---|
384 | automatically resized to the actual key size. |
---|
385 | <P> |
---|
386 | <DD><DL> |
---|
387 | </DL> |
---|
388 | </DD> |
---|
389 | <DD><DL> |
---|
390 | <DT><B>Parameters:</B><DD><CODE>key</CODE> - BytesWritable to hold the key. |
---|
391 | <DT><B>Throws:</B> |
---|
392 | <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> |
---|
393 | </DD> |
---|
394 | </DL> |
---|
395 | <HR> |
---|
396 | |
---|
397 | <A NAME="getValue(org.apache.hadoop.io.BytesWritable)"><!-- --></A><H3> |
---|
398 | getValue</H3> |
---|
399 | <PRE> |
---|
400 | public long <B>getValue</B>(<A HREF="../../../../../../org/apache/hadoop/io/BytesWritable.html" title="class in org.apache.hadoop.io">BytesWritable</A> value) |
---|
401 | 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> |
---|
402 | <DL> |
---|
403 | <DD>Copy the value into BytesWritable. The input BytesWritable will be |
---|
404 | automatically resized to the actual value size. The implementation |
---|
405 | directly uses the buffer inside BytesWritable for storing the value. |
---|
406 | The call does not require the value length to be known. |
---|
407 | <P> |
---|
408 | <DD><DL> |
---|
409 | </DL> |
---|
410 | </DD> |
---|
411 | <DD><DL> |
---|
412 | <DT><B>Parameters:</B><DD><CODE>value</CODE> - |
---|
413 | <DT><B>Throws:</B> |
---|
414 | <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> |
---|
415 | </DD> |
---|
416 | </DL> |
---|
417 | <HR> |
---|
418 | |
---|
419 | <A NAME="writeKey(java.io.OutputStream)"><!-- --></A><H3> |
---|
420 | writeKey</H3> |
---|
421 | <PRE> |
---|
422 | public int <B>writeKey</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> out) |
---|
423 | 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> |
---|
424 | <DL> |
---|
425 | <DD>Writing the key to the output stream. This method avoids copying key |
---|
426 | buffer from Scanner into user buffer, then writing to the output |
---|
427 | stream. |
---|
428 | <P> |
---|
429 | <DD><DL> |
---|
430 | </DL> |
---|
431 | </DD> |
---|
432 | <DD><DL> |
---|
433 | <DT><B>Parameters:</B><DD><CODE>out</CODE> - The output stream |
---|
434 | <DT><B>Returns:</B><DD>the length of the key. |
---|
435 | <DT><B>Throws:</B> |
---|
436 | <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> |
---|
437 | </DD> |
---|
438 | </DL> |
---|
439 | <HR> |
---|
440 | |
---|
441 | <A NAME="writeValue(java.io.OutputStream)"><!-- --></A><H3> |
---|
442 | writeValue</H3> |
---|
443 | <PRE> |
---|
444 | public long <B>writeValue</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> out) |
---|
445 | 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> |
---|
446 | <DL> |
---|
447 | <DD>Writing the value to the output stream. This method avoids copying |
---|
448 | value data from Scanner into user buffer, then writing to the output |
---|
449 | stream. It does not require the value length to be known. |
---|
450 | <P> |
---|
451 | <DD><DL> |
---|
452 | </DL> |
---|
453 | </DD> |
---|
454 | <DD><DL> |
---|
455 | <DT><B>Parameters:</B><DD><CODE>out</CODE> - The output stream |
---|
456 | <DT><B>Returns:</B><DD>the length of the value |
---|
457 | <DT><B>Throws:</B> |
---|
458 | <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> |
---|
459 | </DD> |
---|
460 | </DL> |
---|
461 | <HR> |
---|
462 | |
---|
463 | <A NAME="getKey(byte[])"><!-- --></A><H3> |
---|
464 | getKey</H3> |
---|
465 | <PRE> |
---|
466 | public int <B>getKey</B>(byte[] buf) |
---|
467 | 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> |
---|
468 | <DL> |
---|
469 | <DD>Copy the key into user supplied buffer. |
---|
470 | <P> |
---|
471 | <DD><DL> |
---|
472 | </DL> |
---|
473 | </DD> |
---|
474 | <DD><DL> |
---|
475 | <DT><B>Parameters:</B><DD><CODE>buf</CODE> - The buffer supplied by user. The length of the buffer must |
---|
476 | not be shorter than the key length. |
---|
477 | <DT><B>Returns:</B><DD>The length of the key. |
---|
478 | <DT><B>Throws:</B> |
---|
479 | <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> |
---|
480 | </DD> |
---|
481 | </DL> |
---|
482 | <HR> |
---|
483 | |
---|
484 | <A NAME="getKey(byte[], int)"><!-- --></A><H3> |
---|
485 | getKey</H3> |
---|
486 | <PRE> |
---|
487 | public int <B>getKey</B>(byte[] buf, |
---|
488 | int offset) |
---|
489 | 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> |
---|
490 | <DL> |
---|
491 | <DD>Copy the key into user supplied buffer. |
---|
492 | <P> |
---|
493 | <DD><DL> |
---|
494 | </DL> |
---|
495 | </DD> |
---|
496 | <DD><DL> |
---|
497 | <DT><B>Parameters:</B><DD><CODE>buf</CODE> - The buffer supplied by user.<DD><CODE>offset</CODE> - The starting offset of the user buffer where we should copy |
---|
498 | the key into. Requiring the key-length + offset no greater |
---|
499 | than the buffer length. |
---|
500 | <DT><B>Returns:</B><DD>The length of the key. |
---|
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></DL> |
---|
503 | </DD> |
---|
504 | </DL> |
---|
505 | <HR> |
---|
506 | |
---|
507 | <A NAME="getKeyStream()"><!-- --></A><H3> |
---|
508 | getKeyStream</H3> |
---|
509 | <PRE> |
---|
510 | public <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>getKeyStream</B>()</PRE> |
---|
511 | <DL> |
---|
512 | <DD>Streaming access to the key. Useful for desrializing the key into |
---|
513 | user objects. |
---|
514 | <P> |
---|
515 | <DD><DL> |
---|
516 | </DL> |
---|
517 | </DD> |
---|
518 | <DD><DL> |
---|
519 | |
---|
520 | <DT><B>Returns:</B><DD>The input stream.</DL> |
---|
521 | </DD> |
---|
522 | </DL> |
---|
523 | <HR> |
---|
524 | |
---|
525 | <A NAME="getValueLength()"><!-- --></A><H3> |
---|
526 | getValueLength</H3> |
---|
527 | <PRE> |
---|
528 | public int <B>getValueLength</B>()</PRE> |
---|
529 | <DL> |
---|
530 | <DD>Get the length of the value. isValueLengthKnown() must be tested |
---|
531 | true. |
---|
532 | <P> |
---|
533 | <DD><DL> |
---|
534 | </DL> |
---|
535 | </DD> |
---|
536 | <DD><DL> |
---|
537 | |
---|
538 | <DT><B>Returns:</B><DD>the length of the value.</DL> |
---|
539 | </DD> |
---|
540 | </DL> |
---|
541 | <HR> |
---|
542 | |
---|
543 | <A NAME="getValue(byte[])"><!-- --></A><H3> |
---|
544 | getValue</H3> |
---|
545 | <PRE> |
---|
546 | public int <B>getValue</B>(byte[] buf) |
---|
547 | 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> |
---|
548 | <DL> |
---|
549 | <DD>Copy value into user-supplied buffer. User supplied buffer must be |
---|
550 | large enough to hold the whole value. The value part of the key-value |
---|
551 | pair pointed by the current cursor is not cached and can only be |
---|
552 | examined once. Calling any of the following functions more than once |
---|
553 | without moving the cursor will result in exception: |
---|
554 | <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html#getValue(byte[])"><CODE>getValue(byte[])</CODE></A>, <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html#getValue(byte[], int)"><CODE>getValue(byte[], int)</CODE></A>, |
---|
555 | <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html#getValueStream()"><CODE>getValueStream()</CODE></A>. |
---|
556 | <P> |
---|
557 | <DD><DL> |
---|
558 | </DL> |
---|
559 | </DD> |
---|
560 | <DD><DL> |
---|
561 | |
---|
562 | <DT><B>Returns:</B><DD>the length of the value. Does not require |
---|
563 | isValueLengthKnown() to be true. |
---|
564 | <DT><B>Throws:</B> |
---|
565 | <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> |
---|
566 | </DD> |
---|
567 | </DL> |
---|
568 | <HR> |
---|
569 | |
---|
570 | <A NAME="getValue(byte[], int)"><!-- --></A><H3> |
---|
571 | getValue</H3> |
---|
572 | <PRE> |
---|
573 | public int <B>getValue</B>(byte[] buf, |
---|
574 | int offset) |
---|
575 | 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> |
---|
576 | <DL> |
---|
577 | <DD>Copy value into user-supplied buffer. User supplied buffer must be |
---|
578 | large enough to hold the whole value (starting from the offset). The |
---|
579 | value part of the key-value pair pointed by the current cursor is not |
---|
580 | cached and can only be examined once. Calling any of the following |
---|
581 | functions more than once without moving the cursor will result in |
---|
582 | exception: <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html#getValue(byte[])"><CODE>getValue(byte[])</CODE></A>, <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html#getValue(byte[], int)"><CODE>getValue(byte[], int)</CODE></A>, |
---|
583 | <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html#getValueStream()"><CODE>getValueStream()</CODE></A>. |
---|
584 | <P> |
---|
585 | <DD><DL> |
---|
586 | </DL> |
---|
587 | </DD> |
---|
588 | <DD><DL> |
---|
589 | |
---|
590 | <DT><B>Returns:</B><DD>the length of the value. Does not require |
---|
591 | isValueLengthKnown() to be true. |
---|
592 | <DT><B>Throws:</B> |
---|
593 | <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> |
---|
594 | </DD> |
---|
595 | </DL> |
---|
596 | <HR> |
---|
597 | |
---|
598 | <A NAME="getValueStream()"><!-- --></A><H3> |
---|
599 | getValueStream</H3> |
---|
600 | <PRE> |
---|
601 | public <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>getValueStream</B>() |
---|
602 | 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> |
---|
603 | <DL> |
---|
604 | <DD>Stream access to value. The value part of the key-value pair pointed |
---|
605 | by the current cursor is not cached and can only be examined once. |
---|
606 | Calling any of the following functions more than once without moving |
---|
607 | the cursor will result in exception: <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html#getValue(byte[])"><CODE>getValue(byte[])</CODE></A>, |
---|
608 | <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html#getValue(byte[], int)"><CODE>getValue(byte[], int)</CODE></A>, <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html#getValueStream()"><CODE>getValueStream()</CODE></A>. |
---|
609 | <P> |
---|
610 | <DD><DL> |
---|
611 | </DL> |
---|
612 | </DD> |
---|
613 | <DD><DL> |
---|
614 | |
---|
615 | <DT><B>Returns:</B><DD>The input stream for reading the value. |
---|
616 | <DT><B>Throws:</B> |
---|
617 | <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> |
---|
618 | </DD> |
---|
619 | </DL> |
---|
620 | <HR> |
---|
621 | |
---|
622 | <A NAME="isValueLengthKnown()"><!-- --></A><H3> |
---|
623 | isValueLengthKnown</H3> |
---|
624 | <PRE> |
---|
625 | public boolean <B>isValueLengthKnown</B>()</PRE> |
---|
626 | <DL> |
---|
627 | <DD>Check whether it is safe to call getValueLength(). |
---|
628 | <P> |
---|
629 | <DD><DL> |
---|
630 | </DL> |
---|
631 | </DD> |
---|
632 | <DD><DL> |
---|
633 | |
---|
634 | <DT><B>Returns:</B><DD>true if value length is known before hand. Values less than |
---|
635 | the chunk size will always have their lengths known before |
---|
636 | hand. Values that are written out as a whole (with advertised |
---|
637 | length up-front) will always have their lengths known in |
---|
638 | read.</DL> |
---|
639 | </DD> |
---|
640 | </DL> |
---|
641 | <HR> |
---|
642 | |
---|
643 | <A NAME="compareTo(byte[])"><!-- --></A><H3> |
---|
644 | compareTo</H3> |
---|
645 | <PRE> |
---|
646 | public int <B>compareTo</B>(byte[] buf)</PRE> |
---|
647 | <DL> |
---|
648 | <DD>Compare the entry key to another key. Synonymous to compareTo(key, 0, |
---|
649 | key.length). |
---|
650 | <P> |
---|
651 | <DD><DL> |
---|
652 | </DL> |
---|
653 | </DD> |
---|
654 | <DD><DL> |
---|
655 | <DT><B>Parameters:</B><DD><CODE>buf</CODE> - The key buffer. |
---|
656 | <DT><B>Returns:</B><DD>comparison result between the entry key with the input key.</DL> |
---|
657 | </DD> |
---|
658 | </DL> |
---|
659 | <HR> |
---|
660 | |
---|
661 | <A NAME="compareTo(byte[], int, int)"><!-- --></A><H3> |
---|
662 | compareTo</H3> |
---|
663 | <PRE> |
---|
664 | public int <B>compareTo</B>(byte[] buf, |
---|
665 | int offset, |
---|
666 | int length)</PRE> |
---|
667 | <DL> |
---|
668 | <DD>Compare the entry key to another key. Synonymous to compareTo(new |
---|
669 | ByteArray(buf, offset, length) |
---|
670 | <P> |
---|
671 | <DD><DL> |
---|
672 | </DL> |
---|
673 | </DD> |
---|
674 | <DD><DL> |
---|
675 | <DT><B>Parameters:</B><DD><CODE>buf</CODE> - The key buffer<DD><CODE>offset</CODE> - offset into the key buffer.<DD><CODE>length</CODE> - the length of the key. |
---|
676 | <DT><B>Returns:</B><DD>comparison result between the entry key with the input key.</DL> |
---|
677 | </DD> |
---|
678 | </DL> |
---|
679 | <HR> |
---|
680 | |
---|
681 | <A NAME="compareTo(org.apache.hadoop.io.file.tfile.RawComparable)"><!-- --></A><H3> |
---|
682 | compareTo</H3> |
---|
683 | <PRE> |
---|
684 | public int <B>compareTo</B>(<A HREF="../../../../../../org/apache/hadoop/io/file/tfile/RawComparable.html" title="interface in org.apache.hadoop.io.file.tfile">RawComparable</A> key)</PRE> |
---|
685 | <DL> |
---|
686 | <DD>Compare an entry with a RawComparable object. This is useful when |
---|
687 | Entries are stored in a collection, and we want to compare a user |
---|
688 | supplied key. |
---|
689 | <P> |
---|
690 | <DD><DL> |
---|
691 | <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true#compareTo(T)" title="class or interface in java.lang">compareTo</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A><<A HREF="../../../../../../org/apache/hadoop/io/file/tfile/RawComparable.html" title="interface in org.apache.hadoop.io.file.tfile">RawComparable</A>></CODE></DL> |
---|
692 | </DD> |
---|
693 | <DD><DL> |
---|
694 | </DL> |
---|
695 | </DD> |
---|
696 | </DL> |
---|
697 | <HR> |
---|
698 | |
---|
699 | <A NAME="equals(java.lang.Object)"><!-- --></A><H3> |
---|
700 | equals</H3> |
---|
701 | <PRE> |
---|
702 | public boolean <B>equals</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> other)</PRE> |
---|
703 | <DL> |
---|
704 | <DD>Compare whether this and other points to the same key value. |
---|
705 | <P> |
---|
706 | <DD><DL> |
---|
707 | <DT><B>Overrides:</B><DD><CODE><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></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> |
---|
708 | </DD> |
---|
709 | <DD><DL> |
---|
710 | </DL> |
---|
711 | </DD> |
---|
712 | </DL> |
---|
713 | <HR> |
---|
714 | |
---|
715 | <A NAME="hashCode()"><!-- --></A><H3> |
---|
716 | hashCode</H3> |
---|
717 | <PRE> |
---|
718 | public int <B>hashCode</B>()</PRE> |
---|
719 | <DL> |
---|
720 | <DD><DL> |
---|
721 | <DT><B>Overrides:</B><DD><CODE><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></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> |
---|
722 | </DD> |
---|
723 | <DD><DL> |
---|
724 | </DL> |
---|
725 | </DD> |
---|
726 | </DL> |
---|
727 | <!-- ========= END OF CLASS DATA ========= --> |
---|
728 | <HR> |
---|
729 | |
---|
730 | |
---|
731 | <!-- ======= START OF BOTTOM NAVBAR ====== --> |
---|
732 | <A NAME="navbar_bottom"><!-- --></A> |
---|
733 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
---|
734 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
---|
735 | <TR> |
---|
736 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
---|
737 | <A NAME="navbar_bottom_firstrow"><!-- --></A> |
---|
738 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
---|
739 | <TR ALIGN="center" VALIGN="top"> |
---|
740 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
---|
741 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
742 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
743 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/TFile.Reader.Scanner.Entry.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
---|
744 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
745 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
746 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
---|
747 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
---|
748 | </TR> |
---|
749 | </TABLE> |
---|
750 | </TD> |
---|
751 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
---|
752 | </EM> |
---|
753 | </TD> |
---|
754 | </TR> |
---|
755 | |
---|
756 | <TR> |
---|
757 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
758 | <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.html" title="class in org.apache.hadoop.io.file.tfile"><B>PREV CLASS</B></A> |
---|
759 | <A HREF="../../../../../../org/apache/hadoop/io/file/tfile/TFile.Writer.html" title="class in org.apache.hadoop.io.file.tfile"><B>NEXT CLASS</B></A></FONT></TD> |
---|
760 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
761 | <A HREF="../../../../../../index.html?org/apache/hadoop/io/file/tfile/TFile.Reader.Scanner.Entry.html" target="_top"><B>FRAMES</B></A> |
---|
762 | <A HREF="TFile.Reader.Scanner.Entry.html" target="_top"><B>NO FRAMES</B></A> |
---|
763 | <SCRIPT type="text/javascript"> |
---|
764 | <!-- |
---|
765 | if(window==top) { |
---|
766 | document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
---|
767 | } |
---|
768 | //--> |
---|
769 | </SCRIPT> |
---|
770 | <NOSCRIPT> |
---|
771 | <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
---|
772 | </NOSCRIPT> |
---|
773 | |
---|
774 | |
---|
775 | </FONT></TD> |
---|
776 | </TR> |
---|
777 | <TR> |
---|
778 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
779 | SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
780 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
781 | DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
---|
782 | </TR> |
---|
783 | </TABLE> |
---|
784 | <A NAME="skip-navbar_bottom"></A> |
---|
785 | <!-- ======== END OF BOTTOM NAVBAR ======= --> |
---|
786 | |
---|
787 | <HR> |
---|
788 | Copyright © 2009 The Apache Software Foundation |
---|
789 | </BODY> |
---|
790 | </HTML> |
---|