Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Annotate
Revision Log

FacetComponent.html @ 7588

Revision 7588, 38.3 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	FacetComponent (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="FacetComponent (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/FacetComponent.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/DebugComponent.html" title="class in org.apache.solr.handler.component"><B>PREV CLASS</B></A>
59	<A HREF="../../../../../org/apache/solr/handler/component/FacetComponent.DistribFieldFacet.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/FacetComponent.html" target="_top"><B>FRAMES</B></A>
62	<A HREF="FacetComponent.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: <A HREF="#nested_class_summary">NESTED</A> \| <A HREF="#field_summary">FIELD</A> \| <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: <A HREF="#field_detail">FIELD</A> \| <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 FacetComponent</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.FacetComponent</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>FacetComponent</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	<TR BGCOLOR="white" CLASS="TableRowColor">
128	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
129	<CODE>static class</CODE></FONT></TD>
130	<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/FacetComponent.DistribFieldFacet.html" title="class in org.apache.solr.handler.component">FacetComponent.DistribFieldFacet</A></B></CODE>
131
132	<BR>
133	<b>This API is experimental and subject to change</b></TD>
134	</TR>
135	<TR BGCOLOR="white" CLASS="TableRowColor">
136	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
137	<CODE>static class</CODE></FONT></TD>
138	<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/FacetComponent.FacetBase.html" title="class in org.apache.solr.handler.component">FacetComponent.FacetBase</A></B></CODE>
139
140	<BR>
141	<b>This API is experimental and subject to change</b></TD>
142	</TR>
143	<TR BGCOLOR="white" CLASS="TableRowColor">
144	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
145	<CODE>static class</CODE></FONT></TD>
146	<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/FacetComponent.FacetInfo.html" title="class in org.apache.solr.handler.component">FacetComponent.FacetInfo</A></B></CODE>
147
148	<BR>
149	<b>This API is experimental and subject to change</b></TD>
150	</TR>
151	<TR BGCOLOR="white" CLASS="TableRowColor">
152	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
153	<CODE>static class</CODE></FONT></TD>
154	<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/FacetComponent.FieldFacet.html" title="class in org.apache.solr.handler.component">FacetComponent.FieldFacet</A></B></CODE>
155
156	<BR>
157	<b>This API is experimental and subject to change</b></TD>
158	</TR>
159	<TR BGCOLOR="white" CLASS="TableRowColor">
160	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
161	<CODE>static class</CODE></FONT></TD>
162	<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/FacetComponent.QueryFacet.html" title="class in org.apache.solr.handler.component">FacetComponent.QueryFacet</A></B></CODE>
163
164	<BR>
165	<b>This API is experimental and subject to change</b></TD>
166	</TR>
167	<TR BGCOLOR="white" CLASS="TableRowColor">
168	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
169	<CODE>static class</CODE></FONT></TD>
170	<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/FacetComponent.ShardFacetCount.html" title="class in org.apache.solr.handler.component">FacetComponent.ShardFacetCount</A></B></CODE>
171
172	<BR>
173	<b>This API is experimental and subject to change</b></TD>
174	</TR>
175	</TABLE>
176	<A NAME="nested_classes_inherited_from_class_org.apache.solr.core.SolrInfoMBean"><!-- --></A>
177	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
178	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
179	<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>
180	</TR>
181	<TR BGCOLOR="white" CLASS="TableRowColor">
182	<TD><CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.Category.html" title="enum in org.apache.solr.core">SolrInfoMBean.Category</A></CODE></TD>
183	</TR>
184	</TABLE>
185
186	<!-- =========== FIELD SUMMARY =========== -->
187
188	<A NAME="field_summary"><!-- --></A>
189	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
190	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
191	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
192	<B>Field Summary</B></FONT></TH>
193	</TR>
194	<TR BGCOLOR="white" CLASS="TableRowColor">
195	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
196	<CODE>static <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
197	<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/FacetComponent.html#COMPONENT_NAME">COMPONENT_NAME</A></B></CODE>
198
199	<BR>
200	</TD>
201	</TR>
202	<TR BGCOLOR="white" CLASS="TableRowColor">
203	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
204	<CODE>static org.slf4j.Logger</CODE></FONT></TD>
205	<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/FacetComponent.html#log">log</A></B></CODE>
206
207	<BR>
208	</TD>
209	</TR>
210	</TABLE>
211
212	<!-- ======== CONSTRUCTOR SUMMARY ======== -->
213
214	<A NAME="constructor_summary"><!-- --></A>
215	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
216	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
217	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
218	<B>Constructor Summary</B></FONT></TH>
219	</TR>
220	<TR BGCOLOR="white" CLASS="TableRowColor">
221	<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/FacetComponent.html#FacetComponent()">FacetComponent</A></B>()</CODE>
222
223	<BR>
224	</TD>
225	</TR>
226	</TABLE>
227
228	<!-- ========== METHOD SUMMARY =========== -->
229
230	<A NAME="method_summary"><!-- --></A>
231	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
232	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
233	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
234	<B>Method Summary</B></FONT></TH>
235	</TR>
236	<TR BGCOLOR="white" CLASS="TableRowColor">
237	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
238	<CODE> int</CODE></FONT></TD>
239	<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/FacetComponent.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>
240
241	<BR>
242	Process for a distributed search.</TD>
243	</TR>
244	<TR BGCOLOR="white" CLASS="TableRowColor">
245	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
246	<CODE> void</CODE></FONT></TD>
247	<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/FacetComponent.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>
248
249	<BR>
250	Called after all responses have been received for this stage.</TD>
251	</TR>
252	<TR BGCOLOR="white" CLASS="TableRowColor">
253	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
254	<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>
255	<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/FacetComponent.html#getDescription()">getDescription</A></B>()</CODE>
256
257	<BR>
258	Simple one or two line description</TD>
259	</TR>
260	<TR BGCOLOR="white" CLASS="TableRowColor">
261	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
262	<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>
263	<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/FacetComponent.html#getDocs()">getDocs</A></B>()</CODE>
264
265	<BR>
266	Documentation URL list.</TD>
267	</TR>
268	<TR BGCOLOR="white" CLASS="TableRowColor">
269	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
270	<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>
271	<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/FacetComponent.html#getSource()">getSource</A></B>()</CODE>
272
273	<BR>
274	CVS Source, SVN Source, etc</TD>
275	</TR>
276	<TR BGCOLOR="white" CLASS="TableRowColor">
277	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
278	<CODE> void</CODE></FONT></TD>
279	<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/FacetComponent.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,
280	<A HREF="../../../../../org/apache/solr/handler/component/ShardRequest.html" title="class in org.apache.solr.handler.component">ShardRequest</A> sreq)</CODE>
281
282	<BR>
283	Called after all responses for a single request were received</TD>
284	</TR>
285	<TR BGCOLOR="white" CLASS="TableRowColor">
286	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
287	<CODE> void</CODE></FONT></TD>
288	<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/FacetComponent.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>
289
290	<BR>
291	</TD>
292	</TR>
293	<TR BGCOLOR="white" CLASS="TableRowColor">
294	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
295	<CODE> void</CODE></FONT></TD>
296	<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/FacetComponent.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,
297	<A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A> who,
298	<A HREF="../../../../../org/apache/solr/handler/component/ShardRequest.html" title="class in org.apache.solr.handler.component">ShardRequest</A> sreq)</CODE>
299
300	<BR>
301	Called after another component adds a request</TD>
302	</TR>
303	<TR BGCOLOR="white" CLASS="TableRowColor">
304	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
305	<CODE> void</CODE></FONT></TD>
306	<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/FacetComponent.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>
307
308	<BR>
309	Prepare the response.</TD>
310	</TR>
311	<TR BGCOLOR="white" CLASS="TableRowColor">
312	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
313	<CODE> void</CODE></FONT></TD>
314	<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/FacetComponent.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>
315
316	<BR>
317	Actually run the query</TD>
318	</TR>
319	</TABLE>
320	<A NAME="methods_inherited_from_class_org.apache.solr.handler.component.SearchComponent"><!-- --></A>
321	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
322	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
323	<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>
324	</TR>
325	<TR BGCOLOR="white" CLASS="TableRowColor">
326	<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></CODE></TD>
327	</TR>
328	</TABLE>
329	<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
330	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
331	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
332	<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>
333	</TR>
334	<TR BGCOLOR="white" CLASS="TableRowColor">
335	<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>
336	</TR>
337	</TABLE>
338
339	<P>
340
341	<!-- ============ FIELD DETAIL =========== -->
342
343	<A NAME="field_detail"><!-- --></A>
344	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
345	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
346	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
347	<B>Field Detail</B></FONT></TH>
348	</TR>
349	</TABLE>
350
351	<A NAME="log"><!-- --></A><H3>
352	log</H3>
353	<PRE>
354	public static org.slf4j.Logger <B>log</B></PRE>
355	<DL>
356	<DL>
357	</DL>
358	</DL>
359	<HR>
360
361	<A NAME="COMPONENT_NAME"><!-- --></A><H3>
362	COMPONENT_NAME</H3>
363	<PRE>
364	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>
365	<DL>
366	<DL>
367	<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.handler.component.FacetComponent.COMPONENT_NAME">Constant Field Values</A></DL>
368	</DL>
369
370	<!-- ========= CONSTRUCTOR DETAIL ======== -->
371
372	<A NAME="constructor_detail"><!-- --></A>
373	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
374	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
375	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
376	<B>Constructor Detail</B></FONT></TH>
377	</TR>
378	</TABLE>
379
380	<A NAME="FacetComponent()"><!-- --></A><H3>
381	FacetComponent</H3>
382	<PRE>
383	public <B>FacetComponent</B>()</PRE>
384	<DL>
385	</DL>
386
387	<!-- ============ METHOD DETAIL ========== -->
388
389	<A NAME="method_detail"><!-- --></A>
390	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
391	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
392	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
393	<B>Method Detail</B></FONT></TH>
394	</TR>
395	</TABLE>
396
397	<A NAME="init(org.apache.solr.common.util.NamedList)"><!-- --></A><H3>
398	init</H3>
399	<PRE>
400	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>
401	<DL>
402	<DD><DL>
403	<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><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#init(org.apache.solr.common.util.NamedList)">init</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>
404	</DD>
405	<DD><DL>
406	</DL>
407	</DD>
408	</DL>
409	<HR>
410
411	<A NAME="prepare(org.apache.solr.handler.component.ResponseBuilder)"><!-- --></A><H3>
412	prepare</H3>
413	<PRE>
414	public void <B>prepare</B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A> rb)
415	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>
416	<DL>
417	<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>
418	<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.
419	Called for every incoming request.
420
421	The place to do initialization that is request dependent.
422	<P>
423	<DD><DL>
424	<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>
425	</DD>
426	<DD><DL>
427	<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>
428	<DT><B>Throws:</B>
429	<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>
430	</DD>
431	</DL>
432	<HR>
433
434	<A NAME="process(org.apache.solr.handler.component.ResponseBuilder)"><!-- --></A><H3>
435	process</H3>
436	<PRE>
437	public void <B>process</B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A> rb)
438	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>
439	<DL>
440	<DD>Actually run the query
441	<P>
442	<DD><DL>
443	<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>
444	</DD>
445	<DD><DL>
446	<DT><B>Parameters:</B><DD><CODE>rb</CODE> -
447	<DT><B>Throws:</B>
448	<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>
449	</DD>
450	</DL>
451	<HR>
452
453	<A NAME="distributedProcess(org.apache.solr.handler.component.ResponseBuilder)"><!-- --></A><H3>
454	distributedProcess</H3>
455	<PRE>
456	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)
457	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>
458	<DL>
459	<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>
460	<DD>Process for a distributed search.
461	<P>
462	<DD><DL>
463	<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>
464	</DD>
465	<DD><DL>
466
467	<DT><B>Returns:</B><DD>the next stage for this component
468	<DT><B>Throws:</B>
469	<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>
470	</DD>
471	</DL>
472	<HR>
473
474	<A NAME="modifyRequest(org.apache.solr.handler.component.ResponseBuilder, org.apache.solr.handler.component.SearchComponent, org.apache.solr.handler.component.ShardRequest)"><!-- --></A><H3>
475	modifyRequest</H3>
476	<PRE>
477	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,
478	<A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A> who,
479	<A HREF="../../../../../org/apache/solr/handler/component/ShardRequest.html" title="class in org.apache.solr.handler.component">ShardRequest</A> sreq)</PRE>
480	<DL>
481	<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>
482	<DD>Called after another component adds a request
483	<P>
484	<DD><DL>
485	<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>
486	</DD>
487	<DD><DL>
488	</DL>
489	</DD>
490	</DL>
491	<HR>
492
493	<A NAME="handleResponses(org.apache.solr.handler.component.ResponseBuilder, org.apache.solr.handler.component.ShardRequest)"><!-- --></A><H3>
494	handleResponses</H3>
495	<PRE>
496	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,
497	<A HREF="../../../../../org/apache/solr/handler/component/ShardRequest.html" title="class in org.apache.solr.handler.component">ShardRequest</A> sreq)</PRE>
498	<DL>
499	<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>
500	<DD>Called after all responses for a single request were received
501	<P>
502	<DD><DL>
503	<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>
504	</DD>
505	<DD><DL>
506	</DL>
507	</DD>
508	</DL>
509	<HR>
510
511	<A NAME="finishStage(org.apache.solr.handler.component.ResponseBuilder)"><!-- --></A><H3>
512	finishStage</H3>
513	<PRE>
514	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>
515	<DL>
516	<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>
517	<DD>Called after all responses have been received for this stage.
518	Useful when different requests are sent to each shard.
519	<P>
520	<DD><DL>
521	<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>
522	</DD>
523	<DD><DL>
524	</DL>
525	</DD>
526	</DL>
527	<HR>
528
529	<A NAME="getDescription()"><!-- --></A><H3>
530	getDescription</H3>
531	<PRE>
532	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>
533	<DL>
534	<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getDescription()">SolrInfoMBean</A></CODE></B></DD>
535	<DD>Simple one or two line description
536	<P>
537	<DD><DL>
538	<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>
539	</DD>
540	<DD><DL>
541	</DL>
542	</DD>
543	</DL>
544	<HR>
545
546	<A NAME="getSource()"><!-- --></A><H3>
547	getSource</H3>
548	<PRE>
549	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>
550	<DL>
551	<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getSource()">SolrInfoMBean</A></CODE></B></DD>
552	<DD>CVS Source, SVN Source, etc
553	<P>
554	<DD><DL>
555	<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>
556	</DD>
557	<DD><DL>
558	</DL>
559	</DD>
560	</DL>
561	<HR>
562
563	<A NAME="getDocs()"><!-- --></A><H3>
564	getDocs</H3>
565	<PRE>
566	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>
567	<DL>
568	<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getDocs()">SolrInfoMBean</A></CODE></B></DD>
569	<DD>Documentation URL list.
570
571	<p>
572	Suggested documentation URLs: Homepage for sponsoring project,
573	FAQ on class usage, Design doc for class, Wiki, bug reporting URL, etc...
574	</p>
575	<P>
576	<DD><DL>
577	<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>
578	</DD>
579	<DD><DL>
580	</DL>
581	</DD>
582	</DL>
583	<!-- ========= END OF CLASS DATA ========= -->
584	<HR>
585
586
587	<!-- ======= START OF BOTTOM NAVBAR ====== -->
588	<A NAME="navbar_bottom"><!-- --></A>
589	<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
590	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
591	<TR>
592	<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
593	<A NAME="navbar_bottom_firstrow"><!-- --></A>
594	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
595	<TR ALIGN="center" VALIGN="top">
596	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
597	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
598	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
599	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/FacetComponent.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
600	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
601	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
602	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
603	</TR>
604	</TABLE>
605	</TD>
606	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
607	</EM>
608	</TD>
609	</TR>
610
611	<TR>
612	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
613	<A HREF="../../../../../org/apache/solr/handler/component/DebugComponent.html" title="class in org.apache.solr.handler.component"><B>PREV CLASS</B></A>
614	<A HREF="../../../../../org/apache/solr/handler/component/FacetComponent.DistribFieldFacet.html" title="class in org.apache.solr.handler.component"><B>NEXT CLASS</B></A></FONT></TD>
615	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
616	<A HREF="../../../../../index.html?org/apache/solr/handler/component/FacetComponent.html" target="_top"><B>FRAMES</B></A>
617	<A HREF="FacetComponent.html" target="_top"><B>NO FRAMES</B></A>
618	<SCRIPT type="text/javascript">
619	<!--
620	if(window==top) {
621	document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
622	}
623	//-->
624	</SCRIPT>
625	<NOSCRIPT>
626	<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
627	</NOSCRIPT>
628
629
630	</FONT></TD>
631	</TR>
632	<TR>
633	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
634	SUMMARY: <A HREF="#nested_class_summary">NESTED</A> \| <A HREF="#field_summary">FIELD</A> \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
635	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
636	DETAIL: <A HREF="#field_detail">FIELD</A> \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
637	</TR>
638	</TABLE>
639	<A NAME="skip-navbar_bottom"></A>
640	<!-- ======== END OF BOTTOM NAVBAR ======= -->
641
642	<HR>
643
644	<address>Copyright © 2000-2012 Apache Software Foundation. All Rights Reserved.</address>
645	<script src='../../../../../prettify.js' type='text/javascript'></script>
646	<script type='text/javascript'>
647	(function(){
648	var oldonload = window.onload;
649	if (typeof oldonload != 'function') {
650	window.onload = prettyPrint;
651	} else {
652	window.onload = function() {
653	oldonload();
654	prettyPrint();
655	}
656	}
657	})();
658	</script>
659
660	</BODY>
661	</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/FacetComponent.html @ 7588

Download in other formats: