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

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