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

Revision 7588, 33.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>
8Grouping.Command (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="Grouping.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/Grouping.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;<A HREF="../../../../org/apache/solr/search/Grouping.html" title="class in org.apache.solr.search"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../org/apache/solr/search/Grouping.CommandField.html" title="class in org.apache.solr.search"><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="Grouping.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;<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.search</FONT>
92<BR>
93Class Grouping.Command&lt;GROUP_VALUE_TYPE&gt;</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.Command&lt;GROUP_VALUE_TYPE&gt;</B>
97</PRE>
98<DL>
99<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/solr/search/Grouping.CommandField.html" title="class in org.apache.solr.search">Grouping.CommandField</A>, <A HREF="../../../../org/apache/solr/search/Grouping.CommandFunc.html" title="class in org.apache.solr.search">Grouping.CommandFunc</A>, <A HREF="../../../../org/apache/solr/search/Grouping.CommandQuery.html" title="class in org.apache.solr.search">Grouping.CommandQuery</A></DD>
100</DL>
101<DL>
102<DT><B>Enclosing class:</B><DD><A HREF="../../../../org/apache/solr/search/Grouping.html" title="class in org.apache.solr.search">Grouping</A></DD>
103</DL>
104<HR>
105<DL>
106<DT><PRE>public abstract class <B>Grouping.Command&lt;GROUP_VALUE_TYPE&gt;</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></DL>
107</PRE>
108
109<P>
110General group command. A group command is responsible for creating the first and second pass collectors.
111 A group command is also responsible for creating the response structure.
112 <p/>
113 Note: Maybe the creating the response structure should be done in something like a ReponseBuilder???
114 Warning NOT thread save!
115<P>
116
117<P>
118<HR>
119
120<P>
121<!-- =========== FIELD SUMMARY =========== -->
122
123<A NAME="field_summary"><!-- --></A>
124<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
125<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
126<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
127<B>Field Summary</B></FONT></TH>
128</TR>
129<TR BGCOLOR="white" CLASS="TableRowColor">
130<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
131<CODE>&nbsp;int</CODE></FONT></TD>
132<TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.Command.html#docsPerGroup">docsPerGroup</A></B></CODE>
133
134<BR>
135&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
136</TR>
137<TR BGCOLOR="white" CLASS="TableRowColor">
138<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
139<CODE>&nbsp;<A HREF="../../../../org/apache/solr/search/Grouping.Format.html" title="enum in org.apache.solr.search">Grouping.Format</A></CODE></FONT></TD>
140<TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.Command.html#format">format</A></B></CODE>
141
142<BR>
143&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
144</TR>
145<TR BGCOLOR="white" CLASS="TableRowColor">
146<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
147<CODE>&nbsp;int</CODE></FONT></TD>
148<TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.Command.html#groupOffset">groupOffset</A></B></CODE>
149
150<BR>
151&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
152</TR>
153<TR BGCOLOR="white" CLASS="TableRowColor">
154<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
155<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>
156<TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.Command.html#groupSort">groupSort</A></B></CODE>
157
158<BR>
159&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
160</TR>
161<TR BGCOLOR="white" CLASS="TableRowColor">
162<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
163<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>
164<TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.Command.html#key">key</A></B></CODE>
165
166<BR>
167&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
168</TR>
169<TR BGCOLOR="white" CLASS="TableRowColor">
170<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
171<CODE>&nbsp;boolean</CODE></FONT></TD>
172<TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.Command.html#main">main</A></B></CODE>
173
174<BR>
175&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
176</TR>
177<TR BGCOLOR="white" CLASS="TableRowColor">
178<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
179<CODE>&nbsp;int</CODE></FONT></TD>
180<TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.Command.html#numGroups">numGroups</A></B></CODE>
181
182<BR>
183&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
184</TR>
185<TR BGCOLOR="white" CLASS="TableRowColor">
186<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
187<CODE>&nbsp;int</CODE></FONT></TD>
188<TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.Command.html#offset">offset</A></B></CODE>
189
190<BR>
191&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
192</TR>
193<TR BGCOLOR="white" CLASS="TableRowColor">
194<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
195<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>
196<TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.Command.html#sort">sort</A></B></CODE>
197
198<BR>
199&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
200</TR>
201<TR BGCOLOR="white" CLASS="TableRowColor">
202<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
203<CODE>&nbsp;<A HREF="../../../../org/apache/solr/search/Grouping.TotalCount.html" title="enum in org.apache.solr.search">Grouping.TotalCount</A></CODE></FONT></TD>
204<TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.Command.html#totalCount">totalCount</A></B></CODE>
205
206<BR>
207&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
208</TR>
209</TABLE>
210&nbsp;
211<!-- ======== CONSTRUCTOR SUMMARY ======== -->
212
213<A NAME="constructor_summary"><!-- --></A>
214<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
215<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
216<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
217<B>Constructor Summary</B></FONT></TH>
218</TR>
219<TR BGCOLOR="white" CLASS="TableRowColor">
220<TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.Command.html#Grouping.Command()">Grouping.Command</A></B>()</CODE>
221
222<BR>
223&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
224</TR>
225</TABLE>
226&nbsp;
227<!-- ========== METHOD SUMMARY =========== -->
228
229<A NAME="method_summary"><!-- --></A>
230<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
231<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
232<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
233<B>Method Summary</B></FONT></TH>
234</TR>
235<TR BGCOLOR="white" CLASS="TableRowColor">
236<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
237<CODE>protected &nbsp;void</CODE></FONT></TD>
238<TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.Command.html#addDocList(org.apache.solr.common.util.NamedList, org.apache.lucene.search.grouping.GroupDocs)">addDocList</A></B>(<A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&nbsp;rsp,
239           <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//grouping/org/apache/lucene/search/grouping/GroupDocs.html?is-external=true" title="class or interface in org.apache.lucene.search.grouping">GroupDocs</A>&nbsp;groups)</CODE>
240
241<BR>
242&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
243</TR>
244<TR BGCOLOR="white" CLASS="TableRowColor">
245<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
246<CODE>protected &nbsp;<A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A></CODE></FONT></TD>
247<TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.Command.html#commonResponse()">commonResponse</A></B>()</CODE>
248
249<BR>
250&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
251</TR>
252<TR BGCOLOR="white" CLASS="TableRowColor">
253<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
254<CODE>&nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//grouping/org/apache/lucene/search/grouping/AbstractAllGroupHeadsCollector.html?is-external=true" title="class or interface in org.apache.lucene.search.grouping">AbstractAllGroupHeadsCollector</A>&lt;?&gt;</CODE></FONT></TD>
255<TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.Command.html#createAllGroupCollector()">createAllGroupCollector</A></B>()</CODE>
256
257<BR>
258&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a collector that is able to return the most relevant document of all groups.</TD>
259</TR>
260<TR BGCOLOR="white" CLASS="TableRowColor">
261<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
262<CODE>protected abstract &nbsp;<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></CODE></FONT></TD>
263<TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.Command.html#createFirstPassCollector()">createFirstPassCollector</A></B>()</CODE>
264
265<BR>
266&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns one or more <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 that are needed to perform the first pass search.</TD>
267</TR>
268<TR BGCOLOR="white" CLASS="TableRowColor">
269<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
270<CODE>protected &nbsp;<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></CODE></FONT></TD>
271<TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.Command.html#createSecondPassCollector()">createSecondPassCollector</A></B>()</CODE>
272
273<BR>
274&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns zero or more <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 that are needed to perform the second pass search.</TD>
275</TR>
276<TR BGCOLOR="white" CLASS="TableRowColor">
277<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
278<CODE>protected &nbsp;<A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A></CODE></FONT></TD>
279<TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.Command.html#createSimpleResponse()">createSimpleResponse</A></B>()</CODE>
280
281<BR>
282&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
283</TR>
284<TR BGCOLOR="white" CLASS="TableRowColor">
285<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
286<CODE>protected abstract &nbsp;void</CODE></FONT></TD>
287<TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.Command.html#finish()">finish</A></B>()</CODE>
288
289<BR>
290&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Performs any necessary post actions to prepare the response.</TD>
291</TR>
292<TR BGCOLOR="white" CLASS="TableRowColor">
293<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
294<CODE>protected &nbsp;<A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A></CODE></FONT></TD>
295<TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.Command.html#getDocList(org.apache.lucene.search.grouping.GroupDocs)">getDocList</A></B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//grouping/org/apache/lucene/search/grouping/GroupDocs.html?is-external=true" title="class or interface in org.apache.lucene.search.grouping">GroupDocs</A>&nbsp;groups)</CODE>
296
297<BR>
298&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
299</TR>
300<TR BGCOLOR="white" CLASS="TableRowColor">
301<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
302<CODE>abstract &nbsp;int</CODE></FONT></TD>
303<TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.Command.html#getMatches()">getMatches</A></B>()</CODE>
304
305<BR>
306&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of matches for this <code>Command</code>.</TD>
307</TR>
308<TR BGCOLOR="white" CLASS="TableRowColor">
309<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
310<CODE>protected &nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</A></CODE></FONT></TD>
311<TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.Command.html#getNumberOfGroups()">getNumberOfGroups</A></B>()</CODE>
312
313<BR>
314&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of groups found for this <code>Command</code>.</TD>
315</TR>
316<TR BGCOLOR="white" CLASS="TableRowColor">
317<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
318<CODE>protected abstract &nbsp;void</CODE></FONT></TD>
319<TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.Command.html#prepare()">prepare</A></B>()</CODE>
320
321<BR>
322&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Prepare this <code>Command</code> for execution.</TD>
323</TR>
324</TABLE>
325&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
326<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
327<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
328<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>
329</TR>
330<TR BGCOLOR="white" CLASS="TableRowColor">
331<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>
332</TR>
333</TABLE>
334&nbsp;
335<P>
336
337<!-- ============ FIELD DETAIL =========== -->
338
339<A NAME="field_detail"><!-- --></A>
340<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
341<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
342<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
343<B>Field Detail</B></FONT></TH>
344</TR>
345</TABLE>
346
347<A NAME="key"><!-- --></A><H3>
348key</H3>
349<PRE>
350public <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>key</B></PRE>
351<DL>
352<DL>
353</DL>
354</DL>
355<HR>
356
357<A NAME="groupSort"><!-- --></A><H3>
358groupSort</H3>
359<PRE>
360public <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>groupSort</B></PRE>
361<DL>
362<DL>
363</DL>
364</DL>
365<HR>
366
367<A NAME="sort"><!-- --></A><H3>
368sort</H3>
369<PRE>
370public <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>sort</B></PRE>
371<DL>
372<DL>
373</DL>
374</DL>
375<HR>
376
377<A NAME="docsPerGroup"><!-- --></A><H3>
378docsPerGroup</H3>
379<PRE>
380public int <B>docsPerGroup</B></PRE>
381<DL>
382<DL>
383</DL>
384</DL>
385<HR>
386
387<A NAME="groupOffset"><!-- --></A><H3>
388groupOffset</H3>
389<PRE>
390public int <B>groupOffset</B></PRE>
391<DL>
392<DL>
393</DL>
394</DL>
395<HR>
396
397<A NAME="numGroups"><!-- --></A><H3>
398numGroups</H3>
399<PRE>
400public int <B>numGroups</B></PRE>
401<DL>
402<DL>
403</DL>
404</DL>
405<HR>
406
407<A NAME="offset"><!-- --></A><H3>
408offset</H3>
409<PRE>
410public int <B>offset</B></PRE>
411<DL>
412<DL>
413</DL>
414</DL>
415<HR>
416
417<A NAME="format"><!-- --></A><H3>
418format</H3>
419<PRE>
420public <A HREF="../../../../org/apache/solr/search/Grouping.Format.html" title="enum in org.apache.solr.search">Grouping.Format</A> <B>format</B></PRE>
421<DL>
422<DL>
423</DL>
424</DL>
425<HR>
426
427<A NAME="main"><!-- --></A><H3>
428main</H3>
429<PRE>
430public boolean <B>main</B></PRE>
431<DL>
432<DL>
433</DL>
434</DL>
435<HR>
436
437<A NAME="totalCount"><!-- --></A><H3>
438totalCount</H3>
439<PRE>
440public <A HREF="../../../../org/apache/solr/search/Grouping.TotalCount.html" title="enum in org.apache.solr.search">Grouping.TotalCount</A> <B>totalCount</B></PRE>
441<DL>
442<DL>
443</DL>
444</DL>
445
446<!-- ========= CONSTRUCTOR DETAIL ======== -->
447
448<A NAME="constructor_detail"><!-- --></A>
449<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
450<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
451<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
452<B>Constructor Detail</B></FONT></TH>
453</TR>
454</TABLE>
455
456<A NAME="Grouping.Command()"><!-- --></A><H3>
457Grouping.Command</H3>
458<PRE>
459public <B>Grouping.Command</B>()</PRE>
460<DL>
461</DL>
462
463<!-- ============ METHOD DETAIL ========== -->
464
465<A NAME="method_detail"><!-- --></A>
466<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
467<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
468<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
469<B>Method Detail</B></FONT></TH>
470</TR>
471</TABLE>
472
473<A NAME="prepare()"><!-- --></A><H3>
474prepare</H3>
475<PRE>
476protected abstract void <B>prepare</B>()
477                         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>
478<DL>
479<DD>Prepare this <code>Command</code> for execution.
480<P>
481<DD><DL>
482
483<DT><B>Throws:</B>
484<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>
485</DD>
486</DL>
487<HR>
488
489<A NAME="createFirstPassCollector()"><!-- --></A><H3>
490createFirstPassCollector</H3>
491<PRE>
492protected abstract <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> <B>createFirstPassCollector</B>()
493                                               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>
494<DL>
495<DD>Returns one or more <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 that are needed to perform the first pass search.
496 If multiple Collectors are returned then these wrapped in a <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/MultiCollector.html?is-external=true" title="class or interface in org.apache.lucene.search"><CODE>MultiCollector</CODE></A>.
497<P>
498<DD><DL>
499
500<DT><B>Returns:</B><DD>one or more <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 that are need to perform the first pass search
501<DT><B>Throws:</B>
502<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>
503</DD>
504</DL>
505<HR>
506
507<A NAME="createSecondPassCollector()"><!-- --></A><H3>
508createSecondPassCollector</H3>
509<PRE>
510protected <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> <B>createSecondPassCollector</B>()
511                                       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>
512<DL>
513<DD>Returns zero or more <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 that are needed to perform the second pass search.
514 In the case when no <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 <code>null</code> is returned.
515 If multiple Collectors are returned then these wrapped in a <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/MultiCollector.html?is-external=true" title="class or interface in org.apache.lucene.search"><CODE>MultiCollector</CODE></A>.
516<P>
517<DD><DL>
518
519<DT><B>Returns:</B><DD>zero or more <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 that are needed to perform the second pass search
520<DT><B>Throws:</B>
521<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>
522</DD>
523</DL>
524<HR>
525
526<A NAME="createAllGroupCollector()"><!-- --></A><H3>
527createAllGroupCollector</H3>
528<PRE>
529public <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//grouping/org/apache/lucene/search/grouping/AbstractAllGroupHeadsCollector.html?is-external=true" title="class or interface in org.apache.lucene.search.grouping">AbstractAllGroupHeadsCollector</A>&lt;?&gt; <B>createAllGroupCollector</B>()
530                                                          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>
531<DL>
532<DD>Returns a collector that is able to return the most relevant document of all groups.
533 Returns <code>null</code> if the command doesn't support this type of collector.
534<P>
535<DD><DL>
536
537<DT><B>Returns:</B><DD>a collector that is able to return the most relevant document of all groups.
538<DT><B>Throws:</B>
539<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>
540</DD>
541</DL>
542<HR>
543
544<A NAME="finish()"><!-- --></A><H3>
545finish</H3>
546<PRE>
547protected abstract void <B>finish</B>()
548                        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>
549<DL>
550<DD>Performs any necessary post actions to prepare the response.
551<P>
552<DD><DL>
553
554<DT><B>Throws:</B>
555<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>
556</DD>
557</DL>
558<HR>
559
560<A NAME="getMatches()"><!-- --></A><H3>
561getMatches</H3>
562<PRE>
563public abstract int <B>getMatches</B>()</PRE>
564<DL>
565<DD>Returns the number of matches for this <code>Command</code>.
566<P>
567<DD><DL>
568
569<DT><B>Returns:</B><DD>the number of matches for this <code>Command</code></DL>
570</DD>
571</DL>
572<HR>
573
574<A NAME="getNumberOfGroups()"><!-- --></A><H3>
575getNumberOfGroups</H3>
576<PRE>
577protected <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</A> <B>getNumberOfGroups</B>()</PRE>
578<DL>
579<DD>Returns the number of groups found for this <code>Command</code>.
580 If the command doesn't support counting the groups <code>null</code> is returned.
581<P>
582<DD><DL>
583
584<DT><B>Returns:</B><DD>the number of groups found for this <code>Command</code></DL>
585</DD>
586</DL>
587<HR>
588
589<A NAME="commonResponse()"><!-- --></A><H3>
590commonResponse</H3>
591<PRE>
592protected <A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A> <B>commonResponse</B>()</PRE>
593<DL>
594<DD><DL>
595</DL>
596</DD>
597</DL>
598<HR>
599
600<A NAME="getDocList(org.apache.lucene.search.grouping.GroupDocs)"><!-- --></A><H3>
601getDocList</H3>
602<PRE>
603protected <A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A> <B>getDocList</B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//grouping/org/apache/lucene/search/grouping/GroupDocs.html?is-external=true" title="class or interface in org.apache.lucene.search.grouping">GroupDocs</A>&nbsp;groups)</PRE>
604<DL>
605<DD><DL>
606</DL>
607</DD>
608</DL>
609<HR>
610
611<A NAME="addDocList(org.apache.solr.common.util.NamedList, org.apache.lucene.search.grouping.GroupDocs)"><!-- --></A><H3>
612addDocList</H3>
613<PRE>
614protected void <B>addDocList</B>(<A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&nbsp;rsp,
615                          <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//grouping/org/apache/lucene/search/grouping/GroupDocs.html?is-external=true" title="class or interface in org.apache.lucene.search.grouping">GroupDocs</A>&nbsp;groups)</PRE>
616<DL>
617<DD><DL>
618</DL>
619</DD>
620</DL>
621<HR>
622
623<A NAME="createSimpleResponse()"><!-- --></A><H3>
624createSimpleResponse</H3>
625<PRE>
626protected <A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A> <B>createSimpleResponse</B>()</PRE>
627<DL>
628<DD><DL>
629</DL>
630</DD>
631</DL>
632<!-- ========= END OF CLASS DATA ========= -->
633<HR>
634
635
636<!-- ======= START OF BOTTOM NAVBAR ====== -->
637<A NAME="navbar_bottom"><!-- --></A>
638<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
639<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
640<TR>
641<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
642<A NAME="navbar_bottom_firstrow"><!-- --></A>
643<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
644  <TR ALIGN="center" VALIGN="top">
645  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
646  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
647  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
648  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Grouping.Command.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
649  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
650  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
651  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
652  </TR>
653</TABLE>
654</TD>
655<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
656</EM>
657</TD>
658</TR>
659
660<TR>
661<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
662&nbsp;<A HREF="../../../../org/apache/solr/search/Grouping.html" title="class in org.apache.solr.search"><B>PREV CLASS</B></A>&nbsp;
663&nbsp;<A HREF="../../../../org/apache/solr/search/Grouping.CommandField.html" title="class in org.apache.solr.search"><B>NEXT CLASS</B></A></FONT></TD>
664<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
665  <A HREF="../../../../index.html?org/apache/solr/search/Grouping.Command.html" target="_top"><B>FRAMES</B></A>  &nbsp;
666&nbsp;<A HREF="Grouping.Command.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
667&nbsp;<SCRIPT type="text/javascript">
668  <!--
669  if(window==top) {
670    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
671  }
672  //-->
673</SCRIPT>
674<NOSCRIPT>
675  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
676</NOSCRIPT>
677
678
679</FONT></TD>
680</TR>
681<TR>
682<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
683  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>
684<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
685DETAIL:&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>
686</TR>
687</TABLE>
688<A NAME="skip-navbar_bottom"></A>
689<!-- ======== END OF BOTTOM NAVBAR ======= -->
690
691<HR>
692
693          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
694          <script src='../../../../prettify.js' type='text/javascript'></script>
695          <script type='text/javascript'>
696            (function(){
697              var oldonload = window.onload;
698              if (typeof oldonload != 'function') {
699                window.onload = prettyPrint;
700              } else {
701                window.onload = function() {
702                  oldonload();
703                  prettyPrint();
704                }
705              }
706            })();
707          </script>
708       
709</BODY>
710</HTML>
Note: See TracBrowser for help on using the repository browser.