source: sandbox/expresso-solr/solr/docs/api/org/apache/solr/handler/clustering/carrot2/CarrotClusteringEngine.html @ 7588

Revision 7588, 25.4 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:26 EDT 2012 -->
6<META http-equiv="Content-Type" content="text/html; charset=utf-8">
7<TITLE>
8CarrotClusteringEngine (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="CarrotClusteringEngine (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/CarrotClusteringEngine.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
47  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
48  </TR>
49</TABLE>
50</TD>
51<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
52</EM>
53</TD>
54</TR>
55
56<TR>
57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
58&nbsp;PREV CLASS&nbsp;
59&nbsp;<A HREF="../../../../../../org/apache/solr/handler/clustering/carrot2/CarrotParams.html" title="class in org.apache.solr.handler.clustering.carrot2"><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/clustering/carrot2/CarrotClusteringEngine.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="CarrotClusteringEngine.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
63&nbsp;<SCRIPT type="text/javascript">
64  <!--
65  if(window==top) {
66    document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
67  }
68  //-->
69</SCRIPT>
70<NOSCRIPT>
71  <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
72</NOSCRIPT>
73
74
75</FONT></TD>
76</TR>
77<TR>
78<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
79  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.solr.handler.clustering.ClusteringEngine">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;FIELD&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.clustering.carrot2</FONT>
92<BR>
93Class CarrotClusteringEngine</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/clustering/ClusteringEngine.html" title="class in org.apache.solr.handler.clustering">org.apache.solr.handler.clustering.ClusteringEngine</A>
97      <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../../org/apache/solr/handler/clustering/SearchClusteringEngine.html" title="class in org.apache.solr.handler.clustering">org.apache.solr.handler.clustering.SearchClusteringEngine</A>
98          <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.solr.handler.clustering.carrot2.CarrotClusteringEngine</B>
99</PRE>
100<HR>
101<DL>
102<DT><PRE>public class <B>CarrotClusteringEngine</B><DT>extends <A HREF="../../../../../../org/apache/solr/handler/clustering/SearchClusteringEngine.html" title="class in org.apache.solr.handler.clustering">SearchClusteringEngine</A></DL>
103</PRE>
104
105<P>
106Search results clustering engine based on Carrot2 clustering algorithms.
107 <p/>
108 Output from this class is subject to change.
109<P>
110
111<P>
112<DL>
113<DT><B>See Also:</B><DD>"http://project.carrot2.org"</DL>
114<HR>
115
116<P>
117<!-- =========== FIELD SUMMARY =========== -->
118
119<A NAME="field_summary"><!-- --></A>
120<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
121<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
122<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
123<B>Field Summary</B></FONT></TH>
124</TR>
125</TABLE>
126&nbsp;<A NAME="fields_inherited_from_class_org.apache.solr.handler.clustering.ClusteringEngine"><!-- --></A>
127<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
128<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
129<TH ALIGN="left"><B>Fields inherited from class org.apache.solr.handler.clustering.<A HREF="../../../../../../org/apache/solr/handler/clustering/ClusteringEngine.html" title="class in org.apache.solr.handler.clustering">ClusteringEngine</A></B></TH>
130</TR>
131<TR BGCOLOR="white" CLASS="TableRowColor">
132<TD><CODE><A HREF="../../../../../../org/apache/solr/handler/clustering/ClusteringEngine.html#DEFAULT_ENGINE_NAME">DEFAULT_ENGINE_NAME</A>, <A HREF="../../../../../../org/apache/solr/handler/clustering/ClusteringEngine.html#ENGINE_NAME">ENGINE_NAME</A></CODE></TD>
133</TR>
134</TABLE>
135&nbsp;
136<!-- ======== CONSTRUCTOR SUMMARY ======== -->
137
138<A NAME="constructor_summary"><!-- --></A>
139<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
140<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
141<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
142<B>Constructor Summary</B></FONT></TH>
143</TR>
144<TR BGCOLOR="white" CLASS="TableRowColor">
145<TD><CODE><B><A HREF="../../../../../../org/apache/solr/handler/clustering/carrot2/CarrotClusteringEngine.html#CarrotClusteringEngine()">CarrotClusteringEngine</A></B>()</CODE>
146
147<BR>
148&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
149</TR>
150</TABLE>
151&nbsp;
152<!-- ========== METHOD SUMMARY =========== -->
153
154<A NAME="method_summary"><!-- --></A>
155<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
156<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
157<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
158<B>Method Summary</B></FONT></TH>
159</TR>
160<TR BGCOLOR="white" CLASS="TableRowColor">
161<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
162<CODE>&nbsp;<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></CODE></FONT></TD>
163<TD><CODE><B><A HREF="../../../../../../org/apache/solr/handler/clustering/carrot2/CarrotClusteringEngine.html#cluster(org.apache.lucene.search.Query, org.apache.solr.search.DocList, org.apache.solr.request.SolrQueryRequest)">cluster</A></B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Query.html?is-external=true" title="class or interface in org.apache.lucene.search">Query</A>&nbsp;query,
164        <A HREF="../../../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A>&nbsp;docList,
165        <A HREF="../../../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;sreq)</CODE>
166
167<BR>
168&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;</TD>
169</TR>
170<TR BGCOLOR="white" CLASS="TableRowColor">
171<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
172<CODE>&nbsp;<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></CODE></FONT></TD>
173<TD><CODE><B><A HREF="../../../../../../org/apache/solr/handler/clustering/carrot2/CarrotClusteringEngine.html#cluster(org.apache.lucene.search.Query, org.apache.solr.common.SolrDocumentList, java.util.Map, org.apache.solr.request.SolrQueryRequest)">cluster</A></B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Query.html?is-external=true" title="class or interface in org.apache.lucene.search">Query</A>&nbsp;query,
174        <A HREF="../../../../../../org/apache/solr/common/SolrDocumentList.html" title="class in org.apache.solr.common">SolrDocumentList</A>&nbsp;solrDocList,
175        <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&lt;<A HREF="../../../../../../org/apache/solr/common/SolrDocument.html" title="class in org.apache.solr.common">SolrDocument</A>,<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</A>&gt;&nbsp;docIds,
176        <A HREF="../../../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;sreq)</CODE>
177
178<BR>
179&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
180</TR>
181<TR BGCOLOR="white" CLASS="TableRowColor">
182<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
183<CODE>protected &nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A>&lt;<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>&gt;</CODE></FONT></TD>
184<TD><CODE><B><A HREF="../../../../../../org/apache/solr/handler/clustering/carrot2/CarrotClusteringEngine.html#getFieldsToLoad(org.apache.solr.request.SolrQueryRequest)">getFieldsToLoad</A></B>(<A HREF="../../../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;sreq)</CODE>
185
186<BR>
187&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the set of field names to load.</TD>
188</TR>
189<TR BGCOLOR="white" CLASS="TableRowColor">
190<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
191<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>
192<TD><CODE><B><A HREF="../../../../../../org/apache/solr/handler/clustering/carrot2/CarrotClusteringEngine.html#init(org.apache.solr.common.util.NamedList, org.apache.solr.core.SolrCore)">init</A></B>(<A HREF="../../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&nbsp;config,
193     <A HREF="../../../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</A>&nbsp;core)</CODE>
194
195<BR>
196&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
197</TR>
198</TABLE>
199&nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.handler.clustering.SearchClusteringEngine"><!-- --></A>
200<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
201<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
202<TH ALIGN="left"><B>Methods inherited from class org.apache.solr.handler.clustering.<A HREF="../../../../../../org/apache/solr/handler/clustering/SearchClusteringEngine.html" title="class in org.apache.solr.handler.clustering">SearchClusteringEngine</A></B></TH>
203</TR>
204<TR BGCOLOR="white" CLASS="TableRowColor">
205<TD><CODE><A HREF="../../../../../../org/apache/solr/handler/clustering/SearchClusteringEngine.html#getSolrDocumentList(org.apache.solr.search.DocList, org.apache.solr.request.SolrQueryRequest, java.util.Map)">getSolrDocumentList</A></CODE></TD>
206</TR>
207</TABLE>
208&nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.handler.clustering.ClusteringEngine"><!-- --></A>
209<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
210<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
211<TH ALIGN="left"><B>Methods inherited from class org.apache.solr.handler.clustering.<A HREF="../../../../../../org/apache/solr/handler/clustering/ClusteringEngine.html" title="class in org.apache.solr.handler.clustering">ClusteringEngine</A></B></TH>
212</TR>
213<TR BGCOLOR="white" CLASS="TableRowColor">
214<TD><CODE><A HREF="../../../../../../org/apache/solr/handler/clustering/ClusteringEngine.html#getName()">getName</A></CODE></TD>
215</TR>
216</TABLE>
217&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
218<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
219<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
220<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>
221</TR>
222<TR BGCOLOR="white" CLASS="TableRowColor">
223<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>
224</TR>
225</TABLE>
226&nbsp;
227<P>
228
229<!-- ========= CONSTRUCTOR DETAIL ======== -->
230
231<A NAME="constructor_detail"><!-- --></A>
232<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
233<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
234<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
235<B>Constructor Detail</B></FONT></TH>
236</TR>
237</TABLE>
238
239<A NAME="CarrotClusteringEngine()"><!-- --></A><H3>
240CarrotClusteringEngine</H3>
241<PRE>
242public <B>CarrotClusteringEngine</B>()</PRE>
243<DL>
244</DL>
245
246<!-- ============ METHOD DETAIL ========== -->
247
248<A NAME="method_detail"><!-- --></A>
249<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
250<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
251<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
252<B>Method Detail</B></FONT></TH>
253</TR>
254</TABLE>
255
256<A NAME="cluster(org.apache.lucene.search.Query, org.apache.solr.search.DocList, org.apache.solr.request.SolrQueryRequest)"><!-- --></A><H3>
257cluster</H3>
258<PRE>
259<FONT SIZE="-1"><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</A>
260</FONT>public <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>cluster</B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Query.html?is-external=true" title="class or interface in org.apache.lucene.search">Query</A>&nbsp;query,
261                                 <A HREF="../../../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A>&nbsp;docList,
262                                 <A HREF="../../../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;sreq)</PRE>
263<DL>
264<DD><B>Deprecated.</B>&nbsp;
265<P>
266<DD><DL>
267<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/solr/handler/clustering/SearchClusteringEngine.html#cluster(org.apache.lucene.search.Query, org.apache.solr.search.DocList, org.apache.solr.request.SolrQueryRequest)">cluster</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/solr/handler/clustering/SearchClusteringEngine.html" title="class in org.apache.solr.handler.clustering">SearchClusteringEngine</A></CODE></DL>
268</DD>
269<DD><DL>
270</DL>
271</DD>
272</DL>
273<HR>
274
275<A NAME="cluster(org.apache.lucene.search.Query, org.apache.solr.common.SolrDocumentList, java.util.Map, org.apache.solr.request.SolrQueryRequest)"><!-- --></A><H3>
276cluster</H3>
277<PRE>
278public <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>cluster</B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Query.html?is-external=true" title="class or interface in org.apache.lucene.search">Query</A>&nbsp;query,
279                      <A HREF="../../../../../../org/apache/solr/common/SolrDocumentList.html" title="class in org.apache.solr.common">SolrDocumentList</A>&nbsp;solrDocList,
280                      <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A>&lt;<A HREF="../../../../../../org/apache/solr/common/SolrDocument.html" title="class in org.apache.solr.common">SolrDocument</A>,<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</A>&gt;&nbsp;docIds,
281                      <A HREF="../../../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;sreq)</PRE>
282<DL>
283<DD><DL>
284<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/solr/handler/clustering/SearchClusteringEngine.html#cluster(org.apache.lucene.search.Query, org.apache.solr.common.SolrDocumentList, java.util.Map, org.apache.solr.request.SolrQueryRequest)">cluster</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/solr/handler/clustering/SearchClusteringEngine.html" title="class in org.apache.solr.handler.clustering">SearchClusteringEngine</A></CODE></DL>
285</DD>
286<DD><DL>
287</DL>
288</DD>
289</DL>
290<HR>
291
292<A NAME="init(org.apache.solr.common.util.NamedList, org.apache.solr.core.SolrCore)"><!-- --></A><H3>
293init</H3>
294<PRE>
295public <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>init</B>(<A HREF="../../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&nbsp;config,
296                   <A HREF="../../../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</A>&nbsp;core)</PRE>
297<DL>
298<DD><DL>
299<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/apache/solr/handler/clustering/ClusteringEngine.html#init(org.apache.solr.common.util.NamedList, org.apache.solr.core.SolrCore)">init</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/solr/handler/clustering/ClusteringEngine.html" title="class in org.apache.solr.handler.clustering">ClusteringEngine</A></CODE></DL>
300</DD>
301<DD><DL>
302</DL>
303</DD>
304</DL>
305<HR>
306
307<A NAME="getFieldsToLoad(org.apache.solr.request.SolrQueryRequest)"><!-- --></A><H3>
308getFieldsToLoad</H3>
309<PRE>
310protected <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A>&lt;<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>&gt; <B>getFieldsToLoad</B>(<A HREF="../../../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;sreq)</PRE>
311<DL>
312<DD><B>Description copied from class: <CODE><A HREF="../../../../../../org/apache/solr/handler/clustering/SearchClusteringEngine.html#getFieldsToLoad(org.apache.solr.request.SolrQueryRequest)">SearchClusteringEngine</A></CODE></B></DD>
313<DD>Returns the set of field names to load.
314 Concrete classes can override this method if needed.
315 Default implementation returns null, that is, all stored fields are loaded.
316<P>
317<DD><DL>
318<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/apache/solr/handler/clustering/SearchClusteringEngine.html#getFieldsToLoad(org.apache.solr.request.SolrQueryRequest)">getFieldsToLoad</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/solr/handler/clustering/SearchClusteringEngine.html" title="class in org.apache.solr.handler.clustering">SearchClusteringEngine</A></CODE></DL>
319</DD>
320<DD><DL>
321
322<DT><B>Returns:</B><DD>set of field names to load</DL>
323</DD>
324</DL>
325<!-- ========= END OF CLASS DATA ========= -->
326<HR>
327
328
329<!-- ======= START OF BOTTOM NAVBAR ====== -->
330<A NAME="navbar_bottom"><!-- --></A>
331<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
332<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
333<TR>
334<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
335<A NAME="navbar_bottom_firstrow"><!-- --></A>
336<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
337  <TR ALIGN="center" VALIGN="top">
338  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
339  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
340  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
341  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/CarrotClusteringEngine.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
342  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
343  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
344  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
345  </TR>
346</TABLE>
347</TD>
348<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
349</EM>
350</TD>
351</TR>
352
353<TR>
354<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
355&nbsp;PREV CLASS&nbsp;
356&nbsp;<A HREF="../../../../../../org/apache/solr/handler/clustering/carrot2/CarrotParams.html" title="class in org.apache.solr.handler.clustering.carrot2"><B>NEXT CLASS</B></A></FONT></TD>
357<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
358  <A HREF="../../../../../../index.html?org/apache/solr/handler/clustering/carrot2/CarrotClusteringEngine.html" target="_top"><B>FRAMES</B></A>  &nbsp;
359&nbsp;<A HREF="CarrotClusteringEngine.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
360&nbsp;<SCRIPT type="text/javascript">
361  <!--
362  if(window==top) {
363    document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
364  }
365  //-->
366</SCRIPT>
367<NOSCRIPT>
368  <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
369</NOSCRIPT>
370
371
372</FONT></TD>
373</TR>
374<TR>
375<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
376  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.solr.handler.clustering.ClusteringEngine">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
377<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
378DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
379</TR>
380</TABLE>
381<A NAME="skip-navbar_bottom"></A>
382<!-- ======== END OF BOTTOM NAVBAR ======= -->
383
384<HR>
385
386          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
387          <script src='../../../../../../prettify.js' type='text/javascript'></script>
388          <script type='text/javascript'>
389            (function(){
390              var oldonload = window.onload;
391              if (typeof oldonload != 'function') {
392                window.onload = prettyPrint;
393              } else {
394                window.onload = function() {
395                  oldonload();
396                  prettyPrint();
397                }
398              }
399            })();
400          </script>
401       
402</BODY>
403</HTML>
Note: See TracBrowser for help on using the repository browser.