source: sandbox/expresso-solr/solr/docs/api/org/apache/solr/response/transform/DocTransformer.html @ 7588

Revision 7588, 17.6 KB checked in by adir, 11 years ago (diff)

Ticket #000 - Adicionando a integracao de buscas com Solr na base a ser isnerida na comunidade
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_24) on Mon Jun 25 15:26:25 EDT 2012 -->
6<META http-equiv="Content-Type" content="text/html; charset=utf-8">
7<TITLE>
8DocTransformer (Solr 4.0.0-ALPHA API)
9</TITLE>
10
11<META NAME="date" CONTENT="2012-06-25">
12
13<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
14
15<SCRIPT type="text/javascript">
16function windowTitle()
17{
18    if (location.href.indexOf('is-external=true') == -1) {
19        parent.document.title="DocTransformer (Solr 4.0.0-ALPHA API)";
20    }
21}
22</SCRIPT>
23<NOSCRIPT>
24</NOSCRIPT>
25
26</HEAD>
27
28<BODY BGCOLOR="white" onload="windowTitle();">
29<HR>
30
31
32<!-- ========= START OF TOP NAVBAR ======= -->
33<A NAME="navbar_top"><!-- --></A>
34<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
35<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
36<TR>
37<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
38<A NAME="navbar_top_firstrow"><!-- --></A>
39<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
40  <TR ALIGN="center" VALIGN="top">
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
43  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/DocTransformer.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
47  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
48  </TR>
49</TABLE>
50</TD>
51<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
52</EM>
53</TD>
54</TR>
55
56<TR>
57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
58&nbsp;<A HREF="../../../../../org/apache/solr/response/transform/DocIdAugmenterFactory.html" title="class in org.apache.solr.response.transform"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../../org/apache/solr/response/transform/DocTransformers.html" title="class in org.apache.solr.response.transform"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../../index.html?org/apache/solr/response/transform/DocTransformer.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="DocTransformer.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;NESTED&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.solr.response.transform</FONT>
92<BR>
93Class DocTransformer</H2>
94<PRE>
95<A HREF="http://download.oracle.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.solr.response.transform.DocTransformer</B>
97</PRE>
98<DL>
99<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/apache/solr/response/transform/DocTransformers.html" title="class in org.apache.solr.response.transform">DocTransformers</A>, <A HREF="../../../../../org/apache/solr/response/transform/RenameFieldTransformer.html" title="class in org.apache.solr.response.transform">RenameFieldTransformer</A>, <A HREF="../../../../../org/apache/solr/response/transform/TransformerWithContext.html" title="class in org.apache.solr.response.transform">TransformerWithContext</A>, <A HREF="../../../../../org/apache/solr/response/transform/ValueSourceAugmenter.html" title="class in org.apache.solr.response.transform">ValueSourceAugmenter</A></DD>
100</DL>
101<HR>
102<DL>
103<DT><PRE>public abstract class <B>DocTransformer</B><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>
104</PRE>
105
106<P>
107A DocTransformer can add, remove or alter a Document before it is written out to the Response.  For instance, there are implementations
108 that can put explanations inline with a document, add constant values and mark items as being artificially boosted (see <A HREF="../../../../../org/apache/solr/handler/component/QueryElevationComponent.html" title="class in org.apache.solr.handler.component"><CODE>QueryElevationComponent</CODE></A>)
109
110 <p/>
111 New instance for each request
112<P>
113
114<P>
115<DL>
116<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/solr/response/transform/TransformerFactory.html" title="class in org.apache.solr.response.transform"><CODE>TransformerFactory</CODE></A></DL>
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/solr/response/transform/DocTransformer.html#DocTransformer()">DocTransformer</A></B>()</CODE>
131
132<BR>
133&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
134</TR>
135</TABLE>
136&nbsp;
137<!-- ========== METHOD SUMMARY =========== -->
138
139<A NAME="method_summary"><!-- --></A>
140<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
141<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
142<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
143<B>Method Summary</B></FONT></TH>
144</TR>
145<TR BGCOLOR="white" CLASS="TableRowColor">
146<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
147<CODE>abstract &nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
148<TD><CODE><B><A HREF="../../../../../org/apache/solr/response/transform/DocTransformer.html#getName()">getName</A></B>()</CODE>
149
150<BR>
151&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
152</TR>
153<TR BGCOLOR="white" CLASS="TableRowColor">
154<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
155<CODE>&nbsp;void</CODE></FONT></TD>
156<TD><CODE><B><A HREF="../../../../../org/apache/solr/response/transform/DocTransformer.html#setContext(org.apache.solr.response.transform.TransformContext)">setContext</A></B>(<A HREF="../../../../../org/apache/solr/response/transform/TransformContext.html" title="class in org.apache.solr.response.transform">TransformContext</A>&nbsp;context)</CODE>
157
158<BR>
159&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This is called before transform and sets</TD>
160</TR>
161<TR BGCOLOR="white" CLASS="TableRowColor">
162<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
163<CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
164<TD><CODE><B><A HREF="../../../../../org/apache/solr/response/transform/DocTransformer.html#toString()">toString</A></B>()</CODE>
165
166<BR>
167&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
168</TR>
169<TR BGCOLOR="white" CLASS="TableRowColor">
170<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
171<CODE>abstract &nbsp;void</CODE></FONT></TD>
172<TD><CODE><B><A HREF="../../../../../org/apache/solr/response/transform/DocTransformer.html#transform(org.apache.solr.common.SolrDocument, int)">transform</A></B>(<A HREF="../../../../../org/apache/solr/common/SolrDocument.html" title="class in org.apache.solr.common">SolrDocument</A>&nbsp;doc,
173          int&nbsp;docid)</CODE>
174
175<BR>
176&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This is where implementations do the actual work</TD>
177</TR>
178</TABLE>
179&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
180<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
181<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
182<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
183</TR>
184<TR BGCOLOR="white" CLASS="TableRowColor">
185<TD><CODE><A HREF="http://download.oracle.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://download.oracle.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://download.oracle.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://download.oracle.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://download.oracle.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://download.oracle.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://download.oracle.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://download.oracle.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://download.oracle.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://download.oracle.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>
186</TR>
187</TABLE>
188&nbsp;
189<P>
190
191<!-- ========= CONSTRUCTOR DETAIL ======== -->
192
193<A NAME="constructor_detail"><!-- --></A>
194<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
195<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
196<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
197<B>Constructor Detail</B></FONT></TH>
198</TR>
199</TABLE>
200
201<A NAME="DocTransformer()"><!-- --></A><H3>
202DocTransformer</H3>
203<PRE>
204public <B>DocTransformer</B>()</PRE>
205<DL>
206</DL>
207
208<!-- ============ METHOD DETAIL ========== -->
209
210<A NAME="method_detail"><!-- --></A>
211<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
212<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
213<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
214<B>Method Detail</B></FONT></TH>
215</TR>
216</TABLE>
217
218<A NAME="getName()"><!-- --></A><H3>
219getName</H3>
220<PRE>
221public abstract <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getName</B>()</PRE>
222<DL>
223<DD><DL>
224
225<DT><B>Returns:</B><DD>The name of the transformer</DL>
226</DD>
227</DL>
228<HR>
229
230<A NAME="setContext(org.apache.solr.response.transform.TransformContext)"><!-- --></A><H3>
231setContext</H3>
232<PRE>
233public void <B>setContext</B>(<A HREF="../../../../../org/apache/solr/response/transform/TransformContext.html" title="class in org.apache.solr.response.transform">TransformContext</A>&nbsp;context)</PRE>
234<DL>
235<DD>This is called before transform and sets
236<P>
237<DD><DL>
238<DT><B>Parameters:</B><DD><CODE>context</CODE> - The <A HREF="../../../../../org/apache/solr/response/transform/TransformContext.html" title="class in org.apache.solr.response.transform"><CODE>TransformContext</CODE></A> stores information about the current state of things in Solr that may be
239 useful for doing transformations.</DL>
240</DD>
241</DL>
242<HR>
243
244<A NAME="transform(org.apache.solr.common.SolrDocument, int)"><!-- --></A><H3>
245transform</H3>
246<PRE>
247public abstract void <B>transform</B>(<A HREF="../../../../../org/apache/solr/common/SolrDocument.html" title="class in org.apache.solr.common">SolrDocument</A>&nbsp;doc,
248                               int&nbsp;docid)
249                        throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
250<DL>
251<DD>This is where implementations do the actual work
252<P>
253<DD><DL>
254<DT><B>Parameters:</B><DD><CODE>doc</CODE> - The document to alter<DD><CODE>docid</CODE> - The Lucene internal doc id
255<DT><B>Throws:</B>
256<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
257</DD>
258</DL>
259<HR>
260
261<A NAME="toString()"><!-- --></A><H3>
262toString</H3>
263<PRE>
264public <A HREF="http://download.oracle.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>
265<DL>
266<DD><DL>
267<DT><B>Overrides:</B><DD><CODE><A HREF="http://download.oracle.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://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>
268</DD>
269<DD><DL>
270</DL>
271</DD>
272</DL>
273<!-- ========= END OF CLASS DATA ========= -->
274<HR>
275
276
277<!-- ======= START OF BOTTOM NAVBAR ====== -->
278<A NAME="navbar_bottom"><!-- --></A>
279<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
280<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
281<TR>
282<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
283<A NAME="navbar_bottom_firstrow"><!-- --></A>
284<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
285  <TR ALIGN="center" VALIGN="top">
286  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
287  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
288  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
289  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/DocTransformer.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
290  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
291  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
292  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
293  </TR>
294</TABLE>
295</TD>
296<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
297</EM>
298</TD>
299</TR>
300
301<TR>
302<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
303&nbsp;<A HREF="../../../../../org/apache/solr/response/transform/DocIdAugmenterFactory.html" title="class in org.apache.solr.response.transform"><B>PREV CLASS</B></A>&nbsp;
304&nbsp;<A HREF="../../../../../org/apache/solr/response/transform/DocTransformers.html" title="class in org.apache.solr.response.transform"><B>NEXT CLASS</B></A></FONT></TD>
305<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
306  <A HREF="../../../../../index.html?org/apache/solr/response/transform/DocTransformer.html" target="_top"><B>FRAMES</B></A>  &nbsp;
307&nbsp;<A HREF="DocTransformer.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
308&nbsp;<SCRIPT type="text/javascript">
309  <!--
310  if(window==top) {
311    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
312  }
313  //-->
314</SCRIPT>
315<NOSCRIPT>
316  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
317</NOSCRIPT>
318
319
320</FONT></TD>
321</TR>
322<TR>
323<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
324  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
325<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
326DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
327</TR>
328</TABLE>
329<A NAME="skip-navbar_bottom"></A>
330<!-- ======== END OF BOTTOM NAVBAR ======= -->
331
332<HR>
333
334          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
335          <script src='../../../../../prettify.js' type='text/javascript'></script>
336          <script type='text/javascript'>
337            (function(){
338              var oldonload = window.onload;
339              if (typeof oldonload != 'function') {
340                window.onload = prettyPrint;
341              } else {
342                window.onload = function() {
343                  oldonload();
344                  prettyPrint();
345                }
346              }
347            })();
348          </script>
349       
350</BODY>
351</HTML>
Note: See TracBrowser for help on using the repository browser.