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

Revision 7588, 30.2 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.CommandField (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.CommandField (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.CommandField.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.Command.html" title="class in org.apache.solr.search"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../org/apache/solr/search/Grouping.CommandFunc.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.CommandField.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="Grouping.CommandField.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.CommandField</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/search/Grouping.Command.html" title="class in org.apache.solr.search">org.apache.solr.search.Grouping.Command</A>&lt;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/BytesRef.html?is-external=true" title="class or interface in org.apache.lucene.util">BytesRef</A>&gt;
97      <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.solr.search.Grouping.CommandField</B>
98</PRE>
99<DL>
100<DT><B>Enclosing class:</B><DD><A HREF="../../../../org/apache/solr/search/Grouping.html" title="class in org.apache.solr.search">Grouping</A></DD>
101</DL>
102<HR>
103<DL>
104<DT><PRE>public class <B>Grouping.CommandField</B><DT>extends <A HREF="../../../../org/apache/solr/search/Grouping.Command.html" title="class in org.apache.solr.search">Grouping.Command</A>&lt;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/BytesRef.html?is-external=true" title="class or interface in org.apache.lucene.util">BytesRef</A>&gt;</DL>
105</PRE>
106
107<P>
108A group command for grouping on a field.
109<P>
110
111<P>
112<HR>
113
114<P>
115<!-- =========== FIELD SUMMARY =========== -->
116
117<A NAME="field_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>Field Summary</B></FONT></TH>
122</TR>
123<TR BGCOLOR="white" CLASS="TableRowColor">
124<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
125<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>
126<TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.CommandField.html#groupBy">groupBy</A></B></CODE>
127
128<BR>
129&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
130</TR>
131</TABLE>
132&nbsp;<A NAME="fields_inherited_from_class_org.apache.solr.search.Grouping.Command"><!-- --></A>
133<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
134<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
135<TH ALIGN="left"><B>Fields inherited from class org.apache.solr.search.<A HREF="../../../../org/apache/solr/search/Grouping.Command.html" title="class in org.apache.solr.search">Grouping.Command</A></B></TH>
136</TR>
137<TR BGCOLOR="white" CLASS="TableRowColor">
138<TD><CODE><A HREF="../../../../org/apache/solr/search/Grouping.Command.html#docsPerGroup">docsPerGroup</A>, <A HREF="../../../../org/apache/solr/search/Grouping.Command.html#format">format</A>, <A HREF="../../../../org/apache/solr/search/Grouping.Command.html#groupOffset">groupOffset</A>, <A HREF="../../../../org/apache/solr/search/Grouping.Command.html#groupSort">groupSort</A>, <A HREF="../../../../org/apache/solr/search/Grouping.Command.html#key">key</A>, <A HREF="../../../../org/apache/solr/search/Grouping.Command.html#main">main</A>, <A HREF="../../../../org/apache/solr/search/Grouping.Command.html#numGroups">numGroups</A>, <A HREF="../../../../org/apache/solr/search/Grouping.Command.html#offset">offset</A>, <A HREF="../../../../org/apache/solr/search/Grouping.Command.html#sort">sort</A>, <A HREF="../../../../org/apache/solr/search/Grouping.Command.html#totalCount">totalCount</A></CODE></TD>
139</TR>
140</TABLE>
141&nbsp;
142<!-- ======== CONSTRUCTOR SUMMARY ======== -->
143
144<A NAME="constructor_summary"><!-- --></A>
145<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
146<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
147<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
148<B>Constructor Summary</B></FONT></TH>
149</TR>
150<TR BGCOLOR="white" CLASS="TableRowColor">
151<TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.CommandField.html#Grouping.CommandField()">Grouping.CommandField</A></B>()</CODE>
152
153<BR>
154&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
155</TR>
156</TABLE>
157&nbsp;
158<!-- ========== METHOD SUMMARY =========== -->
159
160<A NAME="method_summary"><!-- --></A>
161<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
162<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
163<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
164<B>Method Summary</B></FONT></TH>
165</TR>
166<TR BGCOLOR="white" CLASS="TableRowColor">
167<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
168<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>
169<TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.CommandField.html#createAllGroupCollector()">createAllGroupCollector</A></B>()</CODE>
170
171<BR>
172&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>
173</TR>
174<TR BGCOLOR="white" CLASS="TableRowColor">
175<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
176<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>
177<TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.CommandField.html#createFirstPassCollector()">createFirstPassCollector</A></B>()</CODE>
178
179<BR>
180&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>
181</TR>
182<TR BGCOLOR="white" CLASS="TableRowColor">
183<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
184<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>
185<TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.CommandField.html#createSecondPassCollector()">createSecondPassCollector</A></B>()</CODE>
186
187<BR>
188&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>
189</TR>
190<TR BGCOLOR="white" CLASS="TableRowColor">
191<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
192<CODE>protected &nbsp;void</CODE></FONT></TD>
193<TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.CommandField.html#finish()">finish</A></B>()</CODE>
194
195<BR>
196&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Performs any necessary post actions to prepare the response.</TD>
197</TR>
198<TR BGCOLOR="white" CLASS="TableRowColor">
199<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
200<CODE>&nbsp;int</CODE></FONT></TD>
201<TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.CommandField.html#getMatches()">getMatches</A></B>()</CODE>
202
203<BR>
204&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of matches for this <code>Command</code>.</TD>
205</TR>
206<TR BGCOLOR="white" CLASS="TableRowColor">
207<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
208<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>
209<TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.CommandField.html#getNumberOfGroups()">getNumberOfGroups</A></B>()</CODE>
210
211<BR>
212&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of groups found for this <code>Command</code>.</TD>
213</TR>
214<TR BGCOLOR="white" CLASS="TableRowColor">
215<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
216<CODE>protected &nbsp;void</CODE></FONT></TD>
217<TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.CommandField.html#prepare()">prepare</A></B>()</CODE>
218
219<BR>
220&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Prepare this <code>Command</code> for execution.</TD>
221</TR>
222</TABLE>
223&nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.search.Grouping.Command"><!-- --></A>
224<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
225<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
226<TH ALIGN="left"><B>Methods inherited from class org.apache.solr.search.<A HREF="../../../../org/apache/solr/search/Grouping.Command.html" title="class in org.apache.solr.search">Grouping.Command</A></B></TH>
227</TR>
228<TR BGCOLOR="white" CLASS="TableRowColor">
229<TD><CODE><A HREF="../../../../org/apache/solr/search/Grouping.Command.html#addDocList(org.apache.solr.common.util.NamedList, org.apache.lucene.search.grouping.GroupDocs)">addDocList</A>, <A HREF="../../../../org/apache/solr/search/Grouping.Command.html#commonResponse()">commonResponse</A>, <A HREF="../../../../org/apache/solr/search/Grouping.Command.html#createSimpleResponse()">createSimpleResponse</A>, <A HREF="../../../../org/apache/solr/search/Grouping.Command.html#getDocList(org.apache.lucene.search.grouping.GroupDocs)">getDocList</A></CODE></TD>
230</TR>
231</TABLE>
232&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
233<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
234<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
235<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>
236</TR>
237<TR BGCOLOR="white" CLASS="TableRowColor">
238<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>
239</TR>
240</TABLE>
241&nbsp;
242<P>
243
244<!-- ============ FIELD DETAIL =========== -->
245
246<A NAME="field_detail"><!-- --></A>
247<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
248<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
249<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
250<B>Field Detail</B></FONT></TH>
251</TR>
252</TABLE>
253
254<A NAME="groupBy"><!-- --></A><H3>
255groupBy</H3>
256<PRE>
257public <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>groupBy</B></PRE>
258<DL>
259<DL>
260</DL>
261</DL>
262
263<!-- ========= CONSTRUCTOR DETAIL ======== -->
264
265<A NAME="constructor_detail"><!-- --></A>
266<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
267<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
268<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
269<B>Constructor Detail</B></FONT></TH>
270</TR>
271</TABLE>
272
273<A NAME="Grouping.CommandField()"><!-- --></A><H3>
274Grouping.CommandField</H3>
275<PRE>
276public <B>Grouping.CommandField</B>()</PRE>
277<DL>
278</DL>
279
280<!-- ============ METHOD DETAIL ========== -->
281
282<A NAME="method_detail"><!-- --></A>
283<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
284<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
285<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
286<B>Method Detail</B></FONT></TH>
287</TR>
288</TABLE>
289
290<A NAME="prepare()"><!-- --></A><H3>
291prepare</H3>
292<PRE>
293protected void <B>prepare</B>()
294                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>
295<DL>
296<DD>Prepare this <code>Command</code> for execution.
297<P>
298<DD><DL>
299<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/search/Grouping.Command.html#prepare()">prepare</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/search/Grouping.Command.html" title="class in org.apache.solr.search">Grouping.Command</A>&lt;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/BytesRef.html?is-external=true" title="class or interface in org.apache.lucene.util">BytesRef</A>&gt;</CODE></DL>
300</DD>
301<DD><DL>
302
303<DT><B>Throws:</B>
304<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>
305</DD>
306</DL>
307<HR>
308
309<A NAME="createFirstPassCollector()"><!-- --></A><H3>
310createFirstPassCollector</H3>
311<PRE>
312protected <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>()
313                                      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>
314<DL>
315<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.
316 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>.
317<P>
318<DD><DL>
319<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/search/Grouping.Command.html#createFirstPassCollector()">createFirstPassCollector</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/search/Grouping.Command.html" title="class in org.apache.solr.search">Grouping.Command</A>&lt;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/BytesRef.html?is-external=true" title="class or interface in org.apache.lucene.util">BytesRef</A>&gt;</CODE></DL>
320</DD>
321<DD><DL>
322
323<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
324<DT><B>Throws:</B>
325<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>
326</DD>
327</DL>
328<HR>
329
330<A NAME="createSecondPassCollector()"><!-- --></A><H3>
331createSecondPassCollector</H3>
332<PRE>
333protected <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>()
334                                       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>
335<DL>
336<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.
337 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.
338 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>.
339<P>
340<DD><DL>
341<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/solr/search/Grouping.Command.html#createSecondPassCollector()">createSecondPassCollector</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/search/Grouping.Command.html" title="class in org.apache.solr.search">Grouping.Command</A>&lt;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/BytesRef.html?is-external=true" title="class or interface in org.apache.lucene.util">BytesRef</A>&gt;</CODE></DL>
342</DD>
343<DD><DL>
344
345<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
346<DT><B>Throws:</B>
347<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>
348</DD>
349</DL>
350<HR>
351
352<A NAME="createAllGroupCollector()"><!-- --></A><H3>
353createAllGroupCollector</H3>
354<PRE>
355public <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>()
356                                                          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>
357<DL>
358<DD>Returns a collector that is able to return the most relevant document of all groups.
359 Returns <code>null</code> if the command doesn't support this type of collector.
360<P>
361<DD><DL>
362<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/solr/search/Grouping.Command.html#createAllGroupCollector()">createAllGroupCollector</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/search/Grouping.Command.html" title="class in org.apache.solr.search">Grouping.Command</A>&lt;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/BytesRef.html?is-external=true" title="class or interface in org.apache.lucene.util">BytesRef</A>&gt;</CODE></DL>
363</DD>
364<DD><DL>
365
366<DT><B>Returns:</B><DD>a collector that is able to return the most relevant document of all groups.
367<DT><B>Throws:</B>
368<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>
369</DD>
370</DL>
371<HR>
372
373<A NAME="finish()"><!-- --></A><H3>
374finish</H3>
375<PRE>
376protected void <B>finish</B>()
377               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>
378<DL>
379<DD>Performs any necessary post actions to prepare the response.
380<P>
381<DD><DL>
382<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/search/Grouping.Command.html#finish()">finish</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/search/Grouping.Command.html" title="class in org.apache.solr.search">Grouping.Command</A>&lt;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/BytesRef.html?is-external=true" title="class or interface in org.apache.lucene.util">BytesRef</A>&gt;</CODE></DL>
383</DD>
384<DD><DL>
385
386<DT><B>Throws:</B>
387<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>
388</DD>
389</DL>
390<HR>
391
392<A NAME="getMatches()"><!-- --></A><H3>
393getMatches</H3>
394<PRE>
395public int <B>getMatches</B>()</PRE>
396<DL>
397<DD>Returns the number of matches for this <code>Command</code>.
398<P>
399<DD><DL>
400<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/search/Grouping.Command.html#getMatches()">getMatches</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/search/Grouping.Command.html" title="class in org.apache.solr.search">Grouping.Command</A>&lt;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/BytesRef.html?is-external=true" title="class or interface in org.apache.lucene.util">BytesRef</A>&gt;</CODE></DL>
401</DD>
402<DD><DL>
403
404<DT><B>Returns:</B><DD>the number of matches for this <code>Command</code></DL>
405</DD>
406</DL>
407<HR>
408
409<A NAME="getNumberOfGroups()"><!-- --></A><H3>
410getNumberOfGroups</H3>
411<PRE>
412protected <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>
413<DL>
414<DD>Returns the number of groups found for this <code>Command</code>.
415 If the command doesn't support counting the groups <code>null</code> is returned.
416<P>
417<DD><DL>
418<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/solr/search/Grouping.Command.html#getNumberOfGroups()">getNumberOfGroups</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/search/Grouping.Command.html" title="class in org.apache.solr.search">Grouping.Command</A>&lt;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/util/BytesRef.html?is-external=true" title="class or interface in org.apache.lucene.util">BytesRef</A>&gt;</CODE></DL>
419</DD>
420<DD><DL>
421
422<DT><B>Returns:</B><DD>the number of groups found for this <code>Command</code></DL>
423</DD>
424</DL>
425<!-- ========= END OF CLASS DATA ========= -->
426<HR>
427
428
429<!-- ======= START OF BOTTOM NAVBAR ====== -->
430<A NAME="navbar_bottom"><!-- --></A>
431<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
432<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
433<TR>
434<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
435<A NAME="navbar_bottom_firstrow"><!-- --></A>
436<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
437  <TR ALIGN="center" VALIGN="top">
438  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
439  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
440  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
441  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Grouping.CommandField.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
442  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
443  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
444  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
445  </TR>
446</TABLE>
447</TD>
448<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
449</EM>
450</TD>
451</TR>
452
453<TR>
454<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
455&nbsp;<A HREF="../../../../org/apache/solr/search/Grouping.Command.html" title="class in org.apache.solr.search"><B>PREV CLASS</B></A>&nbsp;
456&nbsp;<A HREF="../../../../org/apache/solr/search/Grouping.CommandFunc.html" title="class in org.apache.solr.search"><B>NEXT CLASS</B></A></FONT></TD>
457<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
458  <A HREF="../../../../index.html?org/apache/solr/search/Grouping.CommandField.html" target="_top"><B>FRAMES</B></A>  &nbsp;
459&nbsp;<A HREF="Grouping.CommandField.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
460&nbsp;<SCRIPT type="text/javascript">
461  <!--
462  if(window==top) {
463    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
464  }
465  //-->
466</SCRIPT>
467<NOSCRIPT>
468  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
469</NOSCRIPT>
470
471
472</FONT></TD>
473</TR>
474<TR>
475<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
476  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>
477<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
478DETAIL:&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>
479</TR>
480</TABLE>
481<A NAME="skip-navbar_bottom"></A>
482<!-- ======== END OF BOTTOM NAVBAR ======= -->
483
484<HR>
485
486          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
487          <script src='../../../../prettify.js' type='text/javascript'></script>
488          <script type='text/javascript'>
489            (function(){
490              var oldonload = window.onload;
491              if (typeof oldonload != 'function') {
492                window.onload = prettyPrint;
493              } else {
494                window.onload = function() {
495                  oldonload();
496                  prettyPrint();
497                }
498              }
499            })();
500          </script>
501       
502</BODY>
503</HTML>
Note: See TracBrowser for help on using the repository browser.