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