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:59 UTC 2009 --> |
---|
6 | <TITLE> |
---|
7 | Shard (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="Shard (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/Shard.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/contrib/index/mapred/IntermediateForm.html" title="class in org.apache.hadoop.contrib.index.mapred"><B>PREV CLASS</B></A> |
---|
59 | NEXT CLASS</FONT></TD> |
---|
60 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
61 | <A HREF="../../../../../../index.html?org/apache/hadoop/contrib/index/mapred/Shard.html" target="_top"><B>FRAMES</B></A> |
---|
62 | <A HREF="Shard.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.contrib.index.mapred</FONT> |
---|
92 | <BR> |
---|
93 | Class Shard</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.contrib.index.mapred.Shard</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/Writable.html" title="interface in org.apache.hadoop.io">Writable</A>, <A HREF="../../../../../../org/apache/hadoop/io/WritableComparable.html" title="interface in org.apache.hadoop.io">WritableComparable</A></DD> |
---|
100 | </DL> |
---|
101 | <HR> |
---|
102 | <DL> |
---|
103 | <DT><PRE>public class <B>Shard</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="../../../../../../org/apache/hadoop/io/WritableComparable.html" title="interface in org.apache.hadoop.io">WritableComparable</A></DL> |
---|
104 | </PRE> |
---|
105 | |
---|
106 | <P> |
---|
107 | This class represents the metadata of a shard. Version is the version number |
---|
108 | of the entire index. Directory is the directory where this shard resides in. |
---|
109 | Generation is the Lucene index's generation. Version and generation are |
---|
110 | reserved for future use. |
---|
111 | |
---|
112 | Note: Currently the version number of the entire index is not used and |
---|
113 | defaults to -1. |
---|
114 | <P> |
---|
115 | |
---|
116 | <P> |
---|
117 | <HR> |
---|
118 | |
---|
119 | <P> |
---|
120 | |
---|
121 | <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
---|
122 | |
---|
123 | <A NAME="constructor_summary"><!-- --></A> |
---|
124 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
125 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
126 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
127 | <B>Constructor Summary</B></FONT></TH> |
---|
128 | </TR> |
---|
129 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
130 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/contrib/index/mapred/Shard.html#Shard()">Shard</A></B>()</CODE> |
---|
131 | |
---|
132 | <BR> |
---|
133 | Constructor.</TD> |
---|
134 | </TR> |
---|
135 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
136 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/contrib/index/mapred/Shard.html#Shard(long, java.lang.String, long)">Shard</A></B>(long version, |
---|
137 | <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> dir, |
---|
138 | long gen)</CODE> |
---|
139 | |
---|
140 | <BR> |
---|
141 | Construct a shard from a versio number, a directory and a generation |
---|
142 | number.</TD> |
---|
143 | </TR> |
---|
144 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
145 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/contrib/index/mapred/Shard.html#Shard(org.apache.hadoop.contrib.index.mapred.Shard)">Shard</A></B>(<A HREF="../../../../../../org/apache/hadoop/contrib/index/mapred/Shard.html" title="class in org.apache.hadoop.contrib.index.mapred">Shard</A> shard)</CODE> |
---|
146 | |
---|
147 | <BR> |
---|
148 | Construct using a shard object.</TD> |
---|
149 | </TR> |
---|
150 | </TABLE> |
---|
151 | |
---|
152 | <!-- ========== METHOD SUMMARY =========== --> |
---|
153 | |
---|
154 | <A NAME="method_summary"><!-- --></A> |
---|
155 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
156 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
157 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
158 | <B>Method Summary</B></FONT></TH> |
---|
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/contrib/index/mapred/Shard.html#compareTo(java.lang.Object)">compareTo</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> o)</CODE> |
---|
164 | |
---|
165 | <BR> |
---|
166 | </TD> |
---|
167 | </TR> |
---|
168 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
169 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
170 | <CODE> int</CODE></FONT></TD> |
---|
171 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/contrib/index/mapred/Shard.html#compareTo(org.apache.hadoop.contrib.index.mapred.Shard)">compareTo</A></B>(<A HREF="../../../../../../org/apache/hadoop/contrib/index/mapred/Shard.html" title="class in org.apache.hadoop.contrib.index.mapred">Shard</A> other)</CODE> |
---|
172 | |
---|
173 | <BR> |
---|
174 | Compare to another shard.</TD> |
---|
175 | </TR> |
---|
176 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
177 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
178 | <CODE> boolean</CODE></FONT></TD> |
---|
179 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/contrib/index/mapred/Shard.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> o)</CODE> |
---|
180 | |
---|
181 | <BR> |
---|
182 | </TD> |
---|
183 | </TR> |
---|
184 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
185 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
186 | <CODE> <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> |
---|
187 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/contrib/index/mapred/Shard.html#getDirectory()">getDirectory</A></B>()</CODE> |
---|
188 | |
---|
189 | <BR> |
---|
190 | Get the directory where this shard resides.</TD> |
---|
191 | </TR> |
---|
192 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
193 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
194 | <CODE> long</CODE></FONT></TD> |
---|
195 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/contrib/index/mapred/Shard.html#getGeneration()">getGeneration</A></B>()</CODE> |
---|
196 | |
---|
197 | <BR> |
---|
198 | Get the generation of the Lucene instance.</TD> |
---|
199 | </TR> |
---|
200 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
201 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
202 | <CODE>static <A HREF="../../../../../../org/apache/hadoop/contrib/index/mapred/Shard.html" title="class in org.apache.hadoop.contrib.index.mapred">Shard</A>[]</CODE></FONT></TD> |
---|
203 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/contrib/index/mapred/Shard.html#getIndexShards(org.apache.hadoop.contrib.index.mapred.IndexUpdateConfiguration)">getIndexShards</A></B>(<A HREF="../../../../../../org/apache/hadoop/contrib/index/mapred/IndexUpdateConfiguration.html" title="class in org.apache.hadoop.contrib.index.mapred">IndexUpdateConfiguration</A> conf)</CODE> |
---|
204 | |
---|
205 | <BR> |
---|
206 | </TD> |
---|
207 | </TR> |
---|
208 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
209 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
210 | <CODE> long</CODE></FONT></TD> |
---|
211 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/contrib/index/mapred/Shard.html#getVersion()">getVersion</A></B>()</CODE> |
---|
212 | |
---|
213 | <BR> |
---|
214 | Get the version number of the entire index.</TD> |
---|
215 | </TR> |
---|
216 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
217 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
218 | <CODE> int</CODE></FONT></TD> |
---|
219 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/contrib/index/mapred/Shard.html#hashCode()">hashCode</A></B>()</CODE> |
---|
220 | |
---|
221 | <BR> |
---|
222 | </TD> |
---|
223 | </TR> |
---|
224 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
225 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
226 | <CODE>static <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
---|
227 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/contrib/index/mapred/Shard.html#normalizePath(java.lang.String)">normalizePath</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> path)</CODE> |
---|
228 | |
---|
229 | <BR> |
---|
230 | </TD> |
---|
231 | </TR> |
---|
232 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
233 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
234 | <CODE> void</CODE></FONT></TD> |
---|
235 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/contrib/index/mapred/Shard.html#readFields(java.io.DataInput)">readFields</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/DataInput.html?is-external=true" title="class or interface in java.io">DataInput</A> in)</CODE> |
---|
236 | |
---|
237 | <BR> |
---|
238 | Deserialize the fields of this object from <code>in</code>.</TD> |
---|
239 | </TR> |
---|
240 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
241 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
242 | <CODE>static void</CODE></FONT></TD> |
---|
243 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/contrib/index/mapred/Shard.html#setIndexShards(org.apache.hadoop.contrib.index.mapred.IndexUpdateConfiguration, org.apache.hadoop.contrib.index.mapred.Shard[])">setIndexShards</A></B>(<A HREF="../../../../../../org/apache/hadoop/contrib/index/mapred/IndexUpdateConfiguration.html" title="class in org.apache.hadoop.contrib.index.mapred">IndexUpdateConfiguration</A> conf, |
---|
244 | <A HREF="../../../../../../org/apache/hadoop/contrib/index/mapred/Shard.html" title="class in org.apache.hadoop.contrib.index.mapred">Shard</A>[] shards)</CODE> |
---|
245 | |
---|
246 | <BR> |
---|
247 | </TD> |
---|
248 | </TR> |
---|
249 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
250 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
251 | <CODE> <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> |
---|
252 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/contrib/index/mapred/Shard.html#toString()">toString</A></B>()</CODE> |
---|
253 | |
---|
254 | <BR> |
---|
255 | </TD> |
---|
256 | </TR> |
---|
257 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
258 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
259 | <CODE> void</CODE></FONT></TD> |
---|
260 | <TD><CODE><B><A HREF="../../../../../../org/apache/hadoop/contrib/index/mapred/Shard.html#write(java.io.DataOutput)">write</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/DataOutput.html?is-external=true" title="class or interface in java.io">DataOutput</A> out)</CODE> |
---|
261 | |
---|
262 | <BR> |
---|
263 | Serialize the fields of this object to <code>out</code>.</TD> |
---|
264 | </TR> |
---|
265 | </TABLE> |
---|
266 | <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
---|
267 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
268 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
---|
269 | <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> |
---|
270 | </TR> |
---|
271 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
272 | <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#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> |
---|
273 | </TR> |
---|
274 | </TABLE> |
---|
275 | |
---|
276 | <P> |
---|
277 | |
---|
278 | <!-- ========= CONSTRUCTOR DETAIL ======== --> |
---|
279 | |
---|
280 | <A NAME="constructor_detail"><!-- --></A> |
---|
281 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
282 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
283 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
284 | <B>Constructor Detail</B></FONT></TH> |
---|
285 | </TR> |
---|
286 | </TABLE> |
---|
287 | |
---|
288 | <A NAME="Shard()"><!-- --></A><H3> |
---|
289 | Shard</H3> |
---|
290 | <PRE> |
---|
291 | public <B>Shard</B>()</PRE> |
---|
292 | <DL> |
---|
293 | <DD>Constructor. |
---|
294 | <P> |
---|
295 | </DL> |
---|
296 | <HR> |
---|
297 | |
---|
298 | <A NAME="Shard(long, java.lang.String, long)"><!-- --></A><H3> |
---|
299 | Shard</H3> |
---|
300 | <PRE> |
---|
301 | public <B>Shard</B>(long version, |
---|
302 | <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> dir, |
---|
303 | long gen)</PRE> |
---|
304 | <DL> |
---|
305 | <DD>Construct a shard from a versio number, a directory and a generation |
---|
306 | number. |
---|
307 | <P> |
---|
308 | <DL> |
---|
309 | <DT><B>Parameters:</B><DD><CODE>version</CODE> - the version number of the entire index<DD><CODE>dir</CODE> - the directory where this shard resides<DD><CODE>gen</CODE> - the generation of the Lucene instance</DL> |
---|
310 | </DL> |
---|
311 | <HR> |
---|
312 | |
---|
313 | <A NAME="Shard(org.apache.hadoop.contrib.index.mapred.Shard)"><!-- --></A><H3> |
---|
314 | Shard</H3> |
---|
315 | <PRE> |
---|
316 | public <B>Shard</B>(<A HREF="../../../../../../org/apache/hadoop/contrib/index/mapred/Shard.html" title="class in org.apache.hadoop.contrib.index.mapred">Shard</A> shard)</PRE> |
---|
317 | <DL> |
---|
318 | <DD>Construct using a shard object. |
---|
319 | <P> |
---|
320 | <DL> |
---|
321 | <DT><B>Parameters:</B><DD><CODE>shard</CODE> - the shard used by the constructor</DL> |
---|
322 | </DL> |
---|
323 | |
---|
324 | <!-- ============ METHOD DETAIL ========== --> |
---|
325 | |
---|
326 | <A NAME="method_detail"><!-- --></A> |
---|
327 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
328 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
329 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
330 | <B>Method Detail</B></FONT></TH> |
---|
331 | </TR> |
---|
332 | </TABLE> |
---|
333 | |
---|
334 | <A NAME="normalizePath(java.lang.String)"><!-- --></A><H3> |
---|
335 | normalizePath</H3> |
---|
336 | <PRE> |
---|
337 | public static <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>normalizePath</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> path)</PRE> |
---|
338 | <DL> |
---|
339 | <DD><DL> |
---|
340 | </DL> |
---|
341 | </DD> |
---|
342 | <DD><DL> |
---|
343 | </DL> |
---|
344 | </DD> |
---|
345 | </DL> |
---|
346 | <HR> |
---|
347 | |
---|
348 | <A NAME="setIndexShards(org.apache.hadoop.contrib.index.mapred.IndexUpdateConfiguration, org.apache.hadoop.contrib.index.mapred.Shard[])"><!-- --></A><H3> |
---|
349 | setIndexShards</H3> |
---|
350 | <PRE> |
---|
351 | public static void <B>setIndexShards</B>(<A HREF="../../../../../../org/apache/hadoop/contrib/index/mapred/IndexUpdateConfiguration.html" title="class in org.apache.hadoop.contrib.index.mapred">IndexUpdateConfiguration</A> conf, |
---|
352 | <A HREF="../../../../../../org/apache/hadoop/contrib/index/mapred/Shard.html" title="class in org.apache.hadoop.contrib.index.mapred">Shard</A>[] shards)</PRE> |
---|
353 | <DL> |
---|
354 | <DD><DL> |
---|
355 | </DL> |
---|
356 | </DD> |
---|
357 | <DD><DL> |
---|
358 | </DL> |
---|
359 | </DD> |
---|
360 | </DL> |
---|
361 | <HR> |
---|
362 | |
---|
363 | <A NAME="getIndexShards(org.apache.hadoop.contrib.index.mapred.IndexUpdateConfiguration)"><!-- --></A><H3> |
---|
364 | getIndexShards</H3> |
---|
365 | <PRE> |
---|
366 | public static <A HREF="../../../../../../org/apache/hadoop/contrib/index/mapred/Shard.html" title="class in org.apache.hadoop.contrib.index.mapred">Shard</A>[] <B>getIndexShards</B>(<A HREF="../../../../../../org/apache/hadoop/contrib/index/mapred/IndexUpdateConfiguration.html" title="class in org.apache.hadoop.contrib.index.mapred">IndexUpdateConfiguration</A> conf)</PRE> |
---|
367 | <DL> |
---|
368 | <DD><DL> |
---|
369 | </DL> |
---|
370 | </DD> |
---|
371 | <DD><DL> |
---|
372 | </DL> |
---|
373 | </DD> |
---|
374 | </DL> |
---|
375 | <HR> |
---|
376 | |
---|
377 | <A NAME="getVersion()"><!-- --></A><H3> |
---|
378 | getVersion</H3> |
---|
379 | <PRE> |
---|
380 | public long <B>getVersion</B>()</PRE> |
---|
381 | <DL> |
---|
382 | <DD>Get the version number of the entire index. |
---|
383 | <P> |
---|
384 | <DD><DL> |
---|
385 | </DL> |
---|
386 | </DD> |
---|
387 | <DD><DL> |
---|
388 | |
---|
389 | <DT><B>Returns:</B><DD>the version number of the entire index</DL> |
---|
390 | </DD> |
---|
391 | </DL> |
---|
392 | <HR> |
---|
393 | |
---|
394 | <A NAME="getDirectory()"><!-- --></A><H3> |
---|
395 | getDirectory</H3> |
---|
396 | <PRE> |
---|
397 | public <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>getDirectory</B>()</PRE> |
---|
398 | <DL> |
---|
399 | <DD>Get the directory where this shard resides. |
---|
400 | <P> |
---|
401 | <DD><DL> |
---|
402 | </DL> |
---|
403 | </DD> |
---|
404 | <DD><DL> |
---|
405 | |
---|
406 | <DT><B>Returns:</B><DD>the directory where this shard resides</DL> |
---|
407 | </DD> |
---|
408 | </DL> |
---|
409 | <HR> |
---|
410 | |
---|
411 | <A NAME="getGeneration()"><!-- --></A><H3> |
---|
412 | getGeneration</H3> |
---|
413 | <PRE> |
---|
414 | public long <B>getGeneration</B>()</PRE> |
---|
415 | <DL> |
---|
416 | <DD>Get the generation of the Lucene instance. |
---|
417 | <P> |
---|
418 | <DD><DL> |
---|
419 | </DL> |
---|
420 | </DD> |
---|
421 | <DD><DL> |
---|
422 | |
---|
423 | <DT><B>Returns:</B><DD>the generation of the Lucene instance</DL> |
---|
424 | </DD> |
---|
425 | </DL> |
---|
426 | <HR> |
---|
427 | |
---|
428 | <A NAME="toString()"><!-- --></A><H3> |
---|
429 | toString</H3> |
---|
430 | <PRE> |
---|
431 | public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE> |
---|
432 | <DL> |
---|
433 | <DD><DL> |
---|
434 | <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL> |
---|
435 | </DD> |
---|
436 | <DD><DL> |
---|
437 | </DL> |
---|
438 | </DD> |
---|
439 | </DL> |
---|
440 | <HR> |
---|
441 | |
---|
442 | <A NAME="write(java.io.DataOutput)"><!-- --></A><H3> |
---|
443 | write</H3> |
---|
444 | <PRE> |
---|
445 | public void <B>write</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/DataOutput.html?is-external=true" title="class or interface in java.io">DataOutput</A> out) |
---|
446 | 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> |
---|
447 | <DL> |
---|
448 | <DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/hadoop/io/Writable.html#write(java.io.DataOutput)">Writable</A></CODE></B></DD> |
---|
449 | <DD>Serialize the fields of this object to <code>out</code>. |
---|
450 | <P> |
---|
451 | <DD><DL> |
---|
452 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/hadoop/io/Writable.html#write(java.io.DataOutput)">write</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/hadoop/io/Writable.html" title="interface in org.apache.hadoop.io">Writable</A></CODE></DL> |
---|
453 | </DD> |
---|
454 | <DD><DL> |
---|
455 | <DT><B>Parameters:</B><DD><CODE>out</CODE> - <code>DataOuput</code> to serialize this object into. |
---|
456 | <DT><B>Throws:</B> |
---|
457 | <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> |
---|
458 | </DD> |
---|
459 | </DL> |
---|
460 | <HR> |
---|
461 | |
---|
462 | <A NAME="readFields(java.io.DataInput)"><!-- --></A><H3> |
---|
463 | readFields</H3> |
---|
464 | <PRE> |
---|
465 | public void <B>readFields</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/DataInput.html?is-external=true" title="class or interface in java.io">DataInput</A> in) |
---|
466 | 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> |
---|
467 | <DL> |
---|
468 | <DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/hadoop/io/Writable.html#readFields(java.io.DataInput)">Writable</A></CODE></B></DD> |
---|
469 | <DD>Deserialize the fields of this object from <code>in</code>. |
---|
470 | |
---|
471 | <p>For efficiency, implementations should attempt to re-use storage in the |
---|
472 | existing object where possible.</p> |
---|
473 | <P> |
---|
474 | <DD><DL> |
---|
475 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/hadoop/io/Writable.html#readFields(java.io.DataInput)">readFields</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/hadoop/io/Writable.html" title="interface in org.apache.hadoop.io">Writable</A></CODE></DL> |
---|
476 | </DD> |
---|
477 | <DD><DL> |
---|
478 | <DT><B>Parameters:</B><DD><CODE>in</CODE> - <code>DataInput</code> to deseriablize this object from. |
---|
479 | <DT><B>Throws:</B> |
---|
480 | <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> |
---|
481 | </DD> |
---|
482 | </DL> |
---|
483 | <HR> |
---|
484 | |
---|
485 | <A NAME="compareTo(java.lang.Object)"><!-- --></A><H3> |
---|
486 | compareTo</H3> |
---|
487 | <PRE> |
---|
488 | public int <B>compareTo</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> o)</PRE> |
---|
489 | <DL> |
---|
490 | <DD><DL> |
---|
491 | <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></CODE></DL> |
---|
492 | </DD> |
---|
493 | <DD><DL> |
---|
494 | </DL> |
---|
495 | </DD> |
---|
496 | </DL> |
---|
497 | <HR> |
---|
498 | |
---|
499 | <A NAME="compareTo(org.apache.hadoop.contrib.index.mapred.Shard)"><!-- --></A><H3> |
---|
500 | compareTo</H3> |
---|
501 | <PRE> |
---|
502 | public int <B>compareTo</B>(<A HREF="../../../../../../org/apache/hadoop/contrib/index/mapred/Shard.html" title="class in org.apache.hadoop.contrib.index.mapred">Shard</A> other)</PRE> |
---|
503 | <DL> |
---|
504 | <DD>Compare to another shard. |
---|
505 | <P> |
---|
506 | <DD><DL> |
---|
507 | </DL> |
---|
508 | </DD> |
---|
509 | <DD><DL> |
---|
510 | <DT><B>Parameters:</B><DD><CODE>other</CODE> - another shard |
---|
511 | <DT><B>Returns:</B><DD>compare version first, then directory and finally generation</DL> |
---|
512 | </DD> |
---|
513 | </DL> |
---|
514 | <HR> |
---|
515 | |
---|
516 | <A NAME="equals(java.lang.Object)"><!-- --></A><H3> |
---|
517 | equals</H3> |
---|
518 | <PRE> |
---|
519 | 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> o)</PRE> |
---|
520 | <DL> |
---|
521 | <DD><DL> |
---|
522 | <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> |
---|
523 | </DD> |
---|
524 | <DD><DL> |
---|
525 | </DL> |
---|
526 | </DD> |
---|
527 | </DL> |
---|
528 | <HR> |
---|
529 | |
---|
530 | <A NAME="hashCode()"><!-- --></A><H3> |
---|
531 | hashCode</H3> |
---|
532 | <PRE> |
---|
533 | public int <B>hashCode</B>()</PRE> |
---|
534 | <DL> |
---|
535 | <DD><DL> |
---|
536 | <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> |
---|
537 | </DD> |
---|
538 | <DD><DL> |
---|
539 | </DL> |
---|
540 | </DD> |
---|
541 | </DL> |
---|
542 | <!-- ========= END OF CLASS DATA ========= --> |
---|
543 | <HR> |
---|
544 | |
---|
545 | |
---|
546 | <!-- ======= START OF BOTTOM NAVBAR ====== --> |
---|
547 | <A NAME="navbar_bottom"><!-- --></A> |
---|
548 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
---|
549 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
---|
550 | <TR> |
---|
551 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
---|
552 | <A NAME="navbar_bottom_firstrow"><!-- --></A> |
---|
553 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
---|
554 | <TR ALIGN="center" VALIGN="top"> |
---|
555 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
---|
556 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
557 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
558 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Shard.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
---|
559 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
560 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
561 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
---|
562 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
---|
563 | </TR> |
---|
564 | </TABLE> |
---|
565 | </TD> |
---|
566 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
---|
567 | </EM> |
---|
568 | </TD> |
---|
569 | </TR> |
---|
570 | |
---|
571 | <TR> |
---|
572 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
573 | <A HREF="../../../../../../org/apache/hadoop/contrib/index/mapred/IntermediateForm.html" title="class in org.apache.hadoop.contrib.index.mapred"><B>PREV CLASS</B></A> |
---|
574 | NEXT CLASS</FONT></TD> |
---|
575 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
576 | <A HREF="../../../../../../index.html?org/apache/hadoop/contrib/index/mapred/Shard.html" target="_top"><B>FRAMES</B></A> |
---|
577 | <A HREF="Shard.html" target="_top"><B>NO FRAMES</B></A> |
---|
578 | <SCRIPT type="text/javascript"> |
---|
579 | <!-- |
---|
580 | if(window==top) { |
---|
581 | document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
---|
582 | } |
---|
583 | //--> |
---|
584 | </SCRIPT> |
---|
585 | <NOSCRIPT> |
---|
586 | <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
---|
587 | </NOSCRIPT> |
---|
588 | |
---|
589 | |
---|
590 | </FONT></TD> |
---|
591 | </TR> |
---|
592 | <TR> |
---|
593 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
594 | SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
595 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
596 | DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
---|
597 | </TR> |
---|
598 | </TABLE> |
---|
599 | <A NAME="skip-navbar_bottom"></A> |
---|
600 | <!-- ======== END OF BOTTOM NAVBAR ======= --> |
---|
601 | |
---|
602 | <HR> |
---|
603 | Copyright © 2009 The Apache Software Foundation |
---|
604 | </BODY> |
---|
605 | </HTML> |
---|