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

Revision 7588, 14.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>
8Command (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="Command (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/Command.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;PREV CLASS&nbsp;
59&nbsp;<A HREF="../../../../../org/apache/solr/search/grouping/CommandHandler.html" title="class in org.apache.solr.search.grouping"><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/Command.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="Command.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</FONT>
92<BR>
93Interface Command&lt;T&gt;</H2>
94<DL>
95<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/apache/solr/search/grouping/distributed/command/QueryCommand.html" title="class in org.apache.solr.search.grouping.distributed.command">QueryCommand</A>, <A HREF="../../../../../org/apache/solr/search/grouping/distributed/command/SearchGroupsFieldCommand.html" title="class in org.apache.solr.search.grouping.distributed.command">SearchGroupsFieldCommand</A>, <A HREF="../../../../../org/apache/solr/search/grouping/distributed/command/TopGroupsFieldCommand.html" title="class in org.apache.solr.search.grouping.distributed.command">TopGroupsFieldCommand</A></DD>
96</DL>
97<HR>
98<DL>
99<DT><PRE>public interface <B>Command&lt;T&gt;</B></DL>
100</PRE>
101
102<P>
103Defines a grouping command.
104 This is an abstraction on how the <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Collector.html?is-external=true" title="class or interface in org.apache.lucene.search"><CODE>Collector</CODE></A> instances are created
105 and how the results are retrieved from the <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Collector.html?is-external=true" title="class or interface in org.apache.lucene.search"><CODE>Collector</CODE></A> instances.
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="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Collector.html?is-external=true" title="class or interface in org.apache.lucene.search">Collector</A>&gt;</CODE></FONT></TD>
128<TD><CODE><B><A HREF="../../../../../org/apache/solr/search/grouping/Command.html#create()">create</A></B>()</CODE>
129
130<BR>
131&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a list of <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Collector.html?is-external=true" title="class or interface in org.apache.lucene.search"><CODE>Collector</CODE></A> instances to be
132 included in the search based on the .</TD>
133</TR>
134<TR BGCOLOR="white" CLASS="TableRowColor">
135<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
136<CODE>&nbsp;<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></CODE></FONT></TD>
137<TD><CODE><B><A HREF="../../../../../org/apache/solr/search/grouping/Command.html#getGroupSort()">getGroupSort</A></B>()</CODE>
138
139<BR>
140&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
141</TR>
142<TR BGCOLOR="white" CLASS="TableRowColor">
143<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
144<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>
145<TD><CODE><B><A HREF="../../../../../org/apache/solr/search/grouping/Command.html#getKey()">getKey</A></B>()</CODE>
146
147<BR>
148&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
149</TR>
150<TR BGCOLOR="white" CLASS="TableRowColor">
151<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
152<CODE>&nbsp;<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></CODE></FONT></TD>
153<TD><CODE><B><A HREF="../../../../../org/apache/solr/search/grouping/Command.html#getSortWithinGroup()">getSortWithinGroup</A></B>()</CODE>
154
155<BR>
156&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
157</TR>
158<TR BGCOLOR="white" CLASS="TableRowColor">
159<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
160<CODE>&nbsp;<A HREF="../../../../../org/apache/solr/search/grouping/Command.html" title="type parameter in Command">T</A></CODE></FONT></TD>
161<TD><CODE><B><A HREF="../../../../../org/apache/solr/search/grouping/Command.html#result()">result</A></B>()</CODE>
162
163<BR>
164&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the results that the collectors created
165 by <A HREF="../../../../../org/apache/solr/search/grouping/Command.html#create()"><CODE>create()</CODE></A> contain after a search has been executed.</TD>
166</TR>
167</TABLE>
168&nbsp;
169<P>
170
171<!-- ============ METHOD DETAIL ========== -->
172
173<A NAME="method_detail"><!-- --></A>
174<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
175<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
176<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
177<B>Method Detail</B></FONT></TH>
178</TR>
179</TABLE>
180
181<A NAME="create()"><!-- --></A><H3>
182create</H3>
183<PRE>
184<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Collector.html?is-external=true" title="class or interface in org.apache.lucene.search">Collector</A>&gt; <B>create</B>()
185                       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>
186<DL>
187<DD>Returns a list of <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Collector.html?is-external=true" title="class or interface in org.apache.lucene.search"><CODE>Collector</CODE></A> instances to be
188 included in the search based on the .
189<P>
190<DD><DL>
191
192<DT><B>Returns:</B><DD>a list of <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Collector.html?is-external=true" title="class or interface in org.apache.lucene.search"><CODE>Collector</CODE></A> instances
193<DT><B>Throws:</B>
194<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</DL>
195</DD>
196</DL>
197<HR>
198
199<A NAME="result()"><!-- --></A><H3>
200result</H3>
201<PRE>
202<A HREF="../../../../../org/apache/solr/search/grouping/Command.html" title="type parameter in Command">T</A> <B>result</B>()</PRE>
203<DL>
204<DD>Returns the results that the collectors created
205 by <A HREF="../../../../../org/apache/solr/search/grouping/Command.html#create()"><CODE>create()</CODE></A> contain after a search has been executed.
206<P>
207<DD><DL>
208
209<DT><B>Returns:</B><DD>The results of the collectors</DL>
210</DD>
211</DL>
212<HR>
213
214<A NAME="getKey()"><!-- --></A><H3>
215getKey</H3>
216<PRE>
217<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>getKey</B>()</PRE>
218<DL>
219<DD><DL>
220
221<DT><B>Returns:</B><DD>The key of this command to uniquely identify itself</DL>
222</DD>
223</DL>
224<HR>
225
226<A NAME="getGroupSort()"><!-- --></A><H3>
227getGroupSort</H3>
228<PRE>
229<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> <B>getGroupSort</B>()</PRE>
230<DL>
231<DD><DL>
232
233<DT><B>Returns:</B><DD>The group sort (overall sort)</DL>
234</DD>
235</DL>
236<HR>
237
238<A NAME="getSortWithinGroup()"><!-- --></A><H3>
239getSortWithinGroup</H3>
240<PRE>
241<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> <B>getSortWithinGroup</B>()</PRE>
242<DL>
243<DD><DL>
244
245<DT><B>Returns:</B><DD>The sort inside a group</DL>
246</DD>
247</DL>
248<!-- ========= END OF CLASS DATA ========= -->
249<HR>
250
251
252<!-- ======= START OF BOTTOM NAVBAR ====== -->
253<A NAME="navbar_bottom"><!-- --></A>
254<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
255<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
256<TR>
257<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
258<A NAME="navbar_bottom_firstrow"><!-- --></A>
259<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
260  <TR ALIGN="center" VALIGN="top">
261  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
262  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
263  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
264  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Command.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
265  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
266  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
267  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
268  </TR>
269</TABLE>
270</TD>
271<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
272</EM>
273</TD>
274</TR>
275
276<TR>
277<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
278&nbsp;PREV CLASS&nbsp;
279&nbsp;<A HREF="../../../../../org/apache/solr/search/grouping/CommandHandler.html" title="class in org.apache.solr.search.grouping"><B>NEXT CLASS</B></A></FONT></TD>
280<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
281  <A HREF="../../../../../index.html?org/apache/solr/search/grouping/Command.html" target="_top"><B>FRAMES</B></A>  &nbsp;
282&nbsp;<A HREF="Command.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
283&nbsp;<SCRIPT type="text/javascript">
284  <!--
285  if(window==top) {
286    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
287  }
288  //-->
289</SCRIPT>
290<NOSCRIPT>
291  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
292</NOSCRIPT>
293
294
295</FONT></TD>
296</TR>
297<TR>
298<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
299  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
300<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
301DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
302</TR>
303</TABLE>
304<A NAME="skip-navbar_bottom"></A>
305<!-- ======== END OF BOTTOM NAVBAR ======= -->
306
307<HR>
308
309          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
310          <script src='../../../../../prettify.js' type='text/javascript'></script>
311          <script type='text/javascript'>
312            (function(){
313              var oldonload = window.onload;
314              if (typeof oldonload != 'function') {
315                window.onload = prettyPrint;
316              } else {
317                window.onload = function() {
318                  oldonload();
319                  prettyPrint();
320                }
321              }
322            })();
323          </script>
324       
325</BODY>
326</HTML>
Note: See TracBrowser for help on using the repository browser.