Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Annotate
Revision Log

SearchComponent.html @ 7588

Revision 7588, 35.2 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>
8	SearchComponent (Solr 4.0.0-ALPHA API)
9	</TITLE>
10
11	<META NAME="date" CONTENT="2012-06-25">
12
13	<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
14
15	<SCRIPT type="text/javascript">
16	function windowTitle()
17	{
18	if (location.href.indexOf('is-external=true') == -1) {
19	parent.document.title="SearchComponent (Solr 4.0.0-ALPHA API)";
20	}
21	}
22	</SCRIPT>
23	<NOSCRIPT>
24	</NOSCRIPT>
25
26	</HEAD>
27
28	<BODY BGCOLOR="white" onload="windowTitle();">
29	<HR>
30
31
32	<!-- ========= START OF TOP NAVBAR ======= -->
33	<A NAME="navbar_top"><!-- --></A>
34	<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
35	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
36	<TR>
37	<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
38	<A NAME="navbar_top_firstrow"><!-- --></A>
39	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
40	<TR ALIGN="center" VALIGN="top">
41	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
42	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
43	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
44	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SearchComponent.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
45	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
46	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
47	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
48	</TR>
49	</TABLE>
50	</TD>
51	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
52	</EM>
53	</TD>
54	</TR>
55
56	<TR>
57	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
58	<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.GlobalCollectionStat.html" title="class in org.apache.solr.handler.component"><B>PREV CLASS</B></A>
59	<A HREF="../../../../../org/apache/solr/handler/component/SearchHandler.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/SearchComponent.html" target="_top"><B>FRAMES</B></A>
62	<A HREF="SearchComponent.html" target="_top"><B>NO FRAMES</B></A>
63	<SCRIPT type="text/javascript">
64	<!--
65	if(window==top) {
66	document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
67	}
68	//-->
69	</SCRIPT>
70	<NOSCRIPT>
71	<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
72	</NOSCRIPT>
73
74
75	</FONT></TD>
76	</TR>
77	<TR>
78	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
79	SUMMARY: NESTED \| FIELD \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
80	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81	DETAIL: FIELD \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
82	</TR>
83	</TABLE>
84	<A NAME="skip-navbar_top"></A>
85	<!-- ========= END OF TOP NAVBAR ========= -->
86
87	<HR>
88	<!-- ======== START OF CLASS DATA ======== -->
89	<H2>
90	<FONT SIZE="-1">
91	org.apache.solr.handler.component</FONT>
92	<BR>
93	Class SearchComponent</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.handler.component.SearchComponent</B>
97	</PRE>
98	<DL>
99	<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>
100	</DL>
101	<DL>
102	<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/apache/solr/handler/clustering/ClusteringComponent.html" title="class in org.apache.solr.handler.clustering">ClusteringComponent</A>, <A HREF="../../../../../org/apache/solr/handler/component/DebugComponent.html" title="class in org.apache.solr.handler.component">DebugComponent</A>, <A HREF="../../../../../org/apache/solr/handler/component/FacetComponent.html" title="class in org.apache.solr.handler.component">FacetComponent</A>, <A HREF="../../../../../org/apache/solr/handler/component/HighlightComponent.html" title="class in org.apache.solr.handler.component">HighlightComponent</A>, <A HREF="../../../../../org/apache/solr/handler/component/MoreLikeThisComponent.html" title="class in org.apache.solr.handler.component">MoreLikeThisComponent</A>, <A HREF="../../../../../org/apache/solr/handler/component/QueryComponent.html" title="class in org.apache.solr.handler.component">QueryComponent</A>, <A HREF="../../../../../org/apache/solr/handler/component/QueryElevationComponent.html" title="class in org.apache.solr.handler.component">QueryElevationComponent</A>, <A HREF="../../../../../org/apache/solr/handler/component/RealTimeGetComponent.html" title="class in org.apache.solr.handler.component">RealTimeGetComponent</A>, <A HREF="../../../../../org/apache/solr/handler/component/SpellCheckComponent.html" title="class in org.apache.solr.handler.component">SpellCheckComponent</A>, <A HREF="../../../../../org/apache/solr/handler/component/StatsComponent.html" title="class in org.apache.solr.handler.component">StatsComponent</A>, <A HREF="../../../../../org/apache/solr/handler/component/TermsComponent.html" title="class in org.apache.solr.handler.component">TermsComponent</A>, <A HREF="../../../../../org/apache/solr/handler/component/TermVectorComponent.html" title="class in org.apache.solr.handler.component">TermVectorComponent</A></DD>
103	</DL>
104	<HR>
105	<DL>
106	<DT><PRE>public abstract class <B>SearchComponent</B><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="../../../../../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></DL>
107	</PRE>
108
109	<P>
110	TODO!
111	<P>
112
113	<P>
114	<DL>
115	<DT><B>Since:</B></DT>
116	<DD>solr 1.3</DD>
117	</DL>
118	<HR>
119
120	<P>
121	<!-- ======== NESTED CLASS SUMMARY ======== -->
122
123	<A NAME="nested_class_summary"><!-- --></A>
124	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
125	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
126	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
127	<B>Nested Class Summary</B></FONT></TH>
128	</TR>
129	</TABLE>
130	<A NAME="nested_classes_inherited_from_class_org.apache.solr.core.SolrInfoMBean"><!-- --></A>
131	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
132	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
133	<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>
134	</TR>
135	<TR BGCOLOR="white" CLASS="TableRowColor">
136	<TD><CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.Category.html" title="enum in org.apache.solr.core">SolrInfoMBean.Category</A></CODE></TD>
137	</TR>
138	</TABLE>
139
140
141	<!-- ======== CONSTRUCTOR SUMMARY ======== -->
142
143	<A NAME="constructor_summary"><!-- --></A>
144	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
145	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
146	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
147	<B>Constructor Summary</B></FONT></TH>
148	</TR>
149	<TR BGCOLOR="white" CLASS="TableRowColor">
150	<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#SearchComponent()">SearchComponent</A></B>()</CODE>
151
152	<BR>
153	</TD>
154	</TR>
155	</TABLE>
156
157	<!-- ========== METHOD SUMMARY =========== -->
158
159	<A NAME="method_summary"><!-- --></A>
160	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
161	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
162	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
163	<B>Method Summary</B></FONT></TH>
164	</TR>
165	<TR BGCOLOR="white" CLASS="TableRowColor">
166	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
167	<CODE> int</CODE></FONT></TD>
168	<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.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> rb)</CODE>
169
170	<BR>
171	Process for a distributed search.</TD>
172	</TR>
173	<TR BGCOLOR="white" CLASS="TableRowColor">
174	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
175	<CODE> void</CODE></FONT></TD>
176	<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.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> rb)</CODE>
177
178	<BR>
179	Called after all responses have been received for this stage.</TD>
180	</TR>
181	<TR BGCOLOR="white" CLASS="TableRowColor">
182	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
183	<CODE> <A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.Category.html" title="enum in org.apache.solr.core">SolrInfoMBean.Category</A></CODE></FONT></TD>
184	<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getCategory()">getCategory</A></B>()</CODE>
185
186	<BR>
187	Purpose of this Class</TD>
188	</TR>
189	<TR BGCOLOR="white" CLASS="TableRowColor">
190	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
191	<CODE>abstract  <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>
192	<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getDescription()">getDescription</A></B>()</CODE>
193
194	<BR>
195	Simple one or two line description</TD>
196	</TR>
197	<TR BGCOLOR="white" CLASS="TableRowColor">
198	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
199	<CODE> <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>
200	<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getDocs()">getDocs</A></B>()</CODE>
201
202	<BR>
203	Documentation URL list.</TD>
204	</TR>
205	<TR BGCOLOR="white" CLASS="TableRowColor">
206	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
207	<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
208	<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getName()">getName</A></B>()</CODE>
209
210	<BR>
211	Simple common usage name, e.g.</TD>
212	</TR>
213	<TR BGCOLOR="white" CLASS="TableRowColor">
214	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
215	<CODE>abstract  <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/SearchComponent.html#getSource()">getSource</A></B>()</CODE>
217
218	<BR>
219	CVS Source, SVN Source, etc</TD>
220	</TR>
221	<TR BGCOLOR="white" CLASS="TableRowColor">
222	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
223	<CODE> <A HREF="../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A></CODE></FONT></TD>
224	<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getStatistics()">getStatistics</A></B>()</CODE>
225
226	<BR>
227	Any statistics this instance would like to be publicly available via
228	the Solr Administration interface.</TD>
229	</TR>
230	<TR BGCOLOR="white" CLASS="TableRowColor">
231	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
232	<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
233	<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getVersion()">getVersion</A></B>()</CODE>
234
235	<BR>
236	Simple common usage version, e.g.</TD>
237	</TR>
238	<TR BGCOLOR="white" CLASS="TableRowColor">
239	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
240	<CODE> void</CODE></FONT></TD>
241	<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.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> rb,
242	<A HREF="../../../../../org/apache/solr/handler/component/ShardRequest.html" title="class in org.apache.solr.handler.component">ShardRequest</A> sreq)</CODE>
243
244	<BR>
245	Called after all responses for a single request were received</TD>
246	</TR>
247	<TR BGCOLOR="white" CLASS="TableRowColor">
248	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
249	<CODE> void</CODE></FONT></TD>
250	<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#init(org.apache.solr.common.util.NamedList)">init</A></B>(<A HREF="../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A> args)</CODE>
251
252	<BR>
253	</TD>
254	</TR>
255	<TR BGCOLOR="white" CLASS="TableRowColor">
256	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
257	<CODE> void</CODE></FONT></TD>
258	<TD><CODE><B><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></B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A> rb,
259	<A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A> who,
260	<A HREF="../../../../../org/apache/solr/handler/component/ShardRequest.html" title="class in org.apache.solr.handler.component">ShardRequest</A> sreq)</CODE>
261
262	<BR>
263	Called after another component adds a request</TD>
264	</TR>
265	<TR BGCOLOR="white" CLASS="TableRowColor">
266	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
267	<CODE>abstract  void</CODE></FONT></TD>
268	<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.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> rb)</CODE>
269
270	<BR>
271	Prepare the response.</TD>
272	</TR>
273	<TR BGCOLOR="white" CLASS="TableRowColor">
274	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
275	<CODE>abstract  void</CODE></FONT></TD>
276	<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.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> rb)</CODE>
277
278	<BR>
279	Process the request for this component</TD>
280	</TR>
281	</TABLE>
282	<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
283	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
284	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
285	<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>
286	</TR>
287	<TR BGCOLOR="white" CLASS="TableRowColor">
288	<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>
289	</TR>
290	</TABLE>
291
292	<P>
293
294	<!-- ========= CONSTRUCTOR DETAIL ======== -->
295
296	<A NAME="constructor_detail"><!-- --></A>
297	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
298	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
299	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
300	<B>Constructor Detail</B></FONT></TH>
301	</TR>
302	</TABLE>
303
304	<A NAME="SearchComponent()"><!-- --></A><H3>
305	SearchComponent</H3>
306	<PRE>
307	public <B>SearchComponent</B>()</PRE>
308	<DL>
309	</DL>
310
311	<!-- ============ METHOD DETAIL ========== -->
312
313	<A NAME="method_detail"><!-- --></A>
314	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
315	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
316	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
317	<B>Method Detail</B></FONT></TH>
318	</TR>
319	</TABLE>
320
321	<A NAME="prepare(org.apache.solr.handler.component.ResponseBuilder)"><!-- --></A><H3>
322	prepare</H3>
323	<PRE>
324	public abstract void <B>prepare</B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A> rb)
325	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>
326	<DL>
327	<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>process(org.apache.solr.handler.component.ResponseBuilder)</CODE></A> method.
328	Called for every incoming request.
329
330	The place to do initialization that is request dependent.
331	<P>
332	<DD><DL>
333	</DL>
334	</DD>
335	<DD><DL>
336	<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>
337	<DT><B>Throws:</B>
338	<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>
339	</DD>
340	</DL>
341	<HR>
342
343	<A NAME="process(org.apache.solr.handler.component.ResponseBuilder)"><!-- --></A><H3>
344	process</H3>
345	<PRE>
346	public abstract void <B>process</B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A> rb)
347	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>
348	<DL>
349	<DD>Process the request for this component
350	<P>
351	<DD><DL>
352	</DL>
353	</DD>
354	<DD><DL>
355	<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>
356	<DT><B>Throws:</B>
357	<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>
358	</DD>
359	</DL>
360	<HR>
361
362	<A NAME="distributedProcess(org.apache.solr.handler.component.ResponseBuilder)"><!-- --></A><H3>
363	distributedProcess</H3>
364	<PRE>
365	public int <B>distributedProcess</B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A> rb)
366	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>
367	<DL>
368	<DD>Process for a distributed search.
369	<P>
370	<DD><DL>
371	</DL>
372	</DD>
373	<DD><DL>
374
375	<DT><B>Returns:</B><DD>the next stage for this component
376	<DT><B>Throws:</B>
377	<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>
378	</DD>
379	</DL>
380	<HR>
381
382	<A NAME="modifyRequest(org.apache.solr.handler.component.ResponseBuilder, org.apache.solr.handler.component.SearchComponent, org.apache.solr.handler.component.ShardRequest)"><!-- --></A><H3>
383	modifyRequest</H3>
384	<PRE>
385	public void <B>modifyRequest</B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A> rb,
386	<A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A> who,
387	<A HREF="../../../../../org/apache/solr/handler/component/ShardRequest.html" title="class in org.apache.solr.handler.component">ShardRequest</A> sreq)</PRE>
388	<DL>
389	<DD>Called after another component adds a request
390	<P>
391	<DD><DL>
392	</DL>
393	</DD>
394	<DD><DL>
395	</DL>
396	</DD>
397	</DL>
398	<HR>
399
400	<A NAME="handleResponses(org.apache.solr.handler.component.ResponseBuilder, org.apache.solr.handler.component.ShardRequest)"><!-- --></A><H3>
401	handleResponses</H3>
402	<PRE>
403	public void <B>handleResponses</B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A> rb,
404	<A HREF="../../../../../org/apache/solr/handler/component/ShardRequest.html" title="class in org.apache.solr.handler.component">ShardRequest</A> sreq)</PRE>
405	<DL>
406	<DD>Called after all responses for a single request were received
407	<P>
408	<DD><DL>
409	</DL>
410	</DD>
411	<DD><DL>
412	</DL>
413	</DD>
414	</DL>
415	<HR>
416
417	<A NAME="finishStage(org.apache.solr.handler.component.ResponseBuilder)"><!-- --></A><H3>
418	finishStage</H3>
419	<PRE>
420	public void <B>finishStage</B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A> rb)</PRE>
421	<DL>
422	<DD>Called after all responses have been received for this stage.
423	Useful when different requests are sent to each shard.
424	<P>
425	<DD><DL>
426	</DL>
427	</DD>
428	<DD><DL>
429	</DL>
430	</DD>
431	</DL>
432	<HR>
433
434	<A NAME="init(org.apache.solr.common.util.NamedList)"><!-- --></A><H3>
435	init</H3>
436	<PRE>
437	public void <B>init</B>(<A HREF="../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A> args)</PRE>
438	<DL>
439	<DD><DL>
440	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/util/plugin/NamedListInitializedPlugin.html#init(org.apache.solr.common.util.NamedList)">init</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/solr/util/plugin/NamedListInitializedPlugin.html" title="interface in org.apache.solr.util.plugin">NamedListInitializedPlugin</A></CODE></DL>
441	</DD>
442	<DD><DL>
443	</DL>
444	</DD>
445	</DL>
446	<HR>
447
448	<A NAME="getName()"><!-- --></A><H3>
449	getName</H3>
450	<PRE>
451	public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getName</B>()</PRE>
452	<DL>
453	<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getName()">SolrInfoMBean</A></CODE></B></DD>
454	<DD>Simple common usage name, e.g. BasicQueryHandler,
455	or fully qualified clas name.
456	<P>
457	<DD><DL>
458	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getName()">getName</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></CODE></DL>
459	</DD>
460	<DD><DL>
461	</DL>
462	</DD>
463	</DL>
464	<HR>
465
466	<A NAME="getDescription()"><!-- --></A><H3>
467	getDescription</H3>
468	<PRE>
469	public abstract <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>
470	<DL>
471	<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getDescription()">SolrInfoMBean</A></CODE></B></DD>
472	<DD>Simple one or two line description
473	<P>
474	<DD><DL>
475	<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></DL>
476	</DD>
477	<DD><DL>
478	</DL>
479	</DD>
480	</DL>
481	<HR>
482
483	<A NAME="getSource()"><!-- --></A><H3>
484	getSource</H3>
485	<PRE>
486	public abstract <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>
487	<DL>
488	<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getSource()">SolrInfoMBean</A></CODE></B></DD>
489	<DD>CVS Source, SVN Source, etc
490	<P>
491	<DD><DL>
492	<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></DL>
493	</DD>
494	<DD><DL>
495	</DL>
496	</DD>
497	</DL>
498	<HR>
499
500	<A NAME="getVersion()"><!-- --></A><H3>
501	getVersion</H3>
502	<PRE>
503	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>getVersion</B>()</PRE>
504	<DL>
505	<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getVersion()">SolrInfoMBean</A></CODE></B></DD>
506	<DD>Simple common usage version, e.g. 2.0
507	<P>
508	<DD><DL>
509	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getVersion()">getVersion</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></CODE></DL>
510	</DD>
511	<DD><DL>
512	</DL>
513	</DD>
514	</DL>
515	<HR>
516
517	<A NAME="getCategory()"><!-- --></A><H3>
518	getCategory</H3>
519	<PRE>
520	public <A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.Category.html" title="enum in org.apache.solr.core">SolrInfoMBean.Category</A> <B>getCategory</B>()</PRE>
521	<DL>
522	<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getCategory()">SolrInfoMBean</A></CODE></B></DD>
523	<DD>Purpose of this Class
524	<P>
525	<DD><DL>
526	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getCategory()">getCategory</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></CODE></DL>
527	</DD>
528	<DD><DL>
529	</DL>
530	</DD>
531	</DL>
532	<HR>
533
534	<A NAME="getDocs()"><!-- --></A><H3>
535	getDocs</H3>
536	<PRE>
537	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>
538	<DL>
539	<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getDocs()">SolrInfoMBean</A></CODE></B></DD>
540	<DD>Documentation URL list.
541
542	<p>
543	Suggested documentation URLs: Homepage for sponsoring project,
544	FAQ on class usage, Design doc for class, Wiki, bug reporting URL, etc...
545	</p>
546	<P>
547	<DD><DL>
548	<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></DL>
549	</DD>
550	<DD><DL>
551	</DL>
552	</DD>
553	</DL>
554	<HR>
555
556	<A NAME="getStatistics()"><!-- --></A><H3>
557	getStatistics</H3>
558	<PRE>
559	public <A HREF="../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A> <B>getStatistics</B>()</PRE>
560	<DL>
561	<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getStatistics()">SolrInfoMBean</A></CODE></B></DD>
562	<DD>Any statistics this instance would like to be publicly available via
563	the Solr Administration interface.
564
565	<p>
566	Any Object type may be stored in the list, but only the
567	<code>toString()</code> representation will be used.
568	</p>
569	<P>
570	<DD><DL>
571	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getStatistics()">getStatistics</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></CODE></DL>
572	</DD>
573	<DD><DL>
574	</DL>
575	</DD>
576	</DL>
577	<!-- ========= END OF CLASS DATA ========= -->
578	<HR>
579
580
581	<!-- ======= START OF BOTTOM NAVBAR ====== -->
582	<A NAME="navbar_bottom"><!-- --></A>
583	<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
584	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
585	<TR>
586	<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
587	<A NAME="navbar_bottom_firstrow"><!-- --></A>
588	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
589	<TR ALIGN="center" VALIGN="top">
590	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
591	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
592	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
593	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SearchComponent.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
594	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
595	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
596	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
597	</TR>
598	</TABLE>
599	</TD>
600	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
601	</EM>
602	</TD>
603	</TR>
604
605	<TR>
606	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
607	<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.GlobalCollectionStat.html" title="class in org.apache.solr.handler.component"><B>PREV CLASS</B></A>
608	<A HREF="../../../../../org/apache/solr/handler/component/SearchHandler.html" title="class in org.apache.solr.handler.component"><B>NEXT CLASS</B></A></FONT></TD>
609	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
610	<A HREF="../../../../../index.html?org/apache/solr/handler/component/SearchComponent.html" target="_top"><B>FRAMES</B></A>
611	<A HREF="SearchComponent.html" target="_top"><B>NO FRAMES</B></A>
612	<SCRIPT type="text/javascript">
613	<!--
614	if(window==top) {
615	document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
616	}
617	//-->
618	</SCRIPT>
619	<NOSCRIPT>
620	<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
621	</NOSCRIPT>
622
623
624	</FONT></TD>
625	</TR>
626	<TR>
627	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
628	SUMMARY: NESTED \| FIELD \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
629	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
630	DETAIL: FIELD \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
631	</TR>
632	</TABLE>
633	<A NAME="skip-navbar_bottom"></A>
634	<!-- ======== END OF BOTTOM NAVBAR ======= -->
635
636	<HR>
637
638	<address>Copyright © 2000-2012 Apache Software Foundation. All Rights Reserved.</address>
639	<script src='../../../../../prettify.js' type='text/javascript'></script>
640	<script type='text/javascript'>
641	(function(){
642	var oldonload = window.onload;
643	if (typeof oldonload != 'function') {
644	window.onload = prettyPrint;
645	} else {
646	window.onload = function() {
647	oldonload();
648	prettyPrint();
649	}
650	}
651	})();
652	</script>
653
654	</BODY>
655	</HTML>

Note: See TracBrowser for help on using the repository browser.

Context Navigation

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

Download in other formats: