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

Revision 7588, 27.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>
8SearchGroupsFieldCommand (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="SearchGroupsFieldCommand (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/SearchGroupsFieldCommand.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/command/QueryCommandResult.html" title="class in org.apache.solr.search.grouping.distributed.command"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../../../../org/apache/solr/search/grouping/distributed/command/SearchGroupsFieldCommand.Builder.html" title="class in org.apache.solr.search.grouping.distributed.command"><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/command/SearchGroupsFieldCommand.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="SearchGroupsFieldCommand.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;<A HREF="#nested_class_summary">NESTED</A>&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.command</FONT>
92<BR>
93Class SearchGroupsFieldCommand</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.distributed.command.SearchGroupsFieldCommand</B>
97</PRE>
98<DL>
99<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../../../org/apache/solr/search/grouping/Command.html" title="interface in org.apache.solr.search.grouping">Command</A>&lt;<A HREF="../../../../../../../org/apache/solr/search/grouping/distributed/command/Pair.html" title="class in org.apache.solr.search.grouping.distributed.command">Pair</A>&lt;<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>,<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<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">SearchGroup</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;&gt;&gt;&gt;</DD>
100</DL>
101<HR>
102<DL>
103<DT><PRE>public class <B>SearchGroupsFieldCommand</B><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="../../../../../../../org/apache/solr/search/grouping/Command.html" title="interface in org.apache.solr.search.grouping">Command</A>&lt;<A HREF="../../../../../../../org/apache/solr/search/grouping/distributed/command/Pair.html" title="class in org.apache.solr.search.grouping.distributed.command">Pair</A>&lt;<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>,<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<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">SearchGroup</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;&gt;&gt;&gt;</DL>
104</PRE>
105
106<P>
107Creates all the collectors needed for the first phase and how to handle the results.
108<P>
109
110<P>
111<HR>
112
113<P>
114<!-- ======== NESTED CLASS SUMMARY ======== -->
115
116<A NAME="nested_class_summary"><!-- --></A>
117<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
118<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
119<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
120<B>Nested Class Summary</B></FONT></TH>
121</TR>
122<TR BGCOLOR="white" CLASS="TableRowColor">
123<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
124<CODE>static&nbsp;class</CODE></FONT></TD>
125<TD><CODE><B><A HREF="../../../../../../../org/apache/solr/search/grouping/distributed/command/SearchGroupsFieldCommand.Builder.html" title="class in org.apache.solr.search.grouping.distributed.command">SearchGroupsFieldCommand.Builder</A></B></CODE>
126
127<BR>
128&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
129</TR>
130</TABLE>
131&nbsp;
132<!-- ========== METHOD SUMMARY =========== -->
133
134<A NAME="method_summary"><!-- --></A>
135<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
136<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
137<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
138<B>Method Summary</B></FONT></TH>
139</TR>
140<TR BGCOLOR="white" CLASS="TableRowColor">
141<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
142<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>
143<TD><CODE><B><A HREF="../../../../../../../org/apache/solr/search/grouping/distributed/command/SearchGroupsFieldCommand.html#create()">create</A></B>()</CODE>
144
145<BR>
146&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
147 included in the search based on the .</TD>
148</TR>
149<TR BGCOLOR="white" CLASS="TableRowColor">
150<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
151<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>
152<TD><CODE><B><A HREF="../../../../../../../org/apache/solr/search/grouping/distributed/command/SearchGroupsFieldCommand.html#getGroupSort()">getGroupSort</A></B>()</CODE>
153
154<BR>
155&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
156</TR>
157<TR BGCOLOR="white" CLASS="TableRowColor">
158<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
159<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>
160<TD><CODE><B><A HREF="../../../../../../../org/apache/solr/search/grouping/distributed/command/SearchGroupsFieldCommand.html#getKey()">getKey</A></B>()</CODE>
161
162<BR>
163&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
164</TR>
165<TR BGCOLOR="white" CLASS="TableRowColor">
166<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
167<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>
168<TD><CODE><B><A HREF="../../../../../../../org/apache/solr/search/grouping/distributed/command/SearchGroupsFieldCommand.html#getSortWithinGroup()">getSortWithinGroup</A></B>()</CODE>
169
170<BR>
171&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
172</TR>
173<TR BGCOLOR="white" CLASS="TableRowColor">
174<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
175<CODE>&nbsp;<A HREF="../../../../../../../org/apache/solr/search/grouping/distributed/command/Pair.html" title="class in org.apache.solr.search.grouping.distributed.command">Pair</A>&lt;<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>,<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<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">SearchGroup</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;&gt;&gt;</CODE></FONT></TD>
176<TD><CODE><B><A HREF="../../../../../../../org/apache/solr/search/grouping/distributed/command/SearchGroupsFieldCommand.html#result()">result</A></B>()</CODE>
177
178<BR>
179&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the results that the collectors created
180 by <A HREF="../../../../../../../org/apache/solr/search/grouping/Command.html#create()"><CODE>Command.create()</CODE></A> contain after a search has been executed.</TD>
181</TR>
182</TABLE>
183&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
184<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
185<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
186<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>
187</TR>
188<TR BGCOLOR="white" CLASS="TableRowColor">
189<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>
190</TR>
191</TABLE>
192&nbsp;
193<P>
194
195<!-- ============ METHOD DETAIL ========== -->
196
197<A NAME="method_detail"><!-- --></A>
198<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
199<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
200<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
201<B>Method Detail</B></FONT></TH>
202</TR>
203</TABLE>
204
205<A NAME="create()"><!-- --></A><H3>
206create</H3>
207<PRE>
208public <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>()
209                       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>
210<DL>
211<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../../org/apache/solr/search/grouping/Command.html#create()">Command</A></CODE></B></DD>
212<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
213 included in the search based on the .
214<P>
215<DD><DL>
216<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/apache/solr/search/grouping/Command.html#create()">create</A></CODE> in interface <CODE><A HREF="../../../../../../../org/apache/solr/search/grouping/Command.html" title="interface in org.apache.solr.search.grouping">Command</A>&lt;<A HREF="../../../../../../../org/apache/solr/search/grouping/distributed/command/Pair.html" title="class in org.apache.solr.search.grouping.distributed.command">Pair</A>&lt;<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>,<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<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">SearchGroup</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;&gt;&gt;&gt;</CODE></DL>
217</DD>
218<DD><DL>
219
220<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
221<DT><B>Throws:</B>
222<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>
223</DD>
224</DL>
225<HR>
226
227<A NAME="result()"><!-- --></A><H3>
228result</H3>
229<PRE>
230public <A HREF="../../../../../../../org/apache/solr/search/grouping/distributed/command/Pair.html" title="class in org.apache.solr.search.grouping.distributed.command">Pair</A>&lt;<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>,<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<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">SearchGroup</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;&gt;&gt; <B>result</B>()</PRE>
231<DL>
232<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../../org/apache/solr/search/grouping/Command.html#result()">Command</A></CODE></B></DD>
233<DD>Returns the results that the collectors created
234 by <A HREF="../../../../../../../org/apache/solr/search/grouping/Command.html#create()"><CODE>Command.create()</CODE></A> contain after a search has been executed.
235<P>
236<DD><DL>
237<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/apache/solr/search/grouping/Command.html#result()">result</A></CODE> in interface <CODE><A HREF="../../../../../../../org/apache/solr/search/grouping/Command.html" title="interface in org.apache.solr.search.grouping">Command</A>&lt;<A HREF="../../../../../../../org/apache/solr/search/grouping/distributed/command/Pair.html" title="class in org.apache.solr.search.grouping.distributed.command">Pair</A>&lt;<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>,<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<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">SearchGroup</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;&gt;&gt;&gt;</CODE></DL>
238</DD>
239<DD><DL>
240
241<DT><B>Returns:</B><DD>The results of the collectors</DL>
242</DD>
243</DL>
244<HR>
245
246<A NAME="getSortWithinGroup()"><!-- --></A><H3>
247getSortWithinGroup</H3>
248<PRE>
249public <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>
250<DL>
251<DD><DL>
252<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/apache/solr/search/grouping/Command.html#getSortWithinGroup()">getSortWithinGroup</A></CODE> in interface <CODE><A HREF="../../../../../../../org/apache/solr/search/grouping/Command.html" title="interface in org.apache.solr.search.grouping">Command</A>&lt;<A HREF="../../../../../../../org/apache/solr/search/grouping/distributed/command/Pair.html" title="class in org.apache.solr.search.grouping.distributed.command">Pair</A>&lt;<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>,<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<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">SearchGroup</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;&gt;&gt;&gt;</CODE></DL>
253</DD>
254<DD><DL>
255
256<DT><B>Returns:</B><DD>The sort inside a group</DL>
257</DD>
258</DL>
259<HR>
260
261<A NAME="getGroupSort()"><!-- --></A><H3>
262getGroupSort</H3>
263<PRE>
264public <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>
265<DL>
266<DD><DL>
267<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/apache/solr/search/grouping/Command.html#getGroupSort()">getGroupSort</A></CODE> in interface <CODE><A HREF="../../../../../../../org/apache/solr/search/grouping/Command.html" title="interface in org.apache.solr.search.grouping">Command</A>&lt;<A HREF="../../../../../../../org/apache/solr/search/grouping/distributed/command/Pair.html" title="class in org.apache.solr.search.grouping.distributed.command">Pair</A>&lt;<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>,<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<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">SearchGroup</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;&gt;&gt;&gt;</CODE></DL>
268</DD>
269<DD><DL>
270
271<DT><B>Returns:</B><DD>The group sort (overall sort)</DL>
272</DD>
273</DL>
274<HR>
275
276<A NAME="getKey()"><!-- --></A><H3>
277getKey</H3>
278<PRE>
279public <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>
280<DL>
281<DD><DL>
282<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/apache/solr/search/grouping/Command.html#getKey()">getKey</A></CODE> in interface <CODE><A HREF="../../../../../../../org/apache/solr/search/grouping/Command.html" title="interface in org.apache.solr.search.grouping">Command</A>&lt;<A HREF="../../../../../../../org/apache/solr/search/grouping/distributed/command/Pair.html" title="class in org.apache.solr.search.grouping.distributed.command">Pair</A>&lt;<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>,<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<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">SearchGroup</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;&gt;&gt;&gt;</CODE></DL>
283</DD>
284<DD><DL>
285
286<DT><B>Returns:</B><DD>The key of this command to uniquely identify itself</DL>
287</DD>
288</DL>
289<!-- ========= END OF CLASS DATA ========= -->
290<HR>
291
292
293<!-- ======= START OF BOTTOM NAVBAR ====== -->
294<A NAME="navbar_bottom"><!-- --></A>
295<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
296<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
297<TR>
298<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
299<A NAME="navbar_bottom_firstrow"><!-- --></A>
300<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
301  <TR ALIGN="center" VALIGN="top">
302  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
303  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
304  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
305  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/SearchGroupsFieldCommand.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
306  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
307  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
308  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
309  </TR>
310</TABLE>
311</TD>
312<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
313</EM>
314</TD>
315</TR>
316
317<TR>
318<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
319&nbsp;<A HREF="../../../../../../../org/apache/solr/search/grouping/distributed/command/QueryCommandResult.html" title="class in org.apache.solr.search.grouping.distributed.command"><B>PREV CLASS</B></A>&nbsp;
320&nbsp;<A HREF="../../../../../../../org/apache/solr/search/grouping/distributed/command/SearchGroupsFieldCommand.Builder.html" title="class in org.apache.solr.search.grouping.distributed.command"><B>NEXT CLASS</B></A></FONT></TD>
321<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
322  <A HREF="../../../../../../../index.html?org/apache/solr/search/grouping/distributed/command/SearchGroupsFieldCommand.html" target="_top"><B>FRAMES</B></A>  &nbsp;
323&nbsp;<A HREF="SearchGroupsFieldCommand.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
324&nbsp;<SCRIPT type="text/javascript">
325  <!--
326  if(window==top) {
327    document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
328  }
329  //-->
330</SCRIPT>
331<NOSCRIPT>
332  <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
333</NOSCRIPT>
334
335
336</FONT></TD>
337</TR>
338<TR>
339<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
340  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
341<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
342DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
343</TR>
344</TABLE>
345<A NAME="skip-navbar_bottom"></A>
346<!-- ======== END OF BOTTOM NAVBAR ======= -->
347
348<HR>
349
350          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
351          <script src='../../../../../../../prettify.js' type='text/javascript'></script>
352          <script type='text/javascript'>
353            (function(){
354              var oldonload = window.onload;
355              if (typeof oldonload != 'function') {
356                window.onload = prettyPrint;
357              } else {
358                window.onload = function() {
359                  oldonload();
360                  prettyPrint();
361                }
362              }
363            })();
364          </script>
365       
366</BODY>
367</HTML>
Note: See TracBrowser for help on using the repository browser.