solr-4.6.0/docs/solr-core/org/apache/solr/handler/component/QueryComponent.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:52 CET 2013 -->
   6 <META http-equiv="Content-Type" content="text/html; charset=utf-8">
   7 <TITLE>
   8 QueryComponent (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="QueryComponent (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/QueryComponent.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/handler/component/PivotFacetHelper.html" title="class in org.apache.solr.handler.component"><B>PREV CLASS</B></A>&nbsp;
  59 &nbsp;<A HREF="../../../../../org/apache/solr/handler/component/QueryElevationComponent.html" title="class in org.apache.solr.handler.component"><B>NEXT CLASS</B></A></FONT></TD>
  60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  61   <A HREF="../../../../../index.html?org/apache/solr/handler/component/QueryComponent.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  62 &nbsp;<A HREF="QueryComponent.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  63 &nbsp;<SCRIPT type="text/javascript">
  64   <!--
  65   if(window==top) {
  66     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  67   }
  68   //-->
  69 </SCRIPT>
  70 <NOSCRIPT>
  71   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
  72 </NOSCRIPT>
  73
  74
  75 </FONT></TD>
  76 </TR>
  77 <TR>
  78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  79   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  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.handler.component</FONT>
  92 <BR>
  93 Class QueryComponent</H2>
  94 <PRE>
  95 <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
  96   <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">org.apache.solr.handler.component.SearchComponent</A>
  97       <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.solr.handler.component.QueryComponent</B>
  98 </PRE>
  99 <DL>
 100 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A>, <A HREF="../../../../../org/apache/solr/util/plugin/NamedListInitializedPlugin.html" title="interface in org.apache.solr.util.plugin">NamedListInitializedPlugin</A></DD>
 101 </DL>
 102 <HR>
 103 <DL>
 104 <DT><PRE>public class <B>QueryComponent</B><DT>extends <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A></DL>
 105 </PRE>
 106
 107 <P>
 108 TODO!
 109 <P>
 110
 111 <P>
 112 <DL>
 113 <DT><B>Since:</B></DT>
 114   <DD>solr 1.3</DD>
 115 </DL>
 116 <HR>
 117
 118 <P>
 119 <!-- ======== NESTED CLASS SUMMARY ======== -->
 120
 121 <A NAME="nested_class_summary"><!-- --></A>
 122 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 123 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 124 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 125 <B>Nested Class Summary</B></FONT></TH>
 126 </TR>
 127 </TABLE>
 128 &nbsp;<A NAME="nested_classes_inherited_from_class_org.apache.solr.core.SolrInfoMBean"><!-- --></A>
 129 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 130 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 131 <TH ALIGN="left"><B>Nested classes/interfaces inherited from interface org.apache.solr.core.<A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></B></TH>
 132 </TR>
 133 <TR BGCOLOR="white" CLASS="TableRowColor">
 134 <TD><CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.Category.html" title="enum in org.apache.solr.core">SolrInfoMBean.Category</A></CODE></TD>
 135 </TR>
 136 </TABLE>
 137 &nbsp;
 138 <!-- =========== FIELD SUMMARY =========== -->
 139
 140 <A NAME="field_summary"><!-- --></A>
 141 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 142 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 143 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 144 <B>Field Summary</B></FONT></TH>
 145 </TR>
 146 <TR BGCOLOR="white" CLASS="TableRowColor">
 147 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 148 <CODE>static&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
 149 <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/QueryComponent.html#COMPONENT_NAME">COMPONENT_NAME</A></B></CODE>
 150
 151 <BR>
 152 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 153 </TR>
 154 </TABLE>
 155 &nbsp;
 156 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 157
 158 <A NAME="constructor_summary"><!-- --></A>
 159 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 160 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 161 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 162 <B>Constructor Summary</B></FONT></TH>
 163 </TR>
 164 <TR BGCOLOR="white" CLASS="TableRowColor">
 165 <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/QueryComponent.html#QueryComponent()">QueryComponent</A></B>()</CODE>
 166
 167 <BR>
 168 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 169 </TR>
 170 </TABLE>
 171 &nbsp;
 172 <!-- ========== METHOD SUMMARY =========== -->
 173
 174 <A NAME="method_summary"><!-- --></A>
 175 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 176 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 177 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 178 <B>Method Summary</B></FONT></TH>
 179 </TR>
 180 <TR BGCOLOR="white" CLASS="TableRowColor">
 181 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 182 <CODE>&nbsp;int</CODE></FONT></TD>
 183 <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/QueryComponent.html#distributedProcess(org.apache.solr.handler.component.ResponseBuilder)">distributedProcess</A></B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A>&nbsp;rb)</CODE>
 184
 185 <BR>
 186 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Process for a distributed search.</TD>
 187 </TR>
 188 <TR BGCOLOR="white" CLASS="TableRowColor">
 189 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 190 <CODE>protected &nbsp;void</CODE></FONT></TD>
 191 <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/QueryComponent.html#doFieldSortValues(org.apache.solr.handler.component.ResponseBuilder, org.apache.solr.search.SolrIndexSearcher)">doFieldSortValues</A></B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A>&nbsp;rb,
 192                   <A HREF="../../../../../org/apache/solr/search/SolrIndexSearcher.html" title="class in org.apache.solr.search">SolrIndexSearcher</A>&nbsp;searcher)</CODE>
 193
 194 <BR>
 195 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 196 </TR>
 197 <TR BGCOLOR="white" CLASS="TableRowColor">
 198 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 199 <CODE>protected &nbsp;void</CODE></FONT></TD>
 200 <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/QueryComponent.html#doPrefetch(org.apache.solr.handler.component.ResponseBuilder)">doPrefetch</A></B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A>&nbsp;rb)</CODE>
 201
 202 <BR>
 203 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 204 </TR>
 205 <TR BGCOLOR="white" CLASS="TableRowColor">
 206 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 207 <CODE>&nbsp;void</CODE></FONT></TD>
 208 <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/QueryComponent.html#finishStage(org.apache.solr.handler.component.ResponseBuilder)">finishStage</A></B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A>&nbsp;rb)</CODE>
 209
 210 <BR>
 211 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called after all responses have been received for this stage.</TD>
 212 </TR>
 213 <TR BGCOLOR="white" CLASS="TableRowColor">
 214 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 215 <CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
 216 <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/QueryComponent.html#getDescription()">getDescription</A></B>()</CODE>
 217
 218 <BR>
 219 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Simple one or two line description</TD>
 220 </TR>
 221 <TR BGCOLOR="white" CLASS="TableRowColor">
 222 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 223 <CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</A>[]</CODE></FONT></TD>
 224 <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/QueryComponent.html#getDocs()">getDocs</A></B>()</CODE>
 225
 226 <BR>
 227 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Documentation URL list.</TD>
 228 </TR>
 229 <TR BGCOLOR="white" CLASS="TableRowColor">
 230 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 231 <CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
 232 <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/QueryComponent.html#getSource()">getSource</A></B>()</CODE>
 233
 234 <BR>
 235 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CVS Source, SVN Source, etc</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/handler/component/QueryComponent.html#handleResponses(org.apache.solr.handler.component.ResponseBuilder, org.apache.solr.handler.component.ShardRequest)">handleResponses</A></B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A>&nbsp;rb,
 241                 <A HREF="../../../../../org/apache/solr/handler/component/ShardRequest.html" title="class in org.apache.solr.handler.component">ShardRequest</A>&nbsp;sreq)</CODE>
 242
 243 <BR>
 244 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called after all responses for a single request were received</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/handler/component/QueryComponent.html#prepare(org.apache.solr.handler.component.ResponseBuilder)">prepare</A></B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A>&nbsp;rb)</CODE>
 250
 251 <BR>
 252 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Prepare the response.</TD>
 253 </TR>
 254 <TR BGCOLOR="white" CLASS="TableRowColor">
 255 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 256 <CODE>&nbsp;void</CODE></FONT></TD>
 257 <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/QueryComponent.html#process(org.apache.solr.handler.component.ResponseBuilder)">process</A></B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A>&nbsp;rb)</CODE>
 258
 259 <BR>
 260 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Actually run the query</TD>
 261 </TR>
 262 </TABLE>
 263 &nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.handler.component.SearchComponent"><!-- --></A>
 264 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 265 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 266 <TH ALIGN="left"><B>Methods inherited from class org.apache.solr.handler.component.<A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A></B></TH>
 267 </TR>
 268 <TR BGCOLOR="white" CLASS="TableRowColor">
 269 <TD><CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getCategory()">getCategory</A>, <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getName()">getName</A>, <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getStatistics()">getStatistics</A>, <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getVersion()">getVersion</A>, <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#init(org.apache.solr.common.util.NamedList)">init</A>, <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#modifyRequest(org.apache.solr.handler.component.ResponseBuilder, org.apache.solr.handler.component.SearchComponent, org.apache.solr.handler.component.ShardRequest)">modifyRequest</A>, <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#setName(java.lang.String)">setName</A></CODE></TD>
 270 </TR>
 271 </TABLE>
 272 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 273 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 274 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 275 <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>
 276 </TR>
 277 <TR BGCOLOR="white" CLASS="TableRowColor">
 278 <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>
 279 </TR>
 280 </TABLE>
 281 &nbsp;
 282 <P>
 283
 284 <!-- ============ FIELD DETAIL =========== -->
 285
 286 <A NAME="field_detail"><!-- --></A>
 287 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 288 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 289 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 290 <B>Field Detail</B></FONT></TH>
 291 </TR>
 292 </TABLE>
 293
 294 <A NAME="COMPONENT_NAME"><!-- --></A><H3>
 295 COMPONENT_NAME</H3>
 296 <PRE>
 297 public 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>COMPONENT_NAME</B></PRE>
 298 <DL>
 299 <DL>
 300 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.handler.component.QueryComponent.COMPONENT_NAME">Constant Field Values</A></DL>
 301 </DL>
 302
 303 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 304
 305 <A NAME="constructor_detail"><!-- --></A>
 306 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 307 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 308 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 309 <B>Constructor Detail</B></FONT></TH>
 310 </TR>
 311 </TABLE>
 312
 313 <A NAME="QueryComponent()"><!-- --></A><H3>
 314 QueryComponent</H3>
 315 <PRE>
 316 public <B>QueryComponent</B>()</PRE>
 317 <DL>
 318 </DL>
 319
 320 <!-- ============ METHOD DETAIL ========== -->
 321
 322 <A NAME="method_detail"><!-- --></A>
 323 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 324 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 325 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 326 <B>Method Detail</B></FONT></TH>
 327 </TR>
 328 </TABLE>
 329
 330 <A NAME="prepare(org.apache.solr.handler.component.ResponseBuilder)"><!-- --></A><H3>
 331 prepare</H3>
 332 <PRE>
 333 public void <B>prepare</B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A>&nbsp;rb)
 334              throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
 335 <DL>
 336 <DD><B>Description copied from class: <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#prepare(org.apache.solr.handler.component.ResponseBuilder)">SearchComponent</A></CODE></B></DD>
 337 <DD>Prepare the response.  Guaranteed to be called before any SearchComponent <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#process(org.apache.solr.handler.component.ResponseBuilder)"><CODE>SearchComponent.process(org.apache.solr.handler.component.ResponseBuilder)</CODE></A> method.
 338  Called for every incoming request.
 339
 340  The place to do initialization that is request dependent.
 341 <P>
 342 <DD><DL>
 343 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#prepare(org.apache.solr.handler.component.ResponseBuilder)">prepare</A></CODE> in class <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A></CODE></DL>
 344 </DD>
 345 <DD><DL>
 346 <DT><B>Parameters:</B><DD><CODE>rb</CODE> - The <A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component"><CODE>ResponseBuilder</CODE></A>
 347 <DT><B>Throws:</B>
 348 <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - If there is a low-level I/O error.</DL>
 349 </DD>
 350 </DL>
 351 <HR>
 352
 353 <A NAME="process(org.apache.solr.handler.component.ResponseBuilder)"><!-- --></A><H3>
 354 process</H3>
 355 <PRE>
 356 public void <B>process</B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A>&nbsp;rb)
 357              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>
 358 <DL>
 359 <DD>Actually run the query
 360 <P>
 361 <DD><DL>
 362 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#process(org.apache.solr.handler.component.ResponseBuilder)">process</A></CODE> in class <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A></CODE></DL>
 363 </DD>
 364 <DD><DL>
 365 <DT><B>Parameters:</B><DD><CODE>rb</CODE> - The <A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component"><CODE>ResponseBuilder</CODE></A>
 366 <DT><B>Throws:</B>
 367 <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - If there is a low-level I/O error.</DL>
 368 </DD>
 369 </DL>
 370 <HR>
 371
 372 <A NAME="doFieldSortValues(org.apache.solr.handler.component.ResponseBuilder, org.apache.solr.search.SolrIndexSearcher)"><!-- --></A><H3>
 373 doFieldSortValues</H3>
 374 <PRE>
 375 protected void <B>doFieldSortValues</B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A>&nbsp;rb,
 376                                  <A HREF="../../../../../org/apache/solr/search/SolrIndexSearcher.html" title="class in org.apache.solr.search">SolrIndexSearcher</A>&nbsp;searcher)
 377                           throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
 378 <DL>
 379 <DD><DL>
 380
 381 <DT><B>Throws:</B>
 382 <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>
 383 </DD>
 384 </DL>
 385 <HR>
 386
 387 <A NAME="doPrefetch(org.apache.solr.handler.component.ResponseBuilder)"><!-- --></A><H3>
 388 doPrefetch</H3>
 389 <PRE>
 390 protected void <B>doPrefetch</B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A>&nbsp;rb)
 391                    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>
 392 <DL>
 393 <DD><DL>
 394
 395 <DT><B>Throws:</B>
 396 <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>
 397 </DD>
 398 </DL>
 399 <HR>
 400
 401 <A NAME="distributedProcess(org.apache.solr.handler.component.ResponseBuilder)"><!-- --></A><H3>
 402 distributedProcess</H3>
 403 <PRE>
 404 public int <B>distributedProcess</B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A>&nbsp;rb)
 405                        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>
 406 <DL>
 407 <DD><B>Description copied from class: <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#distributedProcess(org.apache.solr.handler.component.ResponseBuilder)">SearchComponent</A></CODE></B></DD>
 408 <DD>Process for a distributed search.
 409 <P>
 410 <DD><DL>
 411 <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#distributedProcess(org.apache.solr.handler.component.ResponseBuilder)">distributedProcess</A></CODE> in class <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A></CODE></DL>
 412 </DD>
 413 <DD><DL>
 414
 415 <DT><B>Returns:</B><DD>the next stage for this component
 416 <DT><B>Throws:</B>
 417 <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>
 418 </DD>
 419 </DL>
 420 <HR>
 421
 422 <A NAME="handleResponses(org.apache.solr.handler.component.ResponseBuilder, org.apache.solr.handler.component.ShardRequest)"><!-- --></A><H3>
 423 handleResponses</H3>
 424 <PRE>
 425 public void <B>handleResponses</B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A>&nbsp;rb,
 426                             <A HREF="../../../../../org/apache/solr/handler/component/ShardRequest.html" title="class in org.apache.solr.handler.component">ShardRequest</A>&nbsp;sreq)</PRE>
 427 <DL>
 428 <DD><B>Description copied from class: <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#handleResponses(org.apache.solr.handler.component.ResponseBuilder, org.apache.solr.handler.component.ShardRequest)">SearchComponent</A></CODE></B></DD>
 429 <DD>Called after all responses for a single request were received
 430 <P>
 431 <DD><DL>
 432 <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#handleResponses(org.apache.solr.handler.component.ResponseBuilder, org.apache.solr.handler.component.ShardRequest)">handleResponses</A></CODE> in class <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A></CODE></DL>
 433 </DD>
 434 <DD><DL>
 435 </DL>
 436 </DD>
 437 </DL>
 438 <HR>
 439
 440 <A NAME="finishStage(org.apache.solr.handler.component.ResponseBuilder)"><!-- --></A><H3>
 441 finishStage</H3>
 442 <PRE>
 443 public void <B>finishStage</B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A>&nbsp;rb)</PRE>
 444 <DL>
 445 <DD><B>Description copied from class: <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#finishStage(org.apache.solr.handler.component.ResponseBuilder)">SearchComponent</A></CODE></B></DD>
 446 <DD>Called after all responses have been received for this stage.
 447  Useful when different requests are sent to each shard.
 448 <P>
 449 <DD><DL>
 450 <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#finishStage(org.apache.solr.handler.component.ResponseBuilder)">finishStage</A></CODE> in class <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A></CODE></DL>
 451 </DD>
 452 <DD><DL>
 453 </DL>
 454 </DD>
 455 </DL>
 456 <HR>
 457
 458 <A NAME="getDescription()"><!-- --></A><H3>
 459 getDescription</H3>
 460 <PRE>
 461 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>getDescription</B>()</PRE>
 462 <DL>
 463 <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getDescription()">SolrInfoMBean</A></CODE></B></DD>
 464 <DD>Simple one or two line description
 465 <P>
 466 <DD><DL>
 467 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getDescription()">getDescription</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getDescription()">getDescription</A></CODE> in class <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A></CODE></DL>
 468 </DD>
 469 <DD><DL>
 470 </DL>
 471 </DD>
 472 </DL>
 473 <HR>
 474
 475 <A NAME="getSource()"><!-- --></A><H3>
 476 getSource</H3>
 477 <PRE>
 478 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>getSource</B>()</PRE>
 479 <DL>
 480 <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getSource()">SolrInfoMBean</A></CODE></B></DD>
 481 <DD>CVS Source, SVN Source, etc
 482 <P>
 483 <DD><DL>
 484 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getSource()">getSource</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getSource()">getSource</A></CODE> in class <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A></CODE></DL>
 485 </DD>
 486 <DD><DL>
 487 </DL>
 488 </DD>
 489 </DL>
 490 <HR>
 491
 492 <A NAME="getDocs()"><!-- --></A><H3>
 493 getDocs</H3>
 494 <PRE>
 495 public <A HREF="http://download.oracle.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</A>[] <B>getDocs</B>()</PRE>
 496 <DL>
 497 <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getDocs()">SolrInfoMBean</A></CODE></B></DD>
 498 <DD>Documentation URL list.
 499
 500  <p>
 501  Suggested documentation URLs: Homepage for sponsoring project,
 502  FAQ on class usage, Design doc for class, Wiki, bug reporting URL, etc...
 503  </p>
 504 <P>
 505 <DD><DL>
 506 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getDocs()">getDocs</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getDocs()">getDocs</A></CODE> in class <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A></CODE></DL>
 507 </DD>
 508 <DD><DL>
 509 </DL>
 510 </DD>
 511 </DL>
 512 <!-- ========= END OF CLASS DATA ========= -->
 513 <HR>
 514
 515
 516 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 517 <A NAME="navbar_bottom"><!-- --></A>
 518 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 519 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 520 <TR>
 521 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 522 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 523 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 524   <TR ALIGN="center" VALIGN="top">
 525   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 526   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 527   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 528   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/QueryComponent.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 529   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 530   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 531   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 532   </TR>
 533 </TABLE>
 534 </TD>
 535 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 536 </EM>
 537 </TD>
 538 </TR>
 539
 540 <TR>
 541 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 542 &nbsp;<A HREF="../../../../../org/apache/solr/handler/component/PivotFacetHelper.html" title="class in org.apache.solr.handler.component"><B>PREV CLASS</B></A>&nbsp;
 543 &nbsp;<A HREF="../../../../../org/apache/solr/handler/component/QueryElevationComponent.html" title="class in org.apache.solr.handler.component"><B>NEXT CLASS</B></A></FONT></TD>
 544 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 545   <A HREF="../../../../../index.html?org/apache/solr/handler/component/QueryComponent.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 546 &nbsp;<A HREF="QueryComponent.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 547 &nbsp;<SCRIPT type="text/javascript">
 548   <!--
 549   if(window==top) {
 550     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
 551   }
 552   //-->
 553 </SCRIPT>
 554 <NOSCRIPT>
 555   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
 556 </NOSCRIPT>
 557
 558
 559 </FONT></TD>
 560 </TR>
 561 <TR>
 562 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 563   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 564 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 565 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>
 566 </TR>
 567 </TABLE>
 568 <A NAME="skip-navbar_bottom"></A>
 569 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 570
 571 <HR>
 572
 573           <i>Copyright &copy; 2000-2013 Apache Software Foundation.  All Rights Reserved.</i>
 574           <script src='../../../../../prettify.js' type='text/javascript'></script>
 575           <script type='text/javascript'>
 576             (function(){
 577               var oldonload = window.onload;
 578               if (typeof oldonload != 'function') {
 579                 window.onload = prettyPrint;
 580               } else {
 581                 window.onload = function() {
 582                   oldonload();
 583                   prettyPrint();
 584                 }
 585               }
 586             })();
 587           </script>
 588
 589 </BODY>
 590 </HTML>