source: sandbox/expresso-solr/solr/docs/api/org/apache/solr/handler/component/DebugComponent.html @ 7588

Revision 7588, 31.9 KB checked in by adir, 11 years ago (diff)

Ticket #000 - Adicionando a integracao de buscas com Solr na base a ser isnerida na comunidade

Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.6.0_24) on Mon Jun 25 15:26:24 EDT 2012 -->
6<META http-equiv="Content-Type" content="text/html; charset=utf-8">
7<TITLE>
8DebugComponent (Solr 4.0.0-ALPHA API)
9</TITLE>
10
11<META NAME="date" CONTENT="2012-06-25">
12
13<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
14
15<SCRIPT type="text/javascript">
16function windowTitle()
17{
18    if (location.href.indexOf('is-external=true') == -1) {
19        parent.document.title="DebugComponent (Solr 4.0.0-ALPHA API)";
20    }
21}
22</SCRIPT>
23<NOSCRIPT>
24</NOSCRIPT>
25
26</HEAD>
27
28<BODY BGCOLOR="white" onload="windowTitle();">
29<HR>
30
31
32<!-- ========= START OF TOP NAVBAR ======= -->
33<A NAME="navbar_top"><!-- --></A>
34<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
35<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
36<TR>
37<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
38<A NAME="navbar_top_firstrow"><!-- --></A>
39<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
40  <TR ALIGN="center" VALIGN="top">
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
43  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/DebugComponent.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;PREV CLASS&nbsp;
59&nbsp;<A HREF="../../../../../org/apache/solr/handler/component/FacetComponent.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/DebugComponent.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="DebugComponent.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">
81DETAIL:&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">
91org.apache.solr.handler.component</FONT>
92<BR>
93Class DebugComponent</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.DebugComponent</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>DebugComponent</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>
108Adds debugging information to a request.
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/DebugComponent.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/DebugComponent.html#DebugComponent()">DebugComponent</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;void</CODE></FONT></TD>
183<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/DebugComponent.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>
184
185<BR>
186&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called after all responses have been received for this stage.</TD>
187</TR>
188<TR BGCOLOR="white" CLASS="TableRowColor">
189<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
190<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>
191<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/DebugComponent.html#getDescription()">getDescription</A></B>()</CODE>
192
193<BR>
194&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Simple one or two line description</TD>
195</TR>
196<TR BGCOLOR="white" CLASS="TableRowColor">
197<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
198<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>
199<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/DebugComponent.html#getDocs()">getDocs</A></B>()</CODE>
200
201<BR>
202&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Documentation URL list.</TD>
203</TR>
204<TR BGCOLOR="white" CLASS="TableRowColor">
205<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
206<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>
207<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/DebugComponent.html#getSource()">getSource</A></B>()</CODE>
208
209<BR>
210&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CVS Source, SVN Source, etc</TD>
211</TR>
212<TR BGCOLOR="white" CLASS="TableRowColor">
213<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
214<CODE>&nbsp;void</CODE></FONT></TD>
215<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/DebugComponent.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,
216                <A HREF="../../../../../org/apache/solr/handler/component/ShardRequest.html" title="class in org.apache.solr.handler.component">ShardRequest</A>&nbsp;sreq)</CODE>
217
218<BR>
219&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called after all responses for a single request were received</TD>
220</TR>
221<TR BGCOLOR="white" CLASS="TableRowColor">
222<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
223<CODE>&nbsp;void</CODE></FONT></TD>
224<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/DebugComponent.html#modifyRequest(org.apache.solr.handler.component.ResponseBuilder, org.apache.solr.handler.component.SearchComponent, org.apache.solr.handler.component.ShardRequest)">modifyRequest</A></B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A>&nbsp;rb,
225              <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A>&nbsp;who,
226              <A HREF="../../../../../org/apache/solr/handler/component/ShardRequest.html" title="class in org.apache.solr.handler.component">ShardRequest</A>&nbsp;sreq)</CODE>
227
228<BR>
229&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called after another component adds a request</TD>
230</TR>
231<TR BGCOLOR="white" CLASS="TableRowColor">
232<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
233<CODE>&nbsp;void</CODE></FONT></TD>
234<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/DebugComponent.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>
235
236<BR>
237&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Prepare the response.</TD>
238</TR>
239<TR BGCOLOR="white" CLASS="TableRowColor">
240<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
241<CODE>&nbsp;void</CODE></FONT></TD>
242<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/DebugComponent.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>
243
244<BR>
245&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Process the request for this component</TD>
246</TR>
247</TABLE>
248&nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.handler.component.SearchComponent"><!-- --></A>
249<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
250<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
251<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>
252</TR>
253<TR BGCOLOR="white" CLASS="TableRowColor">
254<TD><CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#distributedProcess(org.apache.solr.handler.component.ResponseBuilder)">distributedProcess</A>, <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></CODE></TD>
255</TR>
256</TABLE>
257&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
258<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
259<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
260<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>
261</TR>
262<TR BGCOLOR="white" CLASS="TableRowColor">
263<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>
264</TR>
265</TABLE>
266&nbsp;
267<P>
268
269<!-- ============ FIELD DETAIL =========== -->
270
271<A NAME="field_detail"><!-- --></A>
272<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
273<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
274<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
275<B>Field Detail</B></FONT></TH>
276</TR>
277</TABLE>
278
279<A NAME="COMPONENT_NAME"><!-- --></A><H3>
280COMPONENT_NAME</H3>
281<PRE>
282public 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>
283<DL>
284<DL>
285<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.handler.component.DebugComponent.COMPONENT_NAME">Constant Field Values</A></DL>
286</DL>
287
288<!-- ========= CONSTRUCTOR DETAIL ======== -->
289
290<A NAME="constructor_detail"><!-- --></A>
291<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
292<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
293<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
294<B>Constructor Detail</B></FONT></TH>
295</TR>
296</TABLE>
297
298<A NAME="DebugComponent()"><!-- --></A><H3>
299DebugComponent</H3>
300<PRE>
301public <B>DebugComponent</B>()</PRE>
302<DL>
303</DL>
304
305<!-- ============ METHOD DETAIL ========== -->
306
307<A NAME="method_detail"><!-- --></A>
308<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
309<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
310<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
311<B>Method Detail</B></FONT></TH>
312</TR>
313</TABLE>
314
315<A NAME="prepare(org.apache.solr.handler.component.ResponseBuilder)"><!-- --></A><H3>
316prepare</H3>
317<PRE>
318public 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)
319             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>
320<DL>
321<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>
322<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.
323 Called for every incoming request.
324
325 The place to do initialization that is request dependent.
326<P>
327<DD><DL>
328<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>
329</DD>
330<DD><DL>
331<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>
332<DT><B>Throws:</B>
333<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>
334</DD>
335</DL>
336<HR>
337
338<A NAME="process(org.apache.solr.handler.component.ResponseBuilder)"><!-- --></A><H3>
339process</H3>
340<PRE>
341public 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)
342             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>
343<DL>
344<DD><B>Description copied from class: <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#process(org.apache.solr.handler.component.ResponseBuilder)">SearchComponent</A></CODE></B></DD>
345<DD>Process the request for this component
346<P>
347<DD><DL>
348<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>
349</DD>
350<DD><DL>
351<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>
352<DT><B>Throws:</B>
353<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>
354</DD>
355</DL>
356<HR>
357
358<A NAME="modifyRequest(org.apache.solr.handler.component.ResponseBuilder, org.apache.solr.handler.component.SearchComponent, org.apache.solr.handler.component.ShardRequest)"><!-- --></A><H3>
359modifyRequest</H3>
360<PRE>
361public void <B>modifyRequest</B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A>&nbsp;rb,
362                          <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A>&nbsp;who,
363                          <A HREF="../../../../../org/apache/solr/handler/component/ShardRequest.html" title="class in org.apache.solr.handler.component">ShardRequest</A>&nbsp;sreq)</PRE>
364<DL>
365<DD><B>Description copied from class: <CODE><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)">SearchComponent</A></CODE></B></DD>
366<DD>Called after another component adds a request
367<P>
368<DD><DL>
369<DT><B>Overrides:</B><DD><CODE><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></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>
370</DD>
371<DD><DL>
372</DL>
373</DD>
374</DL>
375<HR>
376
377<A NAME="handleResponses(org.apache.solr.handler.component.ResponseBuilder, org.apache.solr.handler.component.ShardRequest)"><!-- --></A><H3>
378handleResponses</H3>
379<PRE>
380public 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,
381                            <A HREF="../../../../../org/apache/solr/handler/component/ShardRequest.html" title="class in org.apache.solr.handler.component">ShardRequest</A>&nbsp;sreq)</PRE>
382<DL>
383<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>
384<DD>Called after all responses for a single request were received
385<P>
386<DD><DL>
387<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>
388</DD>
389<DD><DL>
390</DL>
391</DD>
392</DL>
393<HR>
394
395<A NAME="finishStage(org.apache.solr.handler.component.ResponseBuilder)"><!-- --></A><H3>
396finishStage</H3>
397<PRE>
398public 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>
399<DL>
400<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>
401<DD>Called after all responses have been received for this stage.
402 Useful when different requests are sent to each shard.
403<P>
404<DD><DL>
405<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>
406</DD>
407<DD><DL>
408</DL>
409</DD>
410</DL>
411<HR>
412
413<A NAME="getDescription()"><!-- --></A><H3>
414getDescription</H3>
415<PRE>
416public <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>
417<DL>
418<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getDescription()">SolrInfoMBean</A></CODE></B></DD>
419<DD>Simple one or two line description
420<P>
421<DD><DL>
422<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>
423</DD>
424<DD><DL>
425</DL>
426</DD>
427</DL>
428<HR>
429
430<A NAME="getSource()"><!-- --></A><H3>
431getSource</H3>
432<PRE>
433public <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>
434<DL>
435<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getSource()">SolrInfoMBean</A></CODE></B></DD>
436<DD>CVS Source, SVN Source, etc
437<P>
438<DD><DL>
439<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>
440</DD>
441<DD><DL>
442</DL>
443</DD>
444</DL>
445<HR>
446
447<A NAME="getDocs()"><!-- --></A><H3>
448getDocs</H3>
449<PRE>
450public <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>
451<DL>
452<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getDocs()">SolrInfoMBean</A></CODE></B></DD>
453<DD>Documentation URL list.
454
455 <p>
456 Suggested documentation URLs: Homepage for sponsoring project,
457 FAQ on class usage, Design doc for class, Wiki, bug reporting URL, etc...
458 </p>
459<P>
460<DD><DL>
461<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>
462</DD>
463<DD><DL>
464</DL>
465</DD>
466</DL>
467<!-- ========= END OF CLASS DATA ========= -->
468<HR>
469
470
471<!-- ======= START OF BOTTOM NAVBAR ====== -->
472<A NAME="navbar_bottom"><!-- --></A>
473<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
474<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
475<TR>
476<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
477<A NAME="navbar_bottom_firstrow"><!-- --></A>
478<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
479  <TR ALIGN="center" VALIGN="top">
480  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
481  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
482  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
483  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/DebugComponent.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
484  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
485  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
486  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
487  </TR>
488</TABLE>
489</TD>
490<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
491</EM>
492</TD>
493</TR>
494
495<TR>
496<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
497&nbsp;PREV CLASS&nbsp;
498&nbsp;<A HREF="../../../../../org/apache/solr/handler/component/FacetComponent.html" title="class in org.apache.solr.handler.component"><B>NEXT CLASS</B></A></FONT></TD>
499<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
500  <A HREF="../../../../../index.html?org/apache/solr/handler/component/DebugComponent.html" target="_top"><B>FRAMES</B></A>  &nbsp;
501&nbsp;<A HREF="DebugComponent.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
502&nbsp;<SCRIPT type="text/javascript">
503  <!--
504  if(window==top) {
505    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
506  }
507  //-->
508</SCRIPT>
509<NOSCRIPT>
510  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
511</NOSCRIPT>
512
513
514</FONT></TD>
515</TR>
516<TR>
517<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
518  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>
519<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
520DETAIL:&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>
521</TR>
522</TABLE>
523<A NAME="skip-navbar_bottom"></A>
524<!-- ======== END OF BOTTOM NAVBAR ======= -->
525
526<HR>
527
528          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
529          <script src='../../../../../prettify.js' type='text/javascript'></script>
530          <script type='text/javascript'>
531            (function(){
532              var oldonload = window.onload;
533              if (typeof oldonload != 'function') {
534                window.onload = prettyPrint;
535              } else {
536                window.onload = function() {
537                  oldonload();
538                  prettyPrint();
539                }
540              }
541            })();
542          </script>
543       
544</BODY>
545</HTML>
Note: See TracBrowser for help on using the repository browser.