| 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:26 EDT 2012 --> |
|---|
| 6 | <META http-equiv="Content-Type" content="text/html; charset=utf-8"> |
|---|
| 7 | <TITLE> |
|---|
| 8 | GroupParams (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="GroupParams (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/GroupParams.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/common/params/FacetParams.FacetRangeOther.html" title="enum in org.apache.solr.common.params"><B>PREV CLASS</B></A> |
|---|
| 59 | <A HREF="../../../../../org/apache/solr/common/params/HighlightParams.html" title="interface in org.apache.solr.common.params"><B>NEXT CLASS</B></A></FONT></TD> |
|---|
| 60 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
|---|
| 61 | <A HREF="../../../../../index.html?org/apache/solr/common/params/GroupParams.html" target="_top"><B>FRAMES</B></A> |
|---|
| 62 | <A HREF="GroupParams.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 | <A HREF="#field_summary">FIELD</A> | CONSTR | METHOD</FONT></TD> |
|---|
| 80 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
|---|
| 81 | DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | METHOD</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.common.params</FONT> |
|---|
| 92 | <BR> |
|---|
| 93 | Interface GroupParams</H2> |
|---|
| 94 | <HR> |
|---|
| 95 | <DL> |
|---|
| 96 | <DT><PRE>public interface <B>GroupParams</B></DL> |
|---|
| 97 | </PRE> |
|---|
| 98 | |
|---|
| 99 | <P> |
|---|
| 100 | Group parameters |
|---|
| 101 | <P> |
|---|
| 102 | |
|---|
| 103 | <P> |
|---|
| 104 | <HR> |
|---|
| 105 | |
|---|
| 106 | <P> |
|---|
| 107 | <!-- =========== FIELD SUMMARY =========== --> |
|---|
| 108 | |
|---|
| 109 | <A NAME="field_summary"><!-- --></A> |
|---|
| 110 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
|---|
| 111 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
|---|
| 112 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
|---|
| 113 | <B>Field Summary</B></FONT></TH> |
|---|
| 114 | </TR> |
|---|
| 115 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
|---|
| 116 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|---|
| 117 | <CODE>static <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> |
|---|
| 118 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/GroupParams.html#GROUP">GROUP</A></B></CODE> |
|---|
| 119 | |
|---|
| 120 | <BR> |
|---|
| 121 | </TD> |
|---|
| 122 | </TR> |
|---|
| 123 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
|---|
| 124 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|---|
| 125 | <CODE>static <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/common/params/GroupParams.html#GROUP_CACHE_PERCENTAGE">GROUP_CACHE_PERCENTAGE</A></B></CODE> |
|---|
| 127 | |
|---|
| 128 | <BR> |
|---|
| 129 | Whether to cache the first pass search (doc ids and score) for the second pass search.</TD> |
|---|
| 130 | </TR> |
|---|
| 131 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
|---|
| 132 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|---|
| 133 | <CODE>static <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> |
|---|
| 134 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/GroupParams.html#GROUP_DISTRIBUTED_FIRST">GROUP_DISTRIBUTED_FIRST</A></B></CODE> |
|---|
| 135 | |
|---|
| 136 | <BR> |
|---|
| 137 | Retrieve the top search groups (top group values) from the shards being queried.</TD> |
|---|
| 138 | </TR> |
|---|
| 139 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
|---|
| 140 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|---|
| 141 | <CODE>static <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> |
|---|
| 142 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/GroupParams.html#GROUP_DISTRIBUTED_SECOND">GROUP_DISTRIBUTED_SECOND</A></B></CODE> |
|---|
| 143 | |
|---|
| 144 | <BR> |
|---|
| 145 | Retrieve the top groups from the shards being queries based on the specified search groups in |
|---|
| 146 | the <A HREF="../../../../../org/apache/solr/common/params/GroupParams.html#GROUP_DISTRIBUTED_TOPGROUPS_PREFIX"><CODE>GROUP_DISTRIBUTED_TOPGROUPS_PREFIX</CODE></A> parameters.</TD> |
|---|
| 147 | </TR> |
|---|
| 148 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
|---|
| 149 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|---|
| 150 | <CODE>static <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> |
|---|
| 151 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/GroupParams.html#GROUP_DISTRIBUTED_TOPGROUPS_PREFIX">GROUP_DISTRIBUTED_TOPGROUPS_PREFIX</A></B></CODE> |
|---|
| 152 | |
|---|
| 153 | <BR> |
|---|
| 154 | </TD> |
|---|
| 155 | </TR> |
|---|
| 156 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
|---|
| 157 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|---|
| 158 | <CODE>static <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> |
|---|
| 159 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/GroupParams.html#GROUP_FACET">GROUP_FACET</A></B></CODE> |
|---|
| 160 | |
|---|
| 161 | <BR> |
|---|
| 162 | Whether to compute grouped facets based on the first specified group.</TD> |
|---|
| 163 | </TR> |
|---|
| 164 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
|---|
| 165 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|---|
| 166 | <CODE>static <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> |
|---|
| 167 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/GroupParams.html#GROUP_FIELD">GROUP_FIELD</A></B></CODE> |
|---|
| 168 | |
|---|
| 169 | <BR> |
|---|
| 170 | </TD> |
|---|
| 171 | </TR> |
|---|
| 172 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
|---|
| 173 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|---|
| 174 | <CODE>static <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> |
|---|
| 175 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/GroupParams.html#GROUP_FORMAT">GROUP_FORMAT</A></B></CODE> |
|---|
| 176 | |
|---|
| 177 | <BR> |
|---|
| 178 | treat the first group result as the main result.</TD> |
|---|
| 179 | </TR> |
|---|
| 180 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
|---|
| 181 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|---|
| 182 | <CODE>static <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> |
|---|
| 183 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/GroupParams.html#GROUP_FUNC">GROUP_FUNC</A></B></CODE> |
|---|
| 184 | |
|---|
| 185 | <BR> |
|---|
| 186 | </TD> |
|---|
| 187 | </TR> |
|---|
| 188 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
|---|
| 189 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|---|
| 190 | <CODE>static <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> |
|---|
| 191 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/GroupParams.html#GROUP_LIMIT">GROUP_LIMIT</A></B></CODE> |
|---|
| 192 | |
|---|
| 193 | <BR> |
|---|
| 194 | the limit for the number of documents in each group</TD> |
|---|
| 195 | </TR> |
|---|
| 196 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
|---|
| 197 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|---|
| 198 | <CODE>static <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> |
|---|
| 199 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/GroupParams.html#GROUP_MAIN">GROUP_MAIN</A></B></CODE> |
|---|
| 200 | |
|---|
| 201 | <BR> |
|---|
| 202 | treat the first group result as the main result.</TD> |
|---|
| 203 | </TR> |
|---|
| 204 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
|---|
| 205 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|---|
| 206 | <CODE>static <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> |
|---|
| 207 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/GroupParams.html#GROUP_OFFSET">GROUP_OFFSET</A></B></CODE> |
|---|
| 208 | |
|---|
| 209 | <BR> |
|---|
| 210 | the offset for the doclist of each group</TD> |
|---|
| 211 | </TR> |
|---|
| 212 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
|---|
| 213 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|---|
| 214 | <CODE>static <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> |
|---|
| 215 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/GroupParams.html#GROUP_QUERY">GROUP_QUERY</A></B></CODE> |
|---|
| 216 | |
|---|
| 217 | <BR> |
|---|
| 218 | </TD> |
|---|
| 219 | </TR> |
|---|
| 220 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
|---|
| 221 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|---|
| 222 | <CODE>static <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> |
|---|
| 223 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/GroupParams.html#GROUP_SORT">GROUP_SORT</A></B></CODE> |
|---|
| 224 | |
|---|
| 225 | <BR> |
|---|
| 226 | </TD> |
|---|
| 227 | </TR> |
|---|
| 228 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
|---|
| 229 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|---|
| 230 | <CODE>static <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> |
|---|
| 231 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/GroupParams.html#GROUP_TOTAL_COUNT">GROUP_TOTAL_COUNT</A></B></CODE> |
|---|
| 232 | |
|---|
| 233 | <BR> |
|---|
| 234 | Whether the group count should be included in the response.</TD> |
|---|
| 235 | </TR> |
|---|
| 236 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
|---|
| 237 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
|---|
| 238 | <CODE>static <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> |
|---|
| 239 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/GroupParams.html#GROUP_TRUNCATE">GROUP_TRUNCATE</A></B></CODE> |
|---|
| 240 | |
|---|
| 241 | <BR> |
|---|
| 242 | Whether the docSet (for example for faceting) should be based on plain documents (a.k.a UNGROUPED) or on the groups (a.k.a GROUPED).</TD> |
|---|
| 243 | </TR> |
|---|
| 244 | </TABLE> |
|---|
| 245 | |
|---|
| 246 | <P> |
|---|
| 247 | |
|---|
| 248 | <!-- ============ FIELD DETAIL =========== --> |
|---|
| 249 | |
|---|
| 250 | <A NAME="field_detail"><!-- --></A> |
|---|
| 251 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
|---|
| 252 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
|---|
| 253 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
|---|
| 254 | <B>Field Detail</B></FONT></TH> |
|---|
| 255 | </TR> |
|---|
| 256 | </TABLE> |
|---|
| 257 | |
|---|
| 258 | <A NAME="GROUP"><!-- --></A><H3> |
|---|
| 259 | GROUP</H3> |
|---|
| 260 | <PRE> |
|---|
| 261 | static final <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>GROUP</B></PRE> |
|---|
| 262 | <DL> |
|---|
| 263 | <DL> |
|---|
| 264 | <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.GroupParams.GROUP">Constant Field Values</A></DL> |
|---|
| 265 | </DL> |
|---|
| 266 | <HR> |
|---|
| 267 | |
|---|
| 268 | <A NAME="GROUP_QUERY"><!-- --></A><H3> |
|---|
| 269 | GROUP_QUERY</H3> |
|---|
| 270 | <PRE> |
|---|
| 271 | static final <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>GROUP_QUERY</B></PRE> |
|---|
| 272 | <DL> |
|---|
| 273 | <DL> |
|---|
| 274 | <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.GroupParams.GROUP_QUERY">Constant Field Values</A></DL> |
|---|
| 275 | </DL> |
|---|
| 276 | <HR> |
|---|
| 277 | |
|---|
| 278 | <A NAME="GROUP_FIELD"><!-- --></A><H3> |
|---|
| 279 | GROUP_FIELD</H3> |
|---|
| 280 | <PRE> |
|---|
| 281 | static final <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>GROUP_FIELD</B></PRE> |
|---|
| 282 | <DL> |
|---|
| 283 | <DL> |
|---|
| 284 | <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.GroupParams.GROUP_FIELD">Constant Field Values</A></DL> |
|---|
| 285 | </DL> |
|---|
| 286 | <HR> |
|---|
| 287 | |
|---|
| 288 | <A NAME="GROUP_FUNC"><!-- --></A><H3> |
|---|
| 289 | GROUP_FUNC</H3> |
|---|
| 290 | <PRE> |
|---|
| 291 | static final <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>GROUP_FUNC</B></PRE> |
|---|
| 292 | <DL> |
|---|
| 293 | <DL> |
|---|
| 294 | <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.GroupParams.GROUP_FUNC">Constant Field Values</A></DL> |
|---|
| 295 | </DL> |
|---|
| 296 | <HR> |
|---|
| 297 | |
|---|
| 298 | <A NAME="GROUP_SORT"><!-- --></A><H3> |
|---|
| 299 | GROUP_SORT</H3> |
|---|
| 300 | <PRE> |
|---|
| 301 | static final <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>GROUP_SORT</B></PRE> |
|---|
| 302 | <DL> |
|---|
| 303 | <DL> |
|---|
| 304 | <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.GroupParams.GROUP_SORT">Constant Field Values</A></DL> |
|---|
| 305 | </DL> |
|---|
| 306 | <HR> |
|---|
| 307 | |
|---|
| 308 | <A NAME="GROUP_LIMIT"><!-- --></A><H3> |
|---|
| 309 | GROUP_LIMIT</H3> |
|---|
| 310 | <PRE> |
|---|
| 311 | static final <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>GROUP_LIMIT</B></PRE> |
|---|
| 312 | <DL> |
|---|
| 313 | <DD>the limit for the number of documents in each group |
|---|
| 314 | <P> |
|---|
| 315 | <DL> |
|---|
| 316 | <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.GroupParams.GROUP_LIMIT">Constant Field Values</A></DL> |
|---|
| 317 | </DL> |
|---|
| 318 | <HR> |
|---|
| 319 | |
|---|
| 320 | <A NAME="GROUP_OFFSET"><!-- --></A><H3> |
|---|
| 321 | GROUP_OFFSET</H3> |
|---|
| 322 | <PRE> |
|---|
| 323 | static final <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>GROUP_OFFSET</B></PRE> |
|---|
| 324 | <DL> |
|---|
| 325 | <DD>the offset for the doclist of each group |
|---|
| 326 | <P> |
|---|
| 327 | <DL> |
|---|
| 328 | <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.GroupParams.GROUP_OFFSET">Constant Field Values</A></DL> |
|---|
| 329 | </DL> |
|---|
| 330 | <HR> |
|---|
| 331 | |
|---|
| 332 | <A NAME="GROUP_MAIN"><!-- --></A><H3> |
|---|
| 333 | GROUP_MAIN</H3> |
|---|
| 334 | <PRE> |
|---|
| 335 | static final <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>GROUP_MAIN</B></PRE> |
|---|
| 336 | <DL> |
|---|
| 337 | <DD>treat the first group result as the main result. true/false |
|---|
| 338 | <P> |
|---|
| 339 | <DL> |
|---|
| 340 | <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.GroupParams.GROUP_MAIN">Constant Field Values</A></DL> |
|---|
| 341 | </DL> |
|---|
| 342 | <HR> |
|---|
| 343 | |
|---|
| 344 | <A NAME="GROUP_FORMAT"><!-- --></A><H3> |
|---|
| 345 | GROUP_FORMAT</H3> |
|---|
| 346 | <PRE> |
|---|
| 347 | static final <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>GROUP_FORMAT</B></PRE> |
|---|
| 348 | <DL> |
|---|
| 349 | <DD>treat the first group result as the main result. true/false |
|---|
| 350 | <P> |
|---|
| 351 | <DL> |
|---|
| 352 | <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.GroupParams.GROUP_FORMAT">Constant Field Values</A></DL> |
|---|
| 353 | </DL> |
|---|
| 354 | <HR> |
|---|
| 355 | |
|---|
| 356 | <A NAME="GROUP_CACHE_PERCENTAGE"><!-- --></A><H3> |
|---|
| 357 | GROUP_CACHE_PERCENTAGE</H3> |
|---|
| 358 | <PRE> |
|---|
| 359 | static final <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>GROUP_CACHE_PERCENTAGE</B></PRE> |
|---|
| 360 | <DL> |
|---|
| 361 | <DD>Whether to cache the first pass search (doc ids and score) for the second pass search. |
|---|
| 362 | Also defines the maximum size of the group cache relative to maxdoc in a percentage. |
|---|
| 363 | Values can be a positive integer, from 0 till 100. A value of 0 will disable the group cache. |
|---|
| 364 | The default is 0. |
|---|
| 365 | <P> |
|---|
| 366 | <DL> |
|---|
| 367 | <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.GroupParams.GROUP_CACHE_PERCENTAGE">Constant Field Values</A></DL> |
|---|
| 368 | </DL> |
|---|
| 369 | <HR> |
|---|
| 370 | |
|---|
| 371 | <A NAME="GROUP_TRUNCATE"><!-- --></A><H3> |
|---|
| 372 | GROUP_TRUNCATE</H3> |
|---|
| 373 | <PRE> |
|---|
| 374 | static final <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>GROUP_TRUNCATE</B></PRE> |
|---|
| 375 | <DL> |
|---|
| 376 | <DD>Whether the docSet (for example for faceting) should be based on plain documents (a.k.a UNGROUPED) or on the groups (a.k.a GROUPED). |
|---|
| 377 | The docSet will only the most relevant documents per group. It is if you query for everything with group.limit=1 |
|---|
| 378 | <P> |
|---|
| 379 | <DL> |
|---|
| 380 | <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.GroupParams.GROUP_TRUNCATE">Constant Field Values</A></DL> |
|---|
| 381 | </DL> |
|---|
| 382 | <HR> |
|---|
| 383 | |
|---|
| 384 | <A NAME="GROUP_TOTAL_COUNT"><!-- --></A><H3> |
|---|
| 385 | GROUP_TOTAL_COUNT</H3> |
|---|
| 386 | <PRE> |
|---|
| 387 | static final <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>GROUP_TOTAL_COUNT</B></PRE> |
|---|
| 388 | <DL> |
|---|
| 389 | <DD>Whether the group count should be included in the response. |
|---|
| 390 | <P> |
|---|
| 391 | <DL> |
|---|
| 392 | <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.GroupParams.GROUP_TOTAL_COUNT">Constant Field Values</A></DL> |
|---|
| 393 | </DL> |
|---|
| 394 | <HR> |
|---|
| 395 | |
|---|
| 396 | <A NAME="GROUP_FACET"><!-- --></A><H3> |
|---|
| 397 | GROUP_FACET</H3> |
|---|
| 398 | <PRE> |
|---|
| 399 | static final <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>GROUP_FACET</B></PRE> |
|---|
| 400 | <DL> |
|---|
| 401 | <DD>Whether to compute grouped facets based on the first specified group. |
|---|
| 402 | <P> |
|---|
| 403 | <DL> |
|---|
| 404 | <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.GroupParams.GROUP_FACET">Constant Field Values</A></DL> |
|---|
| 405 | </DL> |
|---|
| 406 | <HR> |
|---|
| 407 | |
|---|
| 408 | <A NAME="GROUP_DISTRIBUTED_FIRST"><!-- --></A><H3> |
|---|
| 409 | GROUP_DISTRIBUTED_FIRST</H3> |
|---|
| 410 | <PRE> |
|---|
| 411 | static final <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>GROUP_DISTRIBUTED_FIRST</B></PRE> |
|---|
| 412 | <DL> |
|---|
| 413 | <DD>Retrieve the top search groups (top group values) from the shards being queried. |
|---|
| 414 | <P> |
|---|
| 415 | <DL> |
|---|
| 416 | <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.GroupParams.GROUP_DISTRIBUTED_FIRST">Constant Field Values</A></DL> |
|---|
| 417 | </DL> |
|---|
| 418 | <HR> |
|---|
| 419 | |
|---|
| 420 | <A NAME="GROUP_DISTRIBUTED_SECOND"><!-- --></A><H3> |
|---|
| 421 | GROUP_DISTRIBUTED_SECOND</H3> |
|---|
| 422 | <PRE> |
|---|
| 423 | static final <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>GROUP_DISTRIBUTED_SECOND</B></PRE> |
|---|
| 424 | <DL> |
|---|
| 425 | <DD>Retrieve the top groups from the shards being queries based on the specified search groups in |
|---|
| 426 | the <A HREF="../../../../../org/apache/solr/common/params/GroupParams.html#GROUP_DISTRIBUTED_TOPGROUPS_PREFIX"><CODE>GROUP_DISTRIBUTED_TOPGROUPS_PREFIX</CODE></A> parameters. |
|---|
| 427 | <P> |
|---|
| 428 | <DL> |
|---|
| 429 | <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.GroupParams.GROUP_DISTRIBUTED_SECOND">Constant Field Values</A></DL> |
|---|
| 430 | </DL> |
|---|
| 431 | <HR> |
|---|
| 432 | |
|---|
| 433 | <A NAME="GROUP_DISTRIBUTED_TOPGROUPS_PREFIX"><!-- --></A><H3> |
|---|
| 434 | GROUP_DISTRIBUTED_TOPGROUPS_PREFIX</H3> |
|---|
| 435 | <PRE> |
|---|
| 436 | static final <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>GROUP_DISTRIBUTED_TOPGROUPS_PREFIX</B></PRE> |
|---|
| 437 | <DL> |
|---|
| 438 | <DL> |
|---|
| 439 | <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.GroupParams.GROUP_DISTRIBUTED_TOPGROUPS_PREFIX">Constant Field Values</A></DL> |
|---|
| 440 | </DL> |
|---|
| 441 | <!-- ========= END OF CLASS DATA ========= --> |
|---|
| 442 | <HR> |
|---|
| 443 | |
|---|
| 444 | |
|---|
| 445 | <!-- ======= START OF BOTTOM NAVBAR ====== --> |
|---|
| 446 | <A NAME="navbar_bottom"><!-- --></A> |
|---|
| 447 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
|---|
| 448 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
|---|
| 449 | <TR> |
|---|
| 450 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
|---|
| 451 | <A NAME="navbar_bottom_firstrow"><!-- --></A> |
|---|
| 452 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
|---|
| 453 | <TR ALIGN="center" VALIGN="top"> |
|---|
| 454 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
|---|
| 455 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
|---|
| 456 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
|---|
| 457 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/GroupParams.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
|---|
| 458 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
|---|
| 459 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
|---|
| 460 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
|---|
| 461 | </TR> |
|---|
| 462 | </TABLE> |
|---|
| 463 | </TD> |
|---|
| 464 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
|---|
| 465 | </EM> |
|---|
| 466 | </TD> |
|---|
| 467 | </TR> |
|---|
| 468 | |
|---|
| 469 | <TR> |
|---|
| 470 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
|---|
| 471 | <A HREF="../../../../../org/apache/solr/common/params/FacetParams.FacetRangeOther.html" title="enum in org.apache.solr.common.params"><B>PREV CLASS</B></A> |
|---|
| 472 | <A HREF="../../../../../org/apache/solr/common/params/HighlightParams.html" title="interface in org.apache.solr.common.params"><B>NEXT CLASS</B></A></FONT></TD> |
|---|
| 473 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
|---|
| 474 | <A HREF="../../../../../index.html?org/apache/solr/common/params/GroupParams.html" target="_top"><B>FRAMES</B></A> |
|---|
| 475 | <A HREF="GroupParams.html" target="_top"><B>NO FRAMES</B></A> |
|---|
| 476 | <SCRIPT type="text/javascript"> |
|---|
| 477 | <!-- |
|---|
| 478 | if(window==top) { |
|---|
| 479 | document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
|---|
| 480 | } |
|---|
| 481 | //--> |
|---|
| 482 | </SCRIPT> |
|---|
| 483 | <NOSCRIPT> |
|---|
| 484 | <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
|---|
| 485 | </NOSCRIPT> |
|---|
| 486 | |
|---|
| 487 | |
|---|
| 488 | </FONT></TD> |
|---|
| 489 | </TR> |
|---|
| 490 | <TR> |
|---|
| 491 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
|---|
| 492 | SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | METHOD</FONT></TD> |
|---|
| 493 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
|---|
| 494 | DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | METHOD</FONT></TD> |
|---|
| 495 | </TR> |
|---|
| 496 | </TABLE> |
|---|
| 497 | <A NAME="skip-navbar_bottom"></A> |
|---|
| 498 | <!-- ======== END OF BOTTOM NAVBAR ======= --> |
|---|
| 499 | |
|---|
| 500 | <HR> |
|---|
| 501 | |
|---|
| 502 | <address>Copyright © 2000-2012 Apache Software Foundation. All Rights Reserved.</address> |
|---|
| 503 | <script src='../../../../../prettify.js' type='text/javascript'></script> |
|---|
| 504 | <script type='text/javascript'> |
|---|
| 505 | (function(){ |
|---|
| 506 | var oldonload = window.onload; |
|---|
| 507 | if (typeof oldonload != 'function') { |
|---|
| 508 | window.onload = prettyPrint; |
|---|
| 509 | } else { |
|---|
| 510 | window.onload = function() { |
|---|
| 511 | oldonload(); |
|---|
| 512 | prettyPrint(); |
|---|
| 513 | } |
|---|
| 514 | } |
|---|
| 515 | })(); |
|---|
| 516 | </script> |
|---|
| 517 | |
|---|
| 518 | </BODY> |
|---|
| 519 | </HTML> |
|---|
