source: sandbox/expresso-solr/solr/docs/api/org/apache/solr/search/grouping/endresulttransformer/MainEndResultTransformer.html @ 7588

Revision 7588, 17.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>
8MainEndResultTransformer (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="MainEndResultTransformer (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/MainEndResultTransformer.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/search/grouping/endresulttransformer/GroupedEndResultTransformer.html" title="class in org.apache.solr.search.grouping.endresulttransformer"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../../../org/apache/solr/search/grouping/endresulttransformer/SimpleEndResultTransformer.html" title="class in org.apache.solr.search.grouping.endresulttransformer"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../../../index.html?org/apache/solr/search/grouping/endresulttransformer/MainEndResultTransformer.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="MainEndResultTransformer.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.search.grouping.endresulttransformer</FONT>
92<BR>
93Class MainEndResultTransformer</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.search.grouping.endresulttransformer.MainEndResultTransformer</B>
97</PRE>
98<DL>
99<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../../org/apache/solr/search/grouping/endresulttransformer/EndResultTransformer.html" title="interface in org.apache.solr.search.grouping.endresulttransformer">EndResultTransformer</A></DD>
100</DL>
101<HR>
102<DL>
103<DT><PRE>public class <B>MainEndResultTransformer</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><DT>implements <A HREF="../../../../../../org/apache/solr/search/grouping/endresulttransformer/EndResultTransformer.html" title="interface in org.apache.solr.search.grouping.endresulttransformer">EndResultTransformer</A></DL>
104</PRE>
105
106<P>
107Implementation of <A HREF="../../../../../../org/apache/solr/search/grouping/endresulttransformer/EndResultTransformer.html" title="interface in org.apache.solr.search.grouping.endresulttransformer"><CODE>EndResultTransformer</CODE></A> that transforms the grouped result into the main result list in the
108 response.
109<P>
110
111<P>
112<HR>
113
114<P>
115<!-- ======== NESTED CLASS SUMMARY ======== -->
116
117<A NAME="nested_class_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>Nested Class Summary</B></FONT></TH>
122</TR>
123</TABLE>
124&nbsp;<A NAME="nested_classes_inherited_from_class_org.apache.solr.search.grouping.endresulttransformer.EndResultTransformer"><!-- --></A>
125<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
126<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
127<TH ALIGN="left"><B>Nested classes/interfaces inherited from interface org.apache.solr.search.grouping.endresulttransformer.<A HREF="../../../../../../org/apache/solr/search/grouping/endresulttransformer/EndResultTransformer.html" title="interface in org.apache.solr.search.grouping.endresulttransformer">EndResultTransformer</A></B></TH>
128</TR>
129<TR BGCOLOR="white" CLASS="TableRowColor">
130<TD><CODE><A HREF="../../../../../../org/apache/solr/search/grouping/endresulttransformer/EndResultTransformer.SolrDocumentSource.html" title="interface in org.apache.solr.search.grouping.endresulttransformer">EndResultTransformer.SolrDocumentSource</A></CODE></TD>
131</TR>
132</TABLE>
133&nbsp;
134
135<!-- ======== CONSTRUCTOR SUMMARY ======== -->
136
137<A NAME="constructor_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>Constructor Summary</B></FONT></TH>
142</TR>
143<TR BGCOLOR="white" CLASS="TableRowColor">
144<TD><CODE><B><A HREF="../../../../../../org/apache/solr/search/grouping/endresulttransformer/MainEndResultTransformer.html#MainEndResultTransformer()">MainEndResultTransformer</A></B>()</CODE>
145
146<BR>
147&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
148</TR>
149</TABLE>
150&nbsp;
151<!-- ========== METHOD SUMMARY =========== -->
152
153<A NAME="method_summary"><!-- --></A>
154<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
155<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
156<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
157<B>Method Summary</B></FONT></TH>
158</TR>
159<TR BGCOLOR="white" CLASS="TableRowColor">
160<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
161<CODE>&nbsp;void</CODE></FONT></TD>
162<TD><CODE><B><A HREF="../../../../../../org/apache/solr/search/grouping/endresulttransformer/MainEndResultTransformer.html#transform(java.util.Map, org.apache.solr.handler.component.ResponseBuilder, org.apache.solr.search.grouping.endresulttransformer.EndResultTransformer.SolrDocumentSource)">transform</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&lt;<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>,?&gt;&nbsp;result,
163          <A HREF="../../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A>&nbsp;rb,
164          <A HREF="../../../../../../org/apache/solr/search/grouping/endresulttransformer/EndResultTransformer.SolrDocumentSource.html" title="interface in org.apache.solr.search.grouping.endresulttransformer">EndResultTransformer.SolrDocumentSource</A>&nbsp;solrDocumentSource)</CODE>
165
166<BR>
167&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Transforms the specified result into its final form and puts it into the specified response.</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#toString()" title="class or interface in java.lang">toString</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="MainEndResultTransformer()"><!-- --></A><H3>
193MainEndResultTransformer</H3>
194<PRE>
195public <B>MainEndResultTransformer</B>()</PRE>
196<DL>
197</DL>
198
199<!-- ============ METHOD DETAIL ========== -->
200
201<A NAME="method_detail"><!-- --></A>
202<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
203<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
204<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
205<B>Method Detail</B></FONT></TH>
206</TR>
207</TABLE>
208
209<A NAME="transform(java.util.Map, org.apache.solr.handler.component.ResponseBuilder, org.apache.solr.search.grouping.endresulttransformer.EndResultTransformer.SolrDocumentSource)"><!-- --></A><H3>
210transform</H3>
211<PRE>
212public void <B>transform</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&lt;<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>,?&gt;&nbsp;result,
213                      <A HREF="../../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A>&nbsp;rb,
214                      <A HREF="../../../../../../org/apache/solr/search/grouping/endresulttransformer/EndResultTransformer.SolrDocumentSource.html" title="interface in org.apache.solr.search.grouping.endresulttransformer">EndResultTransformer.SolrDocumentSource</A>&nbsp;solrDocumentSource)</PRE>
215<DL>
216<DD>Transforms the specified result into its final form and puts it into the specified response.
217<P>
218<DD><DL>
219<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/solr/search/grouping/endresulttransformer/EndResultTransformer.html#transform(java.util.Map, org.apache.solr.handler.component.ResponseBuilder, org.apache.solr.search.grouping.endresulttransformer.EndResultTransformer.SolrDocumentSource)">transform</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/solr/search/grouping/endresulttransformer/EndResultTransformer.html" title="interface in org.apache.solr.search.grouping.endresulttransformer">EndResultTransformer</A></CODE></DL>
220</DD>
221<DD><DL>
222<DT><B>Parameters:</B><DD><CODE>result</CODE> - The map containing the grouping result (for grouping by field and query)<DD><CODE>rb</CODE> - The response builder containing the response used to render the result and the grouping specification<DD><CODE>solrDocumentSource</CODE> - The source of <A HREF="../../../../../../org/apache/solr/common/SolrDocument.html" title="class in org.apache.solr.common"><CODE>SolrDocument</CODE></A> instances</DL>
223</DD>
224</DL>
225<!-- ========= END OF CLASS DATA ========= -->
226<HR>
227
228
229<!-- ======= START OF BOTTOM NAVBAR ====== -->
230<A NAME="navbar_bottom"><!-- --></A>
231<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
232<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
233<TR>
234<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
235<A NAME="navbar_bottom_firstrow"><!-- --></A>
236<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
237  <TR ALIGN="center" VALIGN="top">
238  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
239  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
240  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
241  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/MainEndResultTransformer.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
242  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
243  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
244  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
245  </TR>
246</TABLE>
247</TD>
248<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
249</EM>
250</TD>
251</TR>
252
253<TR>
254<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
255&nbsp;<A HREF="../../../../../../org/apache/solr/search/grouping/endresulttransformer/GroupedEndResultTransformer.html" title="class in org.apache.solr.search.grouping.endresulttransformer"><B>PREV CLASS</B></A>&nbsp;
256&nbsp;<A HREF="../../../../../../org/apache/solr/search/grouping/endresulttransformer/SimpleEndResultTransformer.html" title="class in org.apache.solr.search.grouping.endresulttransformer"><B>NEXT CLASS</B></A></FONT></TD>
257<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
258  <A HREF="../../../../../../index.html?org/apache/solr/search/grouping/endresulttransformer/MainEndResultTransformer.html" target="_top"><B>FRAMES</B></A>  &nbsp;
259&nbsp;<A HREF="MainEndResultTransformer.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
260&nbsp;<SCRIPT type="text/javascript">
261  <!--
262  if(window==top) {
263    document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
264  }
265  //-->
266</SCRIPT>
267<NOSCRIPT>
268  <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
269</NOSCRIPT>
270
271
272</FONT></TD>
273</TR>
274<TR>
275<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
276  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
277<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
278DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
279</TR>
280</TABLE>
281<A NAME="skip-navbar_bottom"></A>
282<!-- ======== END OF BOTTOM NAVBAR ======= -->
283
284<HR>
285
286          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
287          <script src='../../../../../../prettify.js' type='text/javascript'></script>
288          <script type='text/javascript'>
289            (function(){
290              var oldonload = window.onload;
291              if (typeof oldonload != 'function') {
292                window.onload = prettyPrint;
293              } else {
294                window.onload = function() {
295                  oldonload();
296                  prettyPrint();
297                }
298              }
299            })();
300          </script>
301       
302</BODY>
303</HTML>
Note: See TracBrowser for help on using the repository browser.