solr-4.6.0/docs/solr-core/org/apache/solr/search/Grouping.html

   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_30) on Tue Nov 19 11:16:54 CET 2013 -->
   6 <META http-equiv="Content-Type" content="text/html; charset=utf-8">
   7 <TITLE>
   8 Grouping (Solr 4.6.0 API)
   9 </TITLE>
  10
  11 <META NAME="date" CONTENT="2013-11-19">
  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="Grouping (Solr 4.6.0 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.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/FunctionRangeQuery.html" title="class in org.apache.solr.search"><B>PREV CLASS</B></A>&nbsp;
  59 &nbsp;<A HREF="../../../../org/apache/solr/search/Grouping.Command.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.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  62 &nbsp;<A HREF="Grouping.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;<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">
  81 DETAIL:&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">
  91 org.apache.solr.search</FONT>
  92 <BR>
  93 Class Grouping</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</B>
  97 </PRE>
  98 <HR>
  99 <DL>
 100 <DT><PRE>public class <B>Grouping</B><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>
 101 </PRE>
 102
 103 <P>
 104 Basic Solr Grouping infrastructure.
 105  Warning NOT thread save!
 106 <P>
 107
 108 <P>
 109 <DL>
 110 <DT><B>WARNING: This API is experimental and might change in incompatible ways in the next release.</B></DT>
 111   <DD></DD>
 112 </DL>
 113 <HR>
 114
 115 <P>
 116 <!-- ======== NESTED CLASS SUMMARY ======== -->
 117
 118 <A NAME="nested_class_summary"><!-- --></A>
 119 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 120 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 121 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 122 <B>Nested Class Summary</B></FONT></TH>
 123 </TR>
 124 <TR BGCOLOR="white" CLASS="TableRowColor">
 125 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 126 <CODE>&nbsp;class</CODE></FONT></TD>
 127 <TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.Command.html" title="class in org.apache.solr.search">Grouping.Command</A>&lt;<A HREF="../../../../org/apache/solr/search/Grouping.Command.html" title="type parameter in Grouping.Command">GROUP_VALUE_TYPE</A>&gt;</B></CODE>
 128
 129 <BR>
 130 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;General group command.</TD>
 131 </TR>
 132 <TR BGCOLOR="white" CLASS="TableRowColor">
 133 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 134 <CODE>&nbsp;class</CODE></FONT></TD>
 135 <TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.CommandField.html" title="class in org.apache.solr.search">Grouping.CommandField</A></B></CODE>
 136
 137 <BR>
 138 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A group command for grouping on a field.</TD>
 139 </TR>
 140 <TR BGCOLOR="white" CLASS="TableRowColor">
 141 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 142 <CODE>&nbsp;class</CODE></FONT></TD>
 143 <TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.CommandFunc.html" title="class in org.apache.solr.search">Grouping.CommandFunc</A></B></CODE>
 144
 145 <BR>
 146 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A command for grouping on a function.</TD>
 147 </TR>
 148 <TR BGCOLOR="white" CLASS="TableRowColor">
 149 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 150 <CODE>&nbsp;class</CODE></FONT></TD>
 151 <TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.CommandQuery.html" title="class in org.apache.solr.search">Grouping.CommandQuery</A></B></CODE>
 152
 153 <BR>
 154 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A group command for grouping on a query.</TD>
 155 </TR>
 156 <TR BGCOLOR="white" CLASS="TableRowColor">
 157 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 158 <CODE>static&nbsp;class</CODE></FONT></TD>
 159 <TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.Format.html" title="enum in org.apache.solr.search">Grouping.Format</A></B></CODE>
 160
 161 <BR>
 162 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 163 </TR>
 164 <TR BGCOLOR="white" CLASS="TableRowColor">
 165 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 166 <CODE>static&nbsp;class</CODE></FONT></TD>
 167 <TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.TotalCount.html" title="enum in org.apache.solr.search">Grouping.TotalCount</A></B></CODE>
 168
 169 <BR>
 170 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 171 </TR>
 172 </TABLE>
 173 &nbsp;<!-- =========== FIELD SUMMARY =========== -->
 174
 175 <A NAME="field_summary"><!-- --></A>
 176 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 177 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 178 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 179 <B>Field Summary</B></FONT></TH>
 180 </TR>
 181 <TR BGCOLOR="white" CLASS="TableRowColor">
 182 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 183 <CODE>&nbsp;<A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A></CODE></FONT></TD>
 184 <TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.html#mainResult">mainResult</A></B></CODE>
 185
 186 <BR>
 187 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 188 </TR>
 189 </TABLE>
 190 &nbsp;
 191 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 192
 193 <A NAME="constructor_summary"><!-- --></A>
 194 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 195 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 196 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 197 <B>Constructor Summary</B></FONT></TH>
 198 </TR>
 199 <TR BGCOLOR="white" CLASS="TableRowColor">
 200 <TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.html#Grouping(org.apache.solr.search.SolrIndexSearcher, org.apache.solr.search.SolrIndexSearcher.QueryResult, org.apache.solr.search.SolrIndexSearcher.QueryCommand, boolean, int, boolean)">Grouping</A></B>(<A HREF="../../../../org/apache/solr/search/SolrIndexSearcher.html" title="class in org.apache.solr.search">SolrIndexSearcher</A>&nbsp;searcher,
 201          <A HREF="../../../../org/apache/solr/search/SolrIndexSearcher.QueryResult.html" title="class in org.apache.solr.search">SolrIndexSearcher.QueryResult</A>&nbsp;qr,
 202          <A HREF="../../../../org/apache/solr/search/SolrIndexSearcher.QueryCommand.html" title="class in org.apache.solr.search">SolrIndexSearcher.QueryCommand</A>&nbsp;cmd,
 203          boolean&nbsp;cacheSecondPassSearch,
 204          int&nbsp;maxDocsPercentageToCache,
 205          boolean&nbsp;main)</CODE>
 206
 207 <BR>
 208 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 209 </TR>
 210 </TABLE>
 211 &nbsp;
 212 <!-- ========== METHOD SUMMARY =========== -->
 213
 214 <A NAME="method_summary"><!-- --></A>
 215 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 216 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 217 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 218 <B>Method Summary</B></FONT></TH>
 219 </TR>
 220 <TR BGCOLOR="white" CLASS="TableRowColor">
 221 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 222 <CODE>&nbsp;void</CODE></FONT></TD>
 223 <TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.html#add(org.apache.solr.search.Grouping.Command)">add</A></B>(<A HREF="../../../../org/apache/solr/search/Grouping.Command.html" title="class in org.apache.solr.search">Grouping.Command</A>&nbsp;groupingCommand)</CODE>
 224
 225 <BR>
 226 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 227 </TR>
 228 <TR BGCOLOR="white" CLASS="TableRowColor">
 229 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 230 <CODE>&nbsp;void</CODE></FONT></TD>
 231 <TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.html#addFieldCommand(java.lang.String, org.apache.solr.request.SolrQueryRequest)">addFieldCommand</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>&nbsp;field,
 232                 <A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;request)</CODE>
 233
 234 <BR>
 235 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a field command based on the specified field.</TD>
 236 </TR>
 237 <TR BGCOLOR="white" CLASS="TableRowColor">
 238 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 239 <CODE>&nbsp;void</CODE></FONT></TD>
 240 <TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.html#addFunctionCommand(java.lang.String, org.apache.solr.request.SolrQueryRequest)">addFunctionCommand</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>&nbsp;groupByStr,
 241                    <A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;request)</CODE>
 242
 243 <BR>
 244 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 245 </TR>
 246 <TR BGCOLOR="white" CLASS="TableRowColor">
 247 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 248 <CODE>&nbsp;void</CODE></FONT></TD>
 249 <TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.html#addQueryCommand(java.lang.String, org.apache.solr.request.SolrQueryRequest)">addQueryCommand</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>&nbsp;groupByStr,
 250                 <A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;request)</CODE>
 251
 252 <BR>
 253 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 254 </TR>
 255 <TR BGCOLOR="white" CLASS="TableRowColor">
 256 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 257 <CODE>&nbsp;void</CODE></FONT></TD>
 258 <TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.html#execute()">execute</A></B>()</CODE>
 259
 260 <BR>
 261 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 262 </TR>
 263 <TR BGCOLOR="white" CLASS="TableRowColor">
 264 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 265 <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="../../../../org/apache/solr/search/Grouping.Command.html" title="class in org.apache.solr.search">Grouping.Command</A>&gt;</CODE></FONT></TD>
 266 <TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.html#getCommands()">getCommands</A></B>()</CODE>
 267
 268 <BR>
 269 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 270 </TR>
 271 <TR BGCOLOR="white" CLASS="TableRowColor">
 272 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 273 <CODE>&nbsp;boolean</CODE></FONT></TD>
 274 <TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.html#isSignalCacheWarning()">isSignalCacheWarning</A></B>()</CODE>
 275
 276 <BR>
 277 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns whether a cache warning should be send to the client.</TD>
 278 </TR>
 279 <TR BGCOLOR="white" CLASS="TableRowColor">
 280 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 281 <CODE>&nbsp;<A HREF="../../../../org/apache/solr/search/Grouping.html" title="class in org.apache.solr.search">Grouping</A></CODE></FONT></TD>
 282 <TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.html#setDefaultFormat(org.apache.solr.search.Grouping.Format)">setDefaultFormat</A></B>(<A HREF="../../../../org/apache/solr/search/Grouping.Format.html" title="enum in org.apache.solr.search">Grouping.Format</A>&nbsp;defaultFormat)</CODE>
 283
 284 <BR>
 285 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 286 </TR>
 287 <TR BGCOLOR="white" CLASS="TableRowColor">
 288 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 289 <CODE>&nbsp;<A HREF="../../../../org/apache/solr/search/Grouping.html" title="class in org.apache.solr.search">Grouping</A></CODE></FONT></TD>
 290 <TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.html#setDefaultTotalCount(org.apache.solr.search.Grouping.TotalCount)">setDefaultTotalCount</A></B>(<A HREF="../../../../org/apache/solr/search/Grouping.TotalCount.html" title="enum in org.apache.solr.search">Grouping.TotalCount</A>&nbsp;defaultTotalCount)</CODE>
 291
 292 <BR>
 293 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 294 </TR>
 295 <TR BGCOLOR="white" CLASS="TableRowColor">
 296 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 297 <CODE>&nbsp;<A HREF="../../../../org/apache/solr/search/Grouping.html" title="class in org.apache.solr.search">Grouping</A></CODE></FONT></TD>
 298 <TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.html#setDocsPerGroupDefault(int)">setDocsPerGroupDefault</A></B>(int&nbsp;docsPerGroupDefault)</CODE>
 299
 300 <BR>
 301 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 302 </TR>
 303 <TR BGCOLOR="white" CLASS="TableRowColor">
 304 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 305 <CODE>&nbsp;<A HREF="../../../../org/apache/solr/search/Grouping.html" title="class in org.apache.solr.search">Grouping</A></CODE></FONT></TD>
 306 <TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.html#setGetGroupedDocSet(boolean)">setGetGroupedDocSet</A></B>(boolean&nbsp;getGroupedDocSet)</CODE>
 307
 308 <BR>
 309 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 310 </TR>
 311 <TR BGCOLOR="white" CLASS="TableRowColor">
 312 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 313 <CODE>&nbsp;<A HREF="../../../../org/apache/solr/search/Grouping.html" title="class in org.apache.solr.search">Grouping</A></CODE></FONT></TD>
 314 <TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.html#setGroupOffsetDefault(int)">setGroupOffsetDefault</A></B>(int&nbsp;groupOffsetDefault)</CODE>
 315
 316 <BR>
 317 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 318 </TR>
 319 <TR BGCOLOR="white" CLASS="TableRowColor">
 320 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 321 <CODE>&nbsp;<A HREF="../../../../org/apache/solr/search/Grouping.html" title="class in org.apache.solr.search">Grouping</A></CODE></FONT></TD>
 322 <TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.html#setGroupSort(org.apache.lucene.search.Sort)">setGroupSort</A></B>(<A HREF="http://lucene.apache.org/core/4_6_0/core/org/apache/lucene/search/Sort.html?is-external=true" title="class or interface in org.apache.lucene.search">Sort</A>&nbsp;groupSort)</CODE>
 323
 324 <BR>
 325 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 326 </TR>
 327 <TR BGCOLOR="white" CLASS="TableRowColor">
 328 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 329 <CODE>&nbsp;<A HREF="../../../../org/apache/solr/search/Grouping.html" title="class in org.apache.solr.search">Grouping</A></CODE></FONT></TD>
 330 <TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.html#setLimitDefault(int)">setLimitDefault</A></B>(int&nbsp;limitDefault)</CODE>
 331
 332 <BR>
 333 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 334 </TR>
 335 <TR BGCOLOR="white" CLASS="TableRowColor">
 336 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 337 <CODE>&nbsp;<A HREF="../../../../org/apache/solr/search/Grouping.html" title="class in org.apache.solr.search">Grouping</A></CODE></FONT></TD>
 338 <TD><CODE><B><A HREF="../../../../org/apache/solr/search/Grouping.html#setSort(org.apache.lucene.search.Sort)">setSort</A></B>(<A HREF="http://lucene.apache.org/core/4_6_0/core/org/apache/lucene/search/Sort.html?is-external=true" title="class or interface in org.apache.lucene.search">Sort</A>&nbsp;sort)</CODE>
 339
 340 <BR>
 341 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 342 </TR>
 343 </TABLE>
 344 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 345 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 346 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 347 <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>
 348 </TR>
 349 <TR BGCOLOR="white" CLASS="TableRowColor">
 350 <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>
 351 </TR>
 352 </TABLE>
 353 &nbsp;
 354 <P>
 355
 356 <!-- ============ FIELD DETAIL =========== -->
 357
 358 <A NAME="field_detail"><!-- --></A>
 359 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 360 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 361 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 362 <B>Field Detail</B></FONT></TH>
 363 </TR>
 364 </TABLE>
 365
 366 <A NAME="mainResult"><!-- --></A><H3>
 367 mainResult</H3>
 368 <PRE>
 369 public <A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A> <B>mainResult</B></PRE>
 370 <DL>
 371 <DL>
 372 </DL>
 373 </DL>
 374
 375 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 376
 377 <A NAME="constructor_detail"><!-- --></A>
 378 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 379 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 380 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 381 <B>Constructor Detail</B></FONT></TH>
 382 </TR>
 383 </TABLE>
 384
 385 <A NAME="Grouping(org.apache.solr.search.SolrIndexSearcher, org.apache.solr.search.SolrIndexSearcher.QueryResult, org.apache.solr.search.SolrIndexSearcher.QueryCommand, boolean, int, boolean)"><!-- --></A><H3>
 386 Grouping</H3>
 387 <PRE>
 388 public <B>Grouping</B>(<A HREF="../../../../org/apache/solr/search/SolrIndexSearcher.html" title="class in org.apache.solr.search">SolrIndexSearcher</A>&nbsp;searcher,
 389                 <A HREF="../../../../org/apache/solr/search/SolrIndexSearcher.QueryResult.html" title="class in org.apache.solr.search">SolrIndexSearcher.QueryResult</A>&nbsp;qr,
 390                 <A HREF="../../../../org/apache/solr/search/SolrIndexSearcher.QueryCommand.html" title="class in org.apache.solr.search">SolrIndexSearcher.QueryCommand</A>&nbsp;cmd,
 391                 boolean&nbsp;cacheSecondPassSearch,
 392                 int&nbsp;maxDocsPercentageToCache,
 393                 boolean&nbsp;main)</PRE>
 394 <DL>
 395 <DL>
 396 <DT><B>Parameters:</B><DD><CODE>cacheSecondPassSearch</CODE> - Whether to cache the documents and scores from the first pass search for the second
 397                                  pass search.<DD><CODE>maxDocsPercentageToCache</CODE> - The maximum number of documents in a percentage relative from maxdoc
 398                                  that is allowed in the cache. When this threshold is met,
 399                                  the cache is not used in the second pass search.</DL>
 400 </DL>
 401
 402 <!-- ============ METHOD DETAIL ========== -->
 403
 404 <A NAME="method_detail"><!-- --></A>
 405 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 406 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 407 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 408 <B>Method Detail</B></FONT></TH>
 409 </TR>
 410 </TABLE>
 411
 412 <A NAME="add(org.apache.solr.search.Grouping.Command)"><!-- --></A><H3>
 413 add</H3>
 414 <PRE>
 415 public void <B>add</B>(<A HREF="../../../../org/apache/solr/search/Grouping.Command.html" title="class in org.apache.solr.search">Grouping.Command</A>&nbsp;groupingCommand)</PRE>
 416 <DL>
 417 <DD><DL>
 418 </DL>
 419 </DD>
 420 </DL>
 421 <HR>
 422
 423 <A NAME="addFieldCommand(java.lang.String, org.apache.solr.request.SolrQueryRequest)"><!-- --></A><H3>
 424 addFieldCommand</H3>
 425 <PRE>
 426 public void <B>addFieldCommand</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>&nbsp;field,
 427                             <A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;request)
 428                      throws <A HREF="../../../../org/apache/solr/search/SyntaxError.html" title="class in org.apache.solr.search">SyntaxError</A></PRE>
 429 <DL>
 430 <DD>Adds a field command based on the specified field.
 431  If the field is not compatible with <A HREF="../../../../org/apache/solr/search/Grouping.CommandField.html" title="class in org.apache.solr.search"><CODE>Grouping.CommandField</CODE></A> it invokes the
 432  <A HREF="../../../../org/apache/solr/search/Grouping.html#addFunctionCommand(java.lang.String, org.apache.solr.request.SolrQueryRequest)"><CODE>addFunctionCommand(String, org.apache.solr.request.SolrQueryRequest)</CODE></A> method.
 433 <P>
 434 <DD><DL>
 435 <DT><B>Parameters:</B><DD><CODE>field</CODE> - The fieldname to group by.
 436 <DT><B>Throws:</B>
 437 <DD><CODE><A HREF="../../../../org/apache/solr/search/SyntaxError.html" title="class in org.apache.solr.search">SyntaxError</A></CODE></DL>
 438 </DD>
 439 </DL>
 440 <HR>
 441
 442 <A NAME="addFunctionCommand(java.lang.String, org.apache.solr.request.SolrQueryRequest)"><!-- --></A><H3>
 443 addFunctionCommand</H3>
 444 <PRE>
 445 public void <B>addFunctionCommand</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>&nbsp;groupByStr,
 446                                <A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;request)
 447                         throws <A HREF="../../../../org/apache/solr/search/SyntaxError.html" title="class in org.apache.solr.search">SyntaxError</A></PRE>
 448 <DL>
 449 <DD><DL>
 450
 451 <DT><B>Throws:</B>
 452 <DD><CODE><A HREF="../../../../org/apache/solr/search/SyntaxError.html" title="class in org.apache.solr.search">SyntaxError</A></CODE></DL>
 453 </DD>
 454 </DL>
 455 <HR>
 456
 457 <A NAME="addQueryCommand(java.lang.String, org.apache.solr.request.SolrQueryRequest)"><!-- --></A><H3>
 458 addQueryCommand</H3>
 459 <PRE>
 460 public void <B>addQueryCommand</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>&nbsp;groupByStr,
 461                             <A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;request)
 462                      throws <A HREF="../../../../org/apache/solr/search/SyntaxError.html" title="class in org.apache.solr.search">SyntaxError</A></PRE>
 463 <DL>
 464 <DD><DL>
 465
 466 <DT><B>Throws:</B>
 467 <DD><CODE><A HREF="../../../../org/apache/solr/search/SyntaxError.html" title="class in org.apache.solr.search">SyntaxError</A></CODE></DL>
 468 </DD>
 469 </DL>
 470 <HR>
 471
 472 <A NAME="setSort(org.apache.lucene.search.Sort)"><!-- --></A><H3>
 473 setSort</H3>
 474 <PRE>
 475 public <A HREF="../../../../org/apache/solr/search/Grouping.html" title="class in org.apache.solr.search">Grouping</A> <B>setSort</B>(<A HREF="http://lucene.apache.org/core/4_6_0/core/org/apache/lucene/search/Sort.html?is-external=true" title="class or interface in org.apache.lucene.search">Sort</A>&nbsp;sort)</PRE>
 476 <DL>
 477 <DD><DL>
 478 </DL>
 479 </DD>
 480 </DL>
 481 <HR>
 482
 483 <A NAME="setGroupSort(org.apache.lucene.search.Sort)"><!-- --></A><H3>
 484 setGroupSort</H3>
 485 <PRE>
 486 public <A HREF="../../../../org/apache/solr/search/Grouping.html" title="class in org.apache.solr.search">Grouping</A> <B>setGroupSort</B>(<A HREF="http://lucene.apache.org/core/4_6_0/core/org/apache/lucene/search/Sort.html?is-external=true" title="class or interface in org.apache.lucene.search">Sort</A>&nbsp;groupSort)</PRE>
 487 <DL>
 488 <DD><DL>
 489 </DL>
 490 </DD>
 491 </DL>
 492 <HR>
 493
 494 <A NAME="setLimitDefault(int)"><!-- --></A><H3>
 495 setLimitDefault</H3>
 496 <PRE>
 497 public <A HREF="../../../../org/apache/solr/search/Grouping.html" title="class in org.apache.solr.search">Grouping</A> <B>setLimitDefault</B>(int&nbsp;limitDefault)</PRE>
 498 <DL>
 499 <DD><DL>
 500 </DL>
 501 </DD>
 502 </DL>
 503 <HR>
 504
 505 <A NAME="setDocsPerGroupDefault(int)"><!-- --></A><H3>
 506 setDocsPerGroupDefault</H3>
 507 <PRE>
 508 public <A HREF="../../../../org/apache/solr/search/Grouping.html" title="class in org.apache.solr.search">Grouping</A> <B>setDocsPerGroupDefault</B>(int&nbsp;docsPerGroupDefault)</PRE>
 509 <DL>
 510 <DD><DL>
 511 </DL>
 512 </DD>
 513 </DL>
 514 <HR>
 515
 516 <A NAME="setGroupOffsetDefault(int)"><!-- --></A><H3>
 517 setGroupOffsetDefault</H3>
 518 <PRE>
 519 public <A HREF="../../../../org/apache/solr/search/Grouping.html" title="class in org.apache.solr.search">Grouping</A> <B>setGroupOffsetDefault</B>(int&nbsp;groupOffsetDefault)</PRE>
 520 <DL>
 521 <DD><DL>
 522 </DL>
 523 </DD>
 524 </DL>
 525 <HR>
 526
 527 <A NAME="setDefaultFormat(org.apache.solr.search.Grouping.Format)"><!-- --></A><H3>
 528 setDefaultFormat</H3>
 529 <PRE>
 530 public <A HREF="../../../../org/apache/solr/search/Grouping.html" title="class in org.apache.solr.search">Grouping</A> <B>setDefaultFormat</B>(<A HREF="../../../../org/apache/solr/search/Grouping.Format.html" title="enum in org.apache.solr.search">Grouping.Format</A>&nbsp;defaultFormat)</PRE>
 531 <DL>
 532 <DD><DL>
 533 </DL>
 534 </DD>
 535 </DL>
 536 <HR>
 537
 538 <A NAME="setDefaultTotalCount(org.apache.solr.search.Grouping.TotalCount)"><!-- --></A><H3>
 539 setDefaultTotalCount</H3>
 540 <PRE>
 541 public <A HREF="../../../../org/apache/solr/search/Grouping.html" title="class in org.apache.solr.search">Grouping</A> <B>setDefaultTotalCount</B>(<A HREF="../../../../org/apache/solr/search/Grouping.TotalCount.html" title="enum in org.apache.solr.search">Grouping.TotalCount</A>&nbsp;defaultTotalCount)</PRE>
 542 <DL>
 543 <DD><DL>
 544 </DL>
 545 </DD>
 546 </DL>
 547 <HR>
 548
 549 <A NAME="setGetGroupedDocSet(boolean)"><!-- --></A><H3>
 550 setGetGroupedDocSet</H3>
 551 <PRE>
 552 public <A HREF="../../../../org/apache/solr/search/Grouping.html" title="class in org.apache.solr.search">Grouping</A> <B>setGetGroupedDocSet</B>(boolean&nbsp;getGroupedDocSet)</PRE>
 553 <DL>
 554 <DD><DL>
 555 </DL>
 556 </DD>
 557 </DL>
 558 <HR>
 559
 560 <A NAME="getCommands()"><!-- --></A><H3>
 561 getCommands</H3>
 562 <PRE>
 563 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>&lt;<A HREF="../../../../org/apache/solr/search/Grouping.Command.html" title="class in org.apache.solr.search">Grouping.Command</A>&gt; <B>getCommands</B>()</PRE>
 564 <DL>
 565 <DD><DL>
 566 </DL>
 567 </DD>
 568 </DL>
 569 <HR>
 570
 571 <A NAME="execute()"><!-- --></A><H3>
 572 execute</H3>
 573 <PRE>
 574 public void <B>execute</B>()
 575              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>
 576 <DL>
 577 <DD><DL>
 578
 579 <DT><B>Throws:</B>
 580 <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></DL>
 581 </DD>
 582 </DL>
 583 <HR>
 584
 585 <A NAME="isSignalCacheWarning()"><!-- --></A><H3>
 586 isSignalCacheWarning</H3>
 587 <PRE>
 588 public boolean <B>isSignalCacheWarning</B>()</PRE>
 589 <DL>
 590 <DD>Returns whether a cache warning should be send to the client.
 591  The value <code>true</code> is returned when the cache is emptied because the caching limits where met, otherwise
 592  <code>false</code> is returned.
 593 <P>
 594 <DD><DL>
 595
 596 <DT><B>Returns:</B><DD>whether a cache warning should be send to the client</DL>
 597 </DD>
 598 </DL>
 599 <!-- ========= END OF CLASS DATA ========= -->
 600 <HR>
 601
 602
 603 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 604 <A NAME="navbar_bottom"><!-- --></A>
 605 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 606 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 607 <TR>
 608 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 609 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 610 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 611   <TR ALIGN="center" VALIGN="top">
 612   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 613   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 614   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 615   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Grouping.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 616   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 617   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 618   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 619   </TR>
 620 </TABLE>
 621 </TD>
 622 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 623 </EM>
 624 </TD>
 625 </TR>
 626
 627 <TR>
 628 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 629 &nbsp;<A HREF="../../../../org/apache/solr/search/FunctionRangeQuery.html" title="class in org.apache.solr.search"><B>PREV CLASS</B></A>&nbsp;
 630 &nbsp;<A HREF="../../../../org/apache/solr/search/Grouping.Command.html" title="class in org.apache.solr.search"><B>NEXT CLASS</B></A></FONT></TD>
 631 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 632   <A HREF="../../../../index.html?org/apache/solr/search/Grouping.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 633 &nbsp;<A HREF="Grouping.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 634 &nbsp;<SCRIPT type="text/javascript">
 635   <!--
 636   if(window==top) {
 637     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
 638   }
 639   //-->
 640 </SCRIPT>
 641 <NOSCRIPT>
 642   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
 643 </NOSCRIPT>
 644
 645
 646 </FONT></TD>
 647 </TR>
 648 <TR>
 649 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 650   SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&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>
 651 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 652 DETAIL:&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>
 653 </TR>
 654 </TABLE>
 655 <A NAME="skip-navbar_bottom"></A>
 656 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 657
 658 <HR>
 659
 660           <i>Copyright &copy; 2000-2013 Apache Software Foundation.  All Rights Reserved.</i>
 661           <script src='../../../../prettify.js' type='text/javascript'></script>
 662           <script type='text/javascript'>
 663             (function(){
 664               var oldonload = window.onload;
 665               if (typeof oldonload != 'function') {
 666                 window.onload = prettyPrint;
 667               } else {
 668                 window.onload = function() {
 669                   oldonload();
 670                   prettyPrint();
 671                 }
 672               }
 673             })();
 674           </script>
 675
 676 </BODY>
 677 </HTML>