[7588] | 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:29 EDT 2012 --> |
---|
| 6 | <META http-equiv="Content-Type" content="text/html; charset=utf-8"> |
---|
| 7 | <TITLE> |
---|
| 8 | GroupCommand (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"> |
---|
| 16 | function windowTitle() |
---|
| 17 | { |
---|
| 18 | if (location.href.indexOf('is-external=true') == -1) { |
---|
| 19 | parent.document.title="GroupCommand (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> </TD> |
---|
| 42 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
| 43 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
| 44 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/GroupCommand.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
---|
| 45 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
| 46 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
| 47 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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 | <A HREF="../../../../../../org/apache/solr/client/solrj/response/Group.html" title="class in org.apache.solr.client.solrj.response"><B>PREV CLASS</B></A> |
---|
| 59 | <A HREF="../../../../../../org/apache/solr/client/solrj/response/GroupResponse.html" title="class in org.apache.solr.client.solrj.response"><B>NEXT CLASS</B></A></FONT></TD> |
---|
| 60 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
| 61 | <A HREF="../../../../../../index.html?org/apache/solr/client/solrj/response/GroupCommand.html" target="_top"><B>FRAMES</B></A> |
---|
| 62 | <A HREF="GroupCommand.html" target="_top"><B>NO FRAMES</B></A> |
---|
| 63 | <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: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
| 80 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
| 81 | DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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"> |
---|
| 91 | org.apache.solr.client.solrj.response</FONT> |
---|
| 92 | <BR> |
---|
| 93 | Class GroupCommand</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.client.solrj.response.GroupCommand</B> |
---|
| 97 | </PRE> |
---|
| 98 | <DL> |
---|
| 99 | <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DD> |
---|
| 100 | </DL> |
---|
| 101 | <HR> |
---|
| 102 | <DL> |
---|
| 103 | <DT><PRE>public class <B>GroupCommand</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="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DL> |
---|
| 104 | </PRE> |
---|
| 105 | |
---|
| 106 | <P> |
---|
| 107 | This class represents the result of a group command. |
---|
| 108 | This can be the result of the following parameter: |
---|
| 109 | <ul> |
---|
| 110 | <li> group.field |
---|
| 111 | <li> group.func |
---|
| 112 | <li> group.query |
---|
| 113 | </ul> |
---|
| 114 | |
---|
| 115 | An instance of this class contains: |
---|
| 116 | <ul> |
---|
| 117 | <li> The name of this command. This can be the field, function or query grouped by. |
---|
| 118 | <li> The total number of documents that have matched. |
---|
| 119 | <li> The total number of groups that have matched. |
---|
| 120 | <li> The groups to be displayed. Depending on the start and rows parameter. |
---|
| 121 | </ul> |
---|
| 122 | |
---|
| 123 | In case of <code>group.query</code> only one group is present and ngroups is always <code>null</code>. |
---|
| 124 | <P> |
---|
| 125 | |
---|
| 126 | <P> |
---|
| 127 | <DL> |
---|
| 128 | <DT><B>Since:</B></DT> |
---|
| 129 | <DD>solr 3.4</DD> |
---|
| 130 | <DT><B>See Also:</B><DD><A HREF="../../../../../../serialized-form.html#org.apache.solr.client.solrj.response.GroupCommand">Serialized Form</A></DL> |
---|
| 131 | <HR> |
---|
| 132 | |
---|
| 133 | <P> |
---|
| 134 | |
---|
| 135 | <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
---|
| 136 | |
---|
| 137 | <A NAME="constructor_summary"><!-- --></A> |
---|
| 138 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 139 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 140 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
| 141 | <B>Constructor Summary</B></FONT></TH> |
---|
| 142 | </TR> |
---|
| 143 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 144 | <TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/response/GroupCommand.html#GroupCommand(java.lang.String, int)">GroupCommand</A></B>(<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> name, |
---|
| 145 | int matches)</CODE> |
---|
| 146 | |
---|
| 147 | <BR> |
---|
| 148 | Creates a GroupCommand instance</TD> |
---|
| 149 | </TR> |
---|
| 150 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 151 | <TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/response/GroupCommand.html#GroupCommand(java.lang.String, int, int)">GroupCommand</A></B>(<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> name, |
---|
| 152 | int matches, |
---|
| 153 | int nGroups)</CODE> |
---|
| 154 | |
---|
| 155 | <BR> |
---|
| 156 | Creates a GroupCommand instance.</TD> |
---|
| 157 | </TR> |
---|
| 158 | </TABLE> |
---|
| 159 | |
---|
| 160 | <!-- ========== METHOD SUMMARY =========== --> |
---|
| 161 | |
---|
| 162 | <A NAME="method_summary"><!-- --></A> |
---|
| 163 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 164 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 165 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
| 166 | <B>Method Summary</B></FONT></TH> |
---|
| 167 | </TR> |
---|
| 168 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 169 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 170 | <CODE> void</CODE></FONT></TD> |
---|
| 171 | <TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/response/GroupCommand.html#add(org.apache.solr.client.solrj.response.Group)">add</A></B>(<A HREF="../../../../../../org/apache/solr/client/solrj/response/Group.html" title="class in org.apache.solr.client.solrj.response">Group</A> group)</CODE> |
---|
| 172 | |
---|
| 173 | <BR> |
---|
| 174 | Adds a group to this command.</TD> |
---|
| 175 | </TR> |
---|
| 176 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 177 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 178 | <CODE> int</CODE></FONT></TD> |
---|
| 179 | <TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/response/GroupCommand.html#getMatches()">getMatches</A></B>()</CODE> |
---|
| 180 | |
---|
| 181 | <BR> |
---|
| 182 | Returns the total number of documents found for this command.</TD> |
---|
| 183 | </TR> |
---|
| 184 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 185 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 186 | <CODE> <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> |
---|
| 187 | <TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/response/GroupCommand.html#getName()">getName</A></B>()</CODE> |
---|
| 188 | |
---|
| 189 | <BR> |
---|
| 190 | Returns the name of this command.</TD> |
---|
| 191 | </TR> |
---|
| 192 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 193 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 194 | <CODE> <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> |
---|
| 195 | <TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/response/GroupCommand.html#getNGroups()">getNGroups</A></B>()</CODE> |
---|
| 196 | |
---|
| 197 | <BR> |
---|
| 198 | Returns the total number of groups found for this command.</TD> |
---|
| 199 | </TR> |
---|
| 200 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 201 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 202 | <CODE> <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><<A HREF="../../../../../../org/apache/solr/client/solrj/response/Group.html" title="class in org.apache.solr.client.solrj.response">Group</A>></CODE></FONT></TD> |
---|
| 203 | <TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/response/GroupCommand.html#getValues()">getValues</A></B>()</CODE> |
---|
| 204 | |
---|
| 205 | <BR> |
---|
| 206 | Returns the groups to be displayed.</TD> |
---|
| 207 | </TR> |
---|
| 208 | </TABLE> |
---|
| 209 | <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
---|
| 210 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 211 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
---|
| 212 | <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> |
---|
| 213 | </TR> |
---|
| 214 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 215 | <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> |
---|
| 216 | </TR> |
---|
| 217 | </TABLE> |
---|
| 218 | |
---|
| 219 | <P> |
---|
| 220 | |
---|
| 221 | <!-- ========= CONSTRUCTOR DETAIL ======== --> |
---|
| 222 | |
---|
| 223 | <A NAME="constructor_detail"><!-- --></A> |
---|
| 224 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 225 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 226 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
| 227 | <B>Constructor Detail</B></FONT></TH> |
---|
| 228 | </TR> |
---|
| 229 | </TABLE> |
---|
| 230 | |
---|
| 231 | <A NAME="GroupCommand(java.lang.String, int)"><!-- --></A><H3> |
---|
| 232 | GroupCommand</H3> |
---|
| 233 | <PRE> |
---|
| 234 | public <B>GroupCommand</B>(<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> name, |
---|
| 235 | int matches)</PRE> |
---|
| 236 | <DL> |
---|
| 237 | <DD>Creates a GroupCommand instance |
---|
| 238 | <P> |
---|
| 239 | <DL> |
---|
| 240 | <DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of this command<DD><CODE>matches</CODE> - The total number of documents found for this command</DL> |
---|
| 241 | </DL> |
---|
| 242 | <HR> |
---|
| 243 | |
---|
| 244 | <A NAME="GroupCommand(java.lang.String, int, int)"><!-- --></A><H3> |
---|
| 245 | GroupCommand</H3> |
---|
| 246 | <PRE> |
---|
| 247 | public <B>GroupCommand</B>(<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> name, |
---|
| 248 | int matches, |
---|
| 249 | int nGroups)</PRE> |
---|
| 250 | <DL> |
---|
| 251 | <DD>Creates a GroupCommand instance. |
---|
| 252 | <P> |
---|
| 253 | <DL> |
---|
| 254 | <DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of this command<DD><CODE>matches</CODE> - The total number of documents found for this command<DD><CODE>nGroups</CODE> - The total number of groups found for this command.</DL> |
---|
| 255 | </DL> |
---|
| 256 | |
---|
| 257 | <!-- ============ METHOD DETAIL ========== --> |
---|
| 258 | |
---|
| 259 | <A NAME="method_detail"><!-- --></A> |
---|
| 260 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 261 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 262 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
| 263 | <B>Method Detail</B></FONT></TH> |
---|
| 264 | </TR> |
---|
| 265 | </TABLE> |
---|
| 266 | |
---|
| 267 | <A NAME="getName()"><!-- --></A><H3> |
---|
| 268 | getName</H3> |
---|
| 269 | <PRE> |
---|
| 270 | public <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>getName</B>()</PRE> |
---|
| 271 | <DL> |
---|
| 272 | <DD>Returns the name of this command. This can be the field, function or query grouped by. |
---|
| 273 | <P> |
---|
| 274 | <DD><DL> |
---|
| 275 | </DL> |
---|
| 276 | </DD> |
---|
| 277 | <DD><DL> |
---|
| 278 | |
---|
| 279 | <DT><B>Returns:</B><DD>the name of this command</DL> |
---|
| 280 | </DD> |
---|
| 281 | </DL> |
---|
| 282 | <HR> |
---|
| 283 | |
---|
| 284 | <A NAME="add(org.apache.solr.client.solrj.response.Group)"><!-- --></A><H3> |
---|
| 285 | add</H3> |
---|
| 286 | <PRE> |
---|
| 287 | public void <B>add</B>(<A HREF="../../../../../../org/apache/solr/client/solrj/response/Group.html" title="class in org.apache.solr.client.solrj.response">Group</A> group)</PRE> |
---|
| 288 | <DL> |
---|
| 289 | <DD>Adds a group to this command. |
---|
| 290 | <P> |
---|
| 291 | <DD><DL> |
---|
| 292 | </DL> |
---|
| 293 | </DD> |
---|
| 294 | <DD><DL> |
---|
| 295 | <DT><B>Parameters:</B><DD><CODE>group</CODE> - A group to be added</DL> |
---|
| 296 | </DD> |
---|
| 297 | </DL> |
---|
| 298 | <HR> |
---|
| 299 | |
---|
| 300 | <A NAME="getValues()"><!-- --></A><H3> |
---|
| 301 | getValues</H3> |
---|
| 302 | <PRE> |
---|
| 303 | public <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><<A HREF="../../../../../../org/apache/solr/client/solrj/response/Group.html" title="class in org.apache.solr.client.solrj.response">Group</A>> <B>getValues</B>()</PRE> |
---|
| 304 | <DL> |
---|
| 305 | <DD>Returns the groups to be displayed. |
---|
| 306 | The number of groups returned depend on the <code>start</code> and <code>rows</code> parameters. |
---|
| 307 | <P> |
---|
| 308 | <DD><DL> |
---|
| 309 | </DL> |
---|
| 310 | </DD> |
---|
| 311 | <DD><DL> |
---|
| 312 | |
---|
| 313 | <DT><B>Returns:</B><DD>the groups to be displayed.</DL> |
---|
| 314 | </DD> |
---|
| 315 | </DL> |
---|
| 316 | <HR> |
---|
| 317 | |
---|
| 318 | <A NAME="getMatches()"><!-- --></A><H3> |
---|
| 319 | getMatches</H3> |
---|
| 320 | <PRE> |
---|
| 321 | public int <B>getMatches</B>()</PRE> |
---|
| 322 | <DL> |
---|
| 323 | <DD>Returns the total number of documents found for this command. |
---|
| 324 | <P> |
---|
| 325 | <DD><DL> |
---|
| 326 | </DL> |
---|
| 327 | </DD> |
---|
| 328 | <DD><DL> |
---|
| 329 | |
---|
| 330 | <DT><B>Returns:</B><DD>the total number of documents found for this command.</DL> |
---|
| 331 | </DD> |
---|
| 332 | </DL> |
---|
| 333 | <HR> |
---|
| 334 | |
---|
| 335 | <A NAME="getNGroups()"><!-- --></A><H3> |
---|
| 336 | getNGroups</H3> |
---|
| 337 | <PRE> |
---|
| 338 | public <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>getNGroups</B>()</PRE> |
---|
| 339 | <DL> |
---|
| 340 | <DD>Returns the total number of groups found for this command. |
---|
| 341 | Returns <code>null</code> if the <code>group.ngroups</code> parameter is unset or <code>false</code> or |
---|
| 342 | if this is a group command query (parameter = <code>group.query</code>). |
---|
| 343 | <P> |
---|
| 344 | <DD><DL> |
---|
| 345 | </DL> |
---|
| 346 | </DD> |
---|
| 347 | <DD><DL> |
---|
| 348 | |
---|
| 349 | <DT><B>Returns:</B><DD>the total number of groups found for this command.</DL> |
---|
| 350 | </DD> |
---|
| 351 | </DL> |
---|
| 352 | <!-- ========= END OF CLASS DATA ========= --> |
---|
| 353 | <HR> |
---|
| 354 | |
---|
| 355 | |
---|
| 356 | <!-- ======= START OF BOTTOM NAVBAR ====== --> |
---|
| 357 | <A NAME="navbar_bottom"><!-- --></A> |
---|
| 358 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
---|
| 359 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
---|
| 360 | <TR> |
---|
| 361 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
---|
| 362 | <A NAME="navbar_bottom_firstrow"><!-- --></A> |
---|
| 363 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
---|
| 364 | <TR ALIGN="center" VALIGN="top"> |
---|
| 365 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
---|
| 366 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
| 367 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
| 368 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/GroupCommand.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
---|
| 369 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
| 370 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
| 371 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
---|
| 372 | </TR> |
---|
| 373 | </TABLE> |
---|
| 374 | </TD> |
---|
| 375 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
---|
| 376 | </EM> |
---|
| 377 | </TD> |
---|
| 378 | </TR> |
---|
| 379 | |
---|
| 380 | <TR> |
---|
| 381 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
| 382 | <A HREF="../../../../../../org/apache/solr/client/solrj/response/Group.html" title="class in org.apache.solr.client.solrj.response"><B>PREV CLASS</B></A> |
---|
| 383 | <A HREF="../../../../../../org/apache/solr/client/solrj/response/GroupResponse.html" title="class in org.apache.solr.client.solrj.response"><B>NEXT CLASS</B></A></FONT></TD> |
---|
| 384 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
| 385 | <A HREF="../../../../../../index.html?org/apache/solr/client/solrj/response/GroupCommand.html" target="_top"><B>FRAMES</B></A> |
---|
| 386 | <A HREF="GroupCommand.html" target="_top"><B>NO FRAMES</B></A> |
---|
| 387 | <SCRIPT type="text/javascript"> |
---|
| 388 | <!-- |
---|
| 389 | if(window==top) { |
---|
| 390 | document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
---|
| 391 | } |
---|
| 392 | //--> |
---|
| 393 | </SCRIPT> |
---|
| 394 | <NOSCRIPT> |
---|
| 395 | <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
---|
| 396 | </NOSCRIPT> |
---|
| 397 | |
---|
| 398 | |
---|
| 399 | </FONT></TD> |
---|
| 400 | </TR> |
---|
| 401 | <TR> |
---|
| 402 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
| 403 | SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
| 404 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
| 405 | DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
---|
| 406 | </TR> |
---|
| 407 | </TABLE> |
---|
| 408 | <A NAME="skip-navbar_bottom"></A> |
---|
| 409 | <!-- ======== END OF BOTTOM NAVBAR ======= --> |
---|
| 410 | |
---|
| 411 | <HR> |
---|
| 412 | |
---|
| 413 | <address>Copyright © 2000-2012 Apache Software Foundation. All Rights Reserved.</address> |
---|
| 414 | <script src='../../../../../../prettify.js' type='text/javascript'></script> |
---|
| 415 | <script type='text/javascript'> |
---|
| 416 | (function(){ |
---|
| 417 | var oldonload = window.onload; |
---|
| 418 | if (typeof oldonload != 'function') { |
---|
| 419 | window.onload = prettyPrint; |
---|
| 420 | } else { |
---|
| 421 | window.onload = function() { |
---|
| 422 | oldonload(); |
---|
| 423 | prettyPrint(); |
---|
| 424 | } |
---|
| 425 | } |
---|
| 426 | })(); |
---|
| 427 | </script> |
---|
| 428 | |
---|
| 429 | </BODY> |
---|
| 430 | </HTML> |
---|