source: sandbox/expresso-solr/solr/docs/api/org/apache/solr/search/grouping/distributed/shardresultserializer/ShardResultTransformer.html @ 7588

Revision 7588, 15.9 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>
8ShardResultTransformer (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="ShardResultTransformer (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/ShardResultTransformer.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/distributed/shardresultserializer/SearchGroupsResultTransformer.html" title="class in org.apache.solr.search.grouping.distributed.shardresultserializer"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../../../../org/apache/solr/search/grouping/distributed/shardresultserializer/TopGroupsResultTransformer.html" title="class in org.apache.solr.search.grouping.distributed.shardresultserializer"><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/distributed/shardresultserializer/ShardResultTransformer.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="ShardResultTransformer.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;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&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.distributed.shardresultserializer</FONT>
92<BR>
93Interface ShardResultTransformer&lt;T,R&gt;</H2>
94<DL>
95<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../../../org/apache/solr/search/grouping/distributed/shardresultserializer/SearchGroupsResultTransformer.html" title="class in org.apache.solr.search.grouping.distributed.shardresultserializer">SearchGroupsResultTransformer</A>, <A HREF="../../../../../../../org/apache/solr/search/grouping/distributed/shardresultserializer/TopGroupsResultTransformer.html" title="class in org.apache.solr.search.grouping.distributed.shardresultserializer">TopGroupsResultTransformer</A></DD>
96</DL>
97<HR>
98<DL>
99<DT><PRE>public interface <B>ShardResultTransformer&lt;T,R&gt;</B></DL>
100</PRE>
101
102<P>
103A <code>ShardResultTransformer</code> is responsible for transforming a grouped shard result into group related
104 structures (such as <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//grouping/org/apache/lucene/search/grouping/TopGroups.html?is-external=true" title="class or interface in org.apache.lucene.search.grouping"><CODE>TopGroups</CODE></A> and <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//grouping/org/apache/lucene/search/grouping/SearchGroup.html?is-external=true" title="class or interface in org.apache.lucene.search.grouping"><CODE>SearchGroup</CODE></A>)
105 and visa versa.
106<P>
107
108<P>
109<DL>
110<DT><B>WARNING: This API is experimental and might change in incompatible ways in the next release.</B></DT>
111  <DD></DD>
112</DL>
113<HR>
114
115<P>
116
117<!-- ========== METHOD SUMMARY =========== -->
118
119<A NAME="method_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>Method 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>&nbsp;<A HREF="../../../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A></CODE></FONT></TD>
128<TD><CODE><B><A HREF="../../../../../../../org/apache/solr/search/grouping/distributed/shardresultserializer/ShardResultTransformer.html#transform(T)">transform</A></B>(<A HREF="../../../../../../../org/apache/solr/search/grouping/distributed/shardresultserializer/ShardResultTransformer.html" title="type parameter in ShardResultTransformer">T</A>&nbsp;data)</CODE>
129
130<BR>
131&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Transforms data to a <A HREF="../../../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util"><CODE>NamedList</CODE></A> structure for serialization purposes.</TD>
132</TR>
133<TR BGCOLOR="white" CLASS="TableRowColor">
134<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
135<CODE>&nbsp;<A HREF="../../../../../../../org/apache/solr/search/grouping/distributed/shardresultserializer/ShardResultTransformer.html" title="type parameter in ShardResultTransformer">R</A></CODE></FONT></TD>
136<TD><CODE><B><A HREF="../../../../../../../org/apache/solr/search/grouping/distributed/shardresultserializer/ShardResultTransformer.html#transformToNative(org.apache.solr.common.util.NamedList, org.apache.lucene.search.Sort, org.apache.lucene.search.Sort, java.lang.String)">transformToNative</A></B>(<A HREF="../../../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&lt;<A HREF="../../../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&gt;&nbsp;shardResponse,
137                  <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Sort.html?is-external=true" title="class or interface in org.apache.lucene.search">Sort</A>&nbsp;groupSort,
138                  <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Sort.html?is-external=true" title="class or interface in org.apache.lucene.search">Sort</A>&nbsp;sortWithinGroup,
139                  <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;shard)</CODE>
140
141<BR>
142&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Transforms the specified shard response into native structures.</TD>
143</TR>
144</TABLE>
145&nbsp;
146<P>
147
148<!-- ============ METHOD DETAIL ========== -->
149
150<A NAME="method_detail"><!-- --></A>
151<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
152<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
153<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
154<B>Method Detail</B></FONT></TH>
155</TR>
156</TABLE>
157
158<A NAME="transform(java.lang.Object)"><!-- --></A><A NAME="transform(T)"><!-- --></A><H3>
159transform</H3>
160<PRE>
161<A HREF="../../../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A> <B>transform</B>(<A HREF="../../../../../../../org/apache/solr/search/grouping/distributed/shardresultserializer/ShardResultTransformer.html" title="type parameter in ShardResultTransformer">T</A>&nbsp;data)
162                    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>
163<DL>
164<DD>Transforms data to a <A HREF="../../../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util"><CODE>NamedList</CODE></A> structure for serialization purposes.
165<P>
166<DD><DL>
167<DT><B>Parameters:</B><DD><CODE>data</CODE> - The data to be transformed
168<DT><B>Returns:</B><DD><A HREF="../../../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util"><CODE>NamedList</CODE></A> structure
169<DT><B>Throws:</B>
170<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> - If I/O related errors occur during transforming</DL>
171</DD>
172</DL>
173<HR>
174
175<A NAME="transformToNative(org.apache.solr.common.util.NamedList, org.apache.lucene.search.Sort, org.apache.lucene.search.Sort, java.lang.String)"><!-- --></A><H3>
176transformToNative</H3>
177<PRE>
178<A HREF="../../../../../../../org/apache/solr/search/grouping/distributed/shardresultserializer/ShardResultTransformer.html" title="type parameter in ShardResultTransformer">R</A> <B>transformToNative</B>(<A HREF="../../../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&lt;<A HREF="../../../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&gt;&nbsp;shardResponse,
179                    <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Sort.html?is-external=true" title="class or interface in org.apache.lucene.search">Sort</A>&nbsp;groupSort,
180                    <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Sort.html?is-external=true" title="class or interface in org.apache.lucene.search">Sort</A>&nbsp;sortWithinGroup,
181                    <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;shard)
182                    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>
183<DL>
184<DD>Transforms the specified shard response into native structures.
185<P>
186<DD><DL>
187<DT><B>Parameters:</B><DD><CODE>shardResponse</CODE> - The shard response containing data in a <A HREF="../../../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util"><CODE>NamedList</CODE></A> structure<DD><CODE>groupSort</CODE> - The group sort<DD><CODE>sortWithinGroup</CODE> - The sort inside a group<DD><CODE>shard</CODE> - The shard address where the response originated from
188<DT><B>Returns:</B><DD>native structure of the data
189<DT><B>Throws:</B>
190<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> - If I/O related errors occur during transforming</DL>
191</DD>
192</DL>
193<!-- ========= END OF CLASS DATA ========= -->
194<HR>
195
196
197<!-- ======= START OF BOTTOM NAVBAR ====== -->
198<A NAME="navbar_bottom"><!-- --></A>
199<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
200<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
201<TR>
202<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
203<A NAME="navbar_bottom_firstrow"><!-- --></A>
204<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
205  <TR ALIGN="center" VALIGN="top">
206  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
207  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
208  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
209  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/ShardResultTransformer.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
210  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
211  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
212  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
213  </TR>
214</TABLE>
215</TD>
216<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
217</EM>
218</TD>
219</TR>
220
221<TR>
222<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
223&nbsp;<A HREF="../../../../../../../org/apache/solr/search/grouping/distributed/shardresultserializer/SearchGroupsResultTransformer.html" title="class in org.apache.solr.search.grouping.distributed.shardresultserializer"><B>PREV CLASS</B></A>&nbsp;
224&nbsp;<A HREF="../../../../../../../org/apache/solr/search/grouping/distributed/shardresultserializer/TopGroupsResultTransformer.html" title="class in org.apache.solr.search.grouping.distributed.shardresultserializer"><B>NEXT CLASS</B></A></FONT></TD>
225<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
226  <A HREF="../../../../../../../index.html?org/apache/solr/search/grouping/distributed/shardresultserializer/ShardResultTransformer.html" target="_top"><B>FRAMES</B></A>  &nbsp;
227&nbsp;<A HREF="ShardResultTransformer.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
228&nbsp;<SCRIPT type="text/javascript">
229  <!--
230  if(window==top) {
231    document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
232  }
233  //-->
234</SCRIPT>
235<NOSCRIPT>
236  <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
237</NOSCRIPT>
238
239
240</FONT></TD>
241</TR>
242<TR>
243<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
244  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
245<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
246DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
247</TR>
248</TABLE>
249<A NAME="skip-navbar_bottom"></A>
250<!-- ======== END OF BOTTOM NAVBAR ======= -->
251
252<HR>
253
254          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
255          <script src='../../../../../../../prettify.js' type='text/javascript'></script>
256          <script type='text/javascript'>
257            (function(){
258              var oldonload = window.onload;
259              if (typeof oldonload != 'function') {
260                window.onload = prettyPrint;
261              } else {
262                window.onload = function() {
263                  oldonload();
264                  prettyPrint();
265                }
266              }
267            })();
268          </script>
269       
270</BODY>
271</HTML>
Note: See TracBrowser for help on using the repository browser.