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

Revision 7588, 16.7 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>
8TransformerWithContext (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="TransformerWithContext (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/TransformerWithContext.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/TransformerFactory.html" title="class in org.apache.solr.response.transform"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../../org/apache/solr/response/transform/ValueAugmenterFactory.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/TransformerWithContext.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="TransformerWithContext.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;<A HREF="#field_summary">FIELD</A>&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;<A HREF="#field_detail">FIELD</A>&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 TransformerWithContext</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 "><A HREF="../../../../../org/apache/solr/response/transform/DocTransformer.html" title="class in org.apache.solr.response.transform">org.apache.solr.response.transform.DocTransformer</A>
97      <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.solr.response.transform.TransformerWithContext</B>
98</PRE>
99<DL>
100<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/apache/solr/response/transform/BaseEditorialTransformer.html" title="class in org.apache.solr.response.transform">BaseEditorialTransformer</A>, <A HREF="../../../../../org/apache/solr/response/transform/ScoreAugmenter.html" title="class in org.apache.solr.response.transform">ScoreAugmenter</A></DD>
101</DL>
102<HR>
103<DL>
104<DT><PRE>public abstract class <B>TransformerWithContext</B><DT>extends <A HREF="../../../../../org/apache/solr/response/transform/DocTransformer.html" title="class in org.apache.solr.response.transform">DocTransformer</A></DL>
105</PRE>
106
107<P>
108<DL>
109<DT><B>Since:</B></DT>
110  <DD>solr 4.0</DD>
111</DL>
112<HR>
113
114<P>
115<!-- =========== FIELD SUMMARY =========== -->
116
117<A NAME="field_summary"><!-- --></A>
118<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
119<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
120<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
121<B>Field Summary</B></FONT></TH>
122</TR>
123<TR BGCOLOR="white" CLASS="TableRowColor">
124<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
125<CODE>protected &nbsp;<A HREF="../../../../../org/apache/solr/response/transform/TransformContext.html" title="class in org.apache.solr.response.transform">TransformContext</A></CODE></FONT></TD>
126<TD><CODE><B><A HREF="../../../../../org/apache/solr/response/transform/TransformerWithContext.html#context">context</A></B></CODE>
127
128<BR>
129&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
130</TR>
131</TABLE>
132&nbsp;
133<!-- ======== CONSTRUCTOR SUMMARY ======== -->
134
135<A NAME="constructor_summary"><!-- --></A>
136<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
137<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
138<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
139<B>Constructor Summary</B></FONT></TH>
140</TR>
141<TR BGCOLOR="white" CLASS="TableRowColor">
142<TD><CODE><B><A HREF="../../../../../org/apache/solr/response/transform/TransformerWithContext.html#TransformerWithContext()">TransformerWithContext</A></B>()</CODE>
143
144<BR>
145&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
146</TR>
147</TABLE>
148&nbsp;
149<!-- ========== METHOD SUMMARY =========== -->
150
151<A NAME="method_summary"><!-- --></A>
152<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
153<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
154<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
155<B>Method Summary</B></FONT></TH>
156</TR>
157<TR BGCOLOR="white" CLASS="TableRowColor">
158<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
159<CODE>&nbsp;void</CODE></FONT></TD>
160<TD><CODE><B><A HREF="../../../../../org/apache/solr/response/transform/TransformerWithContext.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>
161
162<BR>
163&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This is called before transform and sets</TD>
164</TR>
165</TABLE>
166&nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.response.transform.DocTransformer"><!-- --></A>
167<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
168<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
169<TH ALIGN="left"><B>Methods inherited from class org.apache.solr.response.transform.<A HREF="../../../../../org/apache/solr/response/transform/DocTransformer.html" title="class in org.apache.solr.response.transform">DocTransformer</A></B></TH>
170</TR>
171<TR BGCOLOR="white" CLASS="TableRowColor">
172<TD><CODE><A HREF="../../../../../org/apache/solr/response/transform/DocTransformer.html#getName()">getName</A>, <A HREF="../../../../../org/apache/solr/response/transform/DocTransformer.html#toString()">toString</A>, <A HREF="../../../../../org/apache/solr/response/transform/DocTransformer.html#transform(org.apache.solr.common.SolrDocument, int)">transform</A></CODE></TD>
173</TR>
174</TABLE>
175&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
176<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
177<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
178<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>
179</TR>
180<TR BGCOLOR="white" CLASS="TableRowColor">
181<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>
182</TR>
183</TABLE>
184&nbsp;
185<P>
186
187<!-- ============ FIELD DETAIL =========== -->
188
189<A NAME="field_detail"><!-- --></A>
190<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
191<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
192<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
193<B>Field Detail</B></FONT></TH>
194</TR>
195</TABLE>
196
197<A NAME="context"><!-- --></A><H3>
198context</H3>
199<PRE>
200protected <A HREF="../../../../../org/apache/solr/response/transform/TransformContext.html" title="class in org.apache.solr.response.transform">TransformContext</A> <B>context</B></PRE>
201<DL>
202<DL>
203</DL>
204</DL>
205
206<!-- ========= CONSTRUCTOR DETAIL ======== -->
207
208<A NAME="constructor_detail"><!-- --></A>
209<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
210<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
211<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
212<B>Constructor Detail</B></FONT></TH>
213</TR>
214</TABLE>
215
216<A NAME="TransformerWithContext()"><!-- --></A><H3>
217TransformerWithContext</H3>
218<PRE>
219public <B>TransformerWithContext</B>()</PRE>
220<DL>
221</DL>
222
223<!-- ============ METHOD DETAIL ========== -->
224
225<A NAME="method_detail"><!-- --></A>
226<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
227<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
228<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
229<B>Method Detail</B></FONT></TH>
230</TR>
231</TABLE>
232
233<A NAME="setContext(org.apache.solr.response.transform.TransformContext)"><!-- --></A><H3>
234setContext</H3>
235<PRE>
236public 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>
237<DL>
238<DD><B>Description copied from class: <CODE><A HREF="../../../../../org/apache/solr/response/transform/DocTransformer.html#setContext(org.apache.solr.response.transform.TransformContext)">DocTransformer</A></CODE></B></DD>
239<DD>This is called before transform and sets
240<P>
241<DD><DL>
242<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/solr/response/transform/DocTransformer.html#setContext(org.apache.solr.response.transform.TransformContext)">setContext</A></CODE> in class <CODE><A HREF="../../../../../org/apache/solr/response/transform/DocTransformer.html" title="class in org.apache.solr.response.transform">DocTransformer</A></CODE></DL>
243</DD>
244<DD><DL>
245<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
246 useful for doing transformations.</DL>
247</DD>
248</DL>
249<!-- ========= END OF CLASS DATA ========= -->
250<HR>
251
252
253<!-- ======= START OF BOTTOM NAVBAR ====== -->
254<A NAME="navbar_bottom"><!-- --></A>
255<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
256<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
257<TR>
258<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
259<A NAME="navbar_bottom_firstrow"><!-- --></A>
260<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
261  <TR ALIGN="center" VALIGN="top">
262  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
263  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
264  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
265  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/TransformerWithContext.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
266  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
267  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
268  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
269  </TR>
270</TABLE>
271</TD>
272<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
273</EM>
274</TD>
275</TR>
276
277<TR>
278<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
279&nbsp;<A HREF="../../../../../org/apache/solr/response/transform/TransformerFactory.html" title="class in org.apache.solr.response.transform"><B>PREV CLASS</B></A>&nbsp;
280&nbsp;<A HREF="../../../../../org/apache/solr/response/transform/ValueAugmenterFactory.html" title="class in org.apache.solr.response.transform"><B>NEXT CLASS</B></A></FONT></TD>
281<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
282  <A HREF="../../../../../index.html?org/apache/solr/response/transform/TransformerWithContext.html" target="_top"><B>FRAMES</B></A>  &nbsp;
283&nbsp;<A HREF="TransformerWithContext.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
284&nbsp;<SCRIPT type="text/javascript">
285  <!--
286  if(window==top) {
287    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
288  }
289  //-->
290</SCRIPT>
291<NOSCRIPT>
292  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
293</NOSCRIPT>
294
295
296</FONT></TD>
297</TR>
298<TR>
299<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
300  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
301<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
302DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
303</TR>
304</TABLE>
305<A NAME="skip-navbar_bottom"></A>
306<!-- ======== END OF BOTTOM NAVBAR ======= -->
307
308<HR>
309
310          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
311          <script src='../../../../../prettify.js' type='text/javascript'></script>
312          <script type='text/javascript'>
313            (function(){
314              var oldonload = window.onload;
315              if (typeof oldonload != 'function') {
316                window.onload = prettyPrint;
317              } else {
318                window.onload = function() {
319                  oldonload();
320                  prettyPrint();
321                }
322              }
323            })();
324          </script>
325       
326</BODY>
327</HTML>
Note: See TracBrowser for help on using the repository browser.