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

Revision 7588, 31.8 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>
8TermsComponent (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="TermsComponent (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/TermsComponent.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
47  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
48  </TR>
49</TABLE>
50</TD>
51<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
52</EM>
53</TD>
54</TR>
55
56<TR>
57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
58&nbsp;<A HREF="../../../../../org/apache/solr/handler/component/StatsValuesFactory.html" title="class in org.apache.solr.handler.component"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../../org/apache/solr/handler/component/TermsComponent.TermsHelper.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/TermsComponent.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="TermsComponent.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
63&nbsp;<SCRIPT type="text/javascript">
64  <!--
65  if(window==top) {
66    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
67  }
68  //-->
69</SCRIPT>
70<NOSCRIPT>
71  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
72</NOSCRIPT>
73
74
75</FONT></TD>
76</TR>
77<TR>
78<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
79  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
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 TermsComponent</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.TermsComponent</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>TermsComponent</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>
108Return TermEnum information, useful for things like auto suggest.
109 
110 <pre class="prettyprint">
111 &lt;searchComponent name="termsComponent" class="solr.TermsComponent"/&gt;
112 
113 &lt;requestHandler name="/terms" class="solr.SearchHandler"&gt;
114   &lt;lst name="defaults"&gt;
115     &lt;bool name="terms"&gt;true&lt;/bool&gt;
116   &lt;/lst&gt;
117   &lt;arr name="components"&gt;
118     &lt;str&gt;termsComponent&lt;/str&gt;
119   &lt;/arr&gt;
120 &lt;/requestHandler&gt;</pre>
121<P>
122
123<P>
124<DL>
125<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/solr/common/params/TermsParams.html" title="interface in org.apache.solr.common.params"><CODE>See Lucene's TermEnum class</CODE></A></DL>
126<HR>
127
128<P>
129<!-- ======== NESTED CLASS SUMMARY ======== -->
130
131<A NAME="nested_class_summary"><!-- --></A>
132<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
133<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
134<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
135<B>Nested Class Summary</B></FONT></TH>
136</TR>
137<TR BGCOLOR="white" CLASS="TableRowColor">
138<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
139<CODE>&nbsp;class</CODE></FONT></TD>
140<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/TermsComponent.TermsHelper.html" title="class in org.apache.solr.handler.component">TermsComponent.TermsHelper</A></B></CODE>
141
142<BR>
143&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
144</TR>
145</TABLE>
146&nbsp;<A NAME="nested_classes_inherited_from_class_org.apache.solr.core.SolrInfoMBean"><!-- --></A>
147<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
148<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
149<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>
150</TR>
151<TR BGCOLOR="white" CLASS="TableRowColor">
152<TD><CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.Category.html" title="enum in org.apache.solr.core">SolrInfoMBean.Category</A></CODE></TD>
153</TR>
154</TABLE>
155&nbsp;
156<!-- =========== FIELD SUMMARY =========== -->
157
158<A NAME="field_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>Field Summary</B></FONT></TH>
163</TR>
164<TR BGCOLOR="white" CLASS="TableRowColor">
165<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
166<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>
167<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/TermsComponent.html#COMPONENT_NAME">COMPONENT_NAME</A></B></CODE>
168
169<BR>
170&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
171</TR>
172<TR BGCOLOR="white" CLASS="TableRowColor">
173<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
174<CODE>static&nbsp;int</CODE></FONT></TD>
175<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/TermsComponent.html#UNLIMITED_MAX_COUNT">UNLIMITED_MAX_COUNT</A></B></CODE>
176
177<BR>
178&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
179</TR>
180</TABLE>
181&nbsp;
182<!-- ======== CONSTRUCTOR SUMMARY ======== -->
183
184<A NAME="constructor_summary"><!-- --></A>
185<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
186<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
187<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
188<B>Constructor Summary</B></FONT></TH>
189</TR>
190<TR BGCOLOR="white" CLASS="TableRowColor">
191<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/TermsComponent.html#TermsComponent()">TermsComponent</A></B>()</CODE>
192
193<BR>
194&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
195</TR>
196</TABLE>
197&nbsp;
198<!-- ========== METHOD SUMMARY =========== -->
199
200<A NAME="method_summary"><!-- --></A>
201<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
202<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
203<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
204<B>Method Summary</B></FONT></TH>
205</TR>
206<TR BGCOLOR="white" CLASS="TableRowColor">
207<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
208<CODE>&nbsp;int</CODE></FONT></TD>
209<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/TermsComponent.html#distributedProcess(org.apache.solr.handler.component.ResponseBuilder)">distributedProcess</A></B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A>&nbsp;rb)</CODE>
210
211<BR>
212&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Process for a distributed search.</TD>
213</TR>
214<TR BGCOLOR="white" CLASS="TableRowColor">
215<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
216<CODE>&nbsp;void</CODE></FONT></TD>
217<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/TermsComponent.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>
218
219<BR>
220&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called after all responses have been received for this stage.</TD>
221</TR>
222<TR BGCOLOR="white" CLASS="TableRowColor">
223<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
224<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>
225<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/TermsComponent.html#getDescription()">getDescription</A></B>()</CODE>
226
227<BR>
228&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Simple one or two line description</TD>
229</TR>
230<TR BGCOLOR="white" CLASS="TableRowColor">
231<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
232<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>
233<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/TermsComponent.html#getSource()">getSource</A></B>()</CODE>
234
235<BR>
236&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CVS Source, SVN Source, etc</TD>
237</TR>
238<TR BGCOLOR="white" CLASS="TableRowColor">
239<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
240<CODE>&nbsp;void</CODE></FONT></TD>
241<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/TermsComponent.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,
242                <A HREF="../../../../../org/apache/solr/handler/component/ShardRequest.html" title="class in org.apache.solr.handler.component">ShardRequest</A>&nbsp;sreq)</CODE>
243
244<BR>
245&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;void</CODE></FONT></TD>
250<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/TermsComponent.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>
251
252<BR>
253&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Prepare the response.</TD>
254</TR>
255<TR BGCOLOR="white" CLASS="TableRowColor">
256<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
257<CODE>&nbsp;void</CODE></FONT></TD>
258<TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/TermsComponent.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>
259
260<BR>
261&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Process the request for this component</TD>
262</TR>
263</TABLE>
264&nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.handler.component.SearchComponent"><!-- --></A>
265<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
266<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
267<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>
268</TR>
269<TR BGCOLOR="white" CLASS="TableRowColor">
270<TD><CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getCategory()">getCategory</A>, <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getDocs()">getDocs</A>, <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getName()">getName</A>, <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getStatistics()">getStatistics</A>, <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getVersion()">getVersion</A>, <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#init(org.apache.solr.common.util.NamedList)">init</A>, <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#modifyRequest(org.apache.solr.handler.component.ResponseBuilder, org.apache.solr.handler.component.SearchComponent, org.apache.solr.handler.component.ShardRequest)">modifyRequest</A></CODE></TD>
271</TR>
272</TABLE>
273&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
274<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
275<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
276<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>
277</TR>
278<TR BGCOLOR="white" CLASS="TableRowColor">
279<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>
280</TR>
281</TABLE>
282&nbsp;
283<P>
284
285<!-- ============ FIELD DETAIL =========== -->
286
287<A NAME="field_detail"><!-- --></A>
288<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
289<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
290<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
291<B>Field Detail</B></FONT></TH>
292</TR>
293</TABLE>
294
295<A NAME="UNLIMITED_MAX_COUNT"><!-- --></A><H3>
296UNLIMITED_MAX_COUNT</H3>
297<PRE>
298public static final int <B>UNLIMITED_MAX_COUNT</B></PRE>
299<DL>
300<DL>
301<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.handler.component.TermsComponent.UNLIMITED_MAX_COUNT">Constant Field Values</A></DL>
302</DL>
303<HR>
304
305<A NAME="COMPONENT_NAME"><!-- --></A><H3>
306COMPONENT_NAME</H3>
307<PRE>
308public 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>
309<DL>
310<DL>
311<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.handler.component.TermsComponent.COMPONENT_NAME">Constant Field Values</A></DL>
312</DL>
313
314<!-- ========= CONSTRUCTOR DETAIL ======== -->
315
316<A NAME="constructor_detail"><!-- --></A>
317<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
318<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
319<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
320<B>Constructor Detail</B></FONT></TH>
321</TR>
322</TABLE>
323
324<A NAME="TermsComponent()"><!-- --></A><H3>
325TermsComponent</H3>
326<PRE>
327public <B>TermsComponent</B>()</PRE>
328<DL>
329</DL>
330
331<!-- ============ METHOD DETAIL ========== -->
332
333<A NAME="method_detail"><!-- --></A>
334<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
335<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
336<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
337<B>Method Detail</B></FONT></TH>
338</TR>
339</TABLE>
340
341<A NAME="prepare(org.apache.solr.handler.component.ResponseBuilder)"><!-- --></A><H3>
342prepare</H3>
343<PRE>
344public 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)
345             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>
346<DL>
347<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>
348<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.
349 Called for every incoming request.
350
351 The place to do initialization that is request dependent.
352<P>
353<DD><DL>
354<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>
355</DD>
356<DD><DL>
357<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>
358<DT><B>Throws:</B>
359<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>
360</DD>
361</DL>
362<HR>
363
364<A NAME="process(org.apache.solr.handler.component.ResponseBuilder)"><!-- --></A><H3>
365process</H3>
366<PRE>
367public 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)
368             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>
369<DL>
370<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>
371<DD>Process the request for this component
372<P>
373<DD><DL>
374<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>
375</DD>
376<DD><DL>
377<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>
378<DT><B>Throws:</B>
379<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>
380</DD>
381</DL>
382<HR>
383
384<A NAME="distributedProcess(org.apache.solr.handler.component.ResponseBuilder)"><!-- --></A><H3>
385distributedProcess</H3>
386<PRE>
387public int <B>distributedProcess</B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A>&nbsp;rb)
388                       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>
389<DL>
390<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>
391<DD>Process for a distributed search.
392<P>
393<DD><DL>
394<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>
395</DD>
396<DD><DL>
397
398<DT><B>Returns:</B><DD>the next stage for this component
399<DT><B>Throws:</B>
400<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>
401</DD>
402</DL>
403<HR>
404
405<A NAME="handleResponses(org.apache.solr.handler.component.ResponseBuilder, org.apache.solr.handler.component.ShardRequest)"><!-- --></A><H3>
406handleResponses</H3>
407<PRE>
408public 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,
409                            <A HREF="../../../../../org/apache/solr/handler/component/ShardRequest.html" title="class in org.apache.solr.handler.component">ShardRequest</A>&nbsp;sreq)</PRE>
410<DL>
411<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>
412<DD>Called after all responses for a single request were received
413<P>
414<DD><DL>
415<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>
416</DD>
417<DD><DL>
418</DL>
419</DD>
420</DL>
421<HR>
422
423<A NAME="finishStage(org.apache.solr.handler.component.ResponseBuilder)"><!-- --></A><H3>
424finishStage</H3>
425<PRE>
426public 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>
427<DL>
428<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>
429<DD>Called after all responses have been received for this stage.
430 Useful when different requests are sent to each shard.
431<P>
432<DD><DL>
433<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>
434</DD>
435<DD><DL>
436</DL>
437</DD>
438</DL>
439<HR>
440
441<A NAME="getSource()"><!-- --></A><H3>
442getSource</H3>
443<PRE>
444public <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>
445<DL>
446<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getSource()">SolrInfoMBean</A></CODE></B></DD>
447<DD>CVS Source, SVN Source, etc
448<P>
449<DD><DL>
450<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>
451</DD>
452<DD><DL>
453</DL>
454</DD>
455</DL>
456<HR>
457
458<A NAME="getDescription()"><!-- --></A><H3>
459getDescription</H3>
460<PRE>
461public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getDescription</B>()</PRE>
462<DL>
463<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getDescription()">SolrInfoMBean</A></CODE></B></DD>
464<DD>Simple one or two line description
465<P>
466<DD><DL>
467<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getDescription()">getDescription</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getDescription()">getDescription</A></CODE> in class <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A></CODE></DL>
468</DD>
469<DD><DL>
470</DL>
471</DD>
472</DL>
473<!-- ========= END OF CLASS DATA ========= -->
474<HR>
475
476
477<!-- ======= START OF BOTTOM NAVBAR ====== -->
478<A NAME="navbar_bottom"><!-- --></A>
479<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
480<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
481<TR>
482<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
483<A NAME="navbar_bottom_firstrow"><!-- --></A>
484<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
485  <TR ALIGN="center" VALIGN="top">
486  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
487  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
488  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
489  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/TermsComponent.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
490  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
491  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
492  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
493  </TR>
494</TABLE>
495</TD>
496<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
497</EM>
498</TD>
499</TR>
500
501<TR>
502<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
503&nbsp;<A HREF="../../../../../org/apache/solr/handler/component/StatsValuesFactory.html" title="class in org.apache.solr.handler.component"><B>PREV CLASS</B></A>&nbsp;
504&nbsp;<A HREF="../../../../../org/apache/solr/handler/component/TermsComponent.TermsHelper.html" title="class in org.apache.solr.handler.component"><B>NEXT CLASS</B></A></FONT></TD>
505<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
506  <A HREF="../../../../../index.html?org/apache/solr/handler/component/TermsComponent.html" target="_top"><B>FRAMES</B></A>  &nbsp;
507&nbsp;<A HREF="TermsComponent.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
508&nbsp;<SCRIPT type="text/javascript">
509  <!--
510  if(window==top) {
511    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
512  }
513  //-->
514</SCRIPT>
515<NOSCRIPT>
516  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
517</NOSCRIPT>
518
519
520</FONT></TD>
521</TR>
522<TR>
523<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
524  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
525<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
526DETAIL:&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>
527</TR>
528</TABLE>
529<A NAME="skip-navbar_bottom"></A>
530<!-- ======== END OF BOTTOM NAVBAR ======= -->
531
532<HR>
533
534          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
535          <script src='../../../../../prettify.js' type='text/javascript'></script>
536          <script type='text/javascript'>
537            (function(){
538              var oldonload = window.onload;
539              if (typeof oldonload != 'function') {
540                window.onload = prettyPrint;
541              } else {
542                window.onload = function() {
543                  oldonload();
544                  prettyPrint();
545                }
546              }
547            })();
548          </script>
549       
550</BODY>
551</HTML>
Note: See TracBrowser for help on using the repository browser.