source: sandbox/expresso-solr/solr/docs/api/org/apache/solr/search/similarities/BM25SimilarityFactory.html @ 7588

Revision 7588, 16.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:25 EDT 2012 -->
6<META http-equiv="Content-Type" content="text/html; charset=utf-8">
7<TITLE>
8BM25SimilarityFactory (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="BM25SimilarityFactory (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/BM25SimilarityFactory.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/search/similarities/DefaultSimilarityFactory.html" title="class in org.apache.solr.search.similarities"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../../index.html?org/apache/solr/search/similarities/BM25SimilarityFactory.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="BM25SimilarityFactory.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.schema.SimilarityFactory">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.search.similarities</FONT>
92<BR>
93Class BM25SimilarityFactory</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/schema/SimilarityFactory.html" title="class in org.apache.solr.schema">org.apache.solr.schema.SimilarityFactory</A>
97      <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.solr.search.similarities.BM25SimilarityFactory</B>
98</PRE>
99<HR>
100<DL>
101<DT><PRE>public class <B>BM25SimilarityFactory</B><DT>extends <A HREF="../../../../../org/apache/solr/schema/SimilarityFactory.html" title="class in org.apache.solr.schema">SimilarityFactory</A></DL>
102</PRE>
103
104<P>
105Factory for <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/similarities/BM25Similarity.html?is-external=true" title="class or interface in org.apache.lucene.search.similarities"><CODE>BM25Similarity</CODE></A>
106 <p>
107 Parameters:
108 <ul>
109   <li>k1 (float): Controls non-linear term frequency normalization (saturation).
110                   The default is <code>1.2</code>
111   <li>b (float): Controls to what degree document length normalizes tf values.
112                  The default is <code>0.75</code>
113 </ul>
114 <p>
115 Optional settings:
116 <ul>
117   <li>discountOverlaps (bool): Sets
118       <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/similarities/BM25Similarity.html?is-external=true#setDiscountOverlaps(boolean)" title="class or interface in org.apache.lucene.search.similarities"><CODE>BM25Similarity.setDiscountOverlaps(boolean)</CODE></A></li>
119 </ul>
120<P>
121
122<P>
123<DL>
124<DT><B>WARNING: This API is experimental and might change in incompatible ways in the next release.</B></DT>
125  <DD></DD>
126</DL>
127<HR>
128
129<P>
130<!-- =========== FIELD SUMMARY =========== -->
131
132<A NAME="field_summary"><!-- --></A>
133<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
134<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
135<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
136<B>Field Summary</B></FONT></TH>
137</TR>
138</TABLE>
139&nbsp;<A NAME="fields_inherited_from_class_org.apache.solr.schema.SimilarityFactory"><!-- --></A>
140<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
141<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
142<TH ALIGN="left"><B>Fields inherited from class org.apache.solr.schema.<A HREF="../../../../../org/apache/solr/schema/SimilarityFactory.html" title="class in org.apache.solr.schema">SimilarityFactory</A></B></TH>
143</TR>
144<TR BGCOLOR="white" CLASS="TableRowColor">
145<TD><CODE><A HREF="../../../../../org/apache/solr/schema/SimilarityFactory.html#params">params</A></CODE></TD>
146</TR>
147</TABLE>
148&nbsp;
149<!-- ======== CONSTRUCTOR SUMMARY ======== -->
150
151<A NAME="constructor_summary"><!-- --></A>
152<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
153<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
154<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
155<B>Constructor Summary</B></FONT></TH>
156</TR>
157<TR BGCOLOR="white" CLASS="TableRowColor">
158<TD><CODE><B><A HREF="../../../../../org/apache/solr/search/similarities/BM25SimilarityFactory.html#BM25SimilarityFactory()">BM25SimilarityFactory</A></B>()</CODE>
159
160<BR>
161&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
162</TR>
163</TABLE>
164&nbsp;
165<!-- ========== METHOD SUMMARY =========== -->
166
167<A NAME="method_summary"><!-- --></A>
168<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
169<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
170<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
171<B>Method Summary</B></FONT></TH>
172</TR>
173<TR BGCOLOR="white" CLASS="TableRowColor">
174<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
175<CODE>&nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/similarities/Similarity.html?is-external=true" title="class or interface in org.apache.lucene.search.similarities">Similarity</A></CODE></FONT></TD>
176<TD><CODE><B><A HREF="../../../../../org/apache/solr/search/similarities/BM25SimilarityFactory.html#getSimilarity()">getSimilarity</A></B>()</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>&nbsp;void</CODE></FONT></TD>
184<TD><CODE><B><A HREF="../../../../../org/apache/solr/search/similarities/BM25SimilarityFactory.html#init(org.apache.solr.common.params.SolrParams)">init</A></B>(<A HREF="../../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A>&nbsp;params)</CODE>
185
186<BR>
187&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
188</TR>
189</TABLE>
190&nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.schema.SimilarityFactory"><!-- --></A>
191<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
192<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
193<TH ALIGN="left"><B>Methods inherited from class org.apache.solr.schema.<A HREF="../../../../../org/apache/solr/schema/SimilarityFactory.html" title="class in org.apache.solr.schema">SimilarityFactory</A></B></TH>
194</TR>
195<TR BGCOLOR="white" CLASS="TableRowColor">
196<TD><CODE><A HREF="../../../../../org/apache/solr/schema/SimilarityFactory.html#getParams()">getParams</A></CODE></TD>
197</TR>
198</TABLE>
199&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></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 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>
203</TR>
204<TR BGCOLOR="white" CLASS="TableRowColor">
205<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>
206</TR>
207</TABLE>
208&nbsp;
209<P>
210
211<!-- ========= CONSTRUCTOR DETAIL ======== -->
212
213<A NAME="constructor_detail"><!-- --></A>
214<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
215<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
216<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
217<B>Constructor Detail</B></FONT></TH>
218</TR>
219</TABLE>
220
221<A NAME="BM25SimilarityFactory()"><!-- --></A><H3>
222BM25SimilarityFactory</H3>
223<PRE>
224public <B>BM25SimilarityFactory</B>()</PRE>
225<DL>
226</DL>
227
228<!-- ============ METHOD DETAIL ========== -->
229
230<A NAME="method_detail"><!-- --></A>
231<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
232<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
233<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
234<B>Method Detail</B></FONT></TH>
235</TR>
236</TABLE>
237
238<A NAME="init(org.apache.solr.common.params.SolrParams)"><!-- --></A><H3>
239init</H3>
240<PRE>
241public void <B>init</B>(<A HREF="../../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A>&nbsp;params)</PRE>
242<DL>
243<DD><DL>
244<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/solr/schema/SimilarityFactory.html#init(org.apache.solr.common.params.SolrParams)">init</A></CODE> in class <CODE><A HREF="../../../../../org/apache/solr/schema/SimilarityFactory.html" title="class in org.apache.solr.schema">SimilarityFactory</A></CODE></DL>
245</DD>
246<DD><DL>
247</DL>
248</DD>
249</DL>
250<HR>
251
252<A NAME="getSimilarity()"><!-- --></A><H3>
253getSimilarity</H3>
254<PRE>
255public <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/similarities/Similarity.html?is-external=true" title="class or interface in org.apache.lucene.search.similarities">Similarity</A> <B>getSimilarity</B>()</PRE>
256<DL>
257<DD><DL>
258<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/schema/SimilarityFactory.html#getSimilarity()">getSimilarity</A></CODE> in class <CODE><A HREF="../../../../../org/apache/solr/schema/SimilarityFactory.html" title="class in org.apache.solr.schema">SimilarityFactory</A></CODE></DL>
259</DD>
260<DD><DL>
261</DL>
262</DD>
263</DL>
264<!-- ========= END OF CLASS DATA ========= -->
265<HR>
266
267
268<!-- ======= START OF BOTTOM NAVBAR ====== -->
269<A NAME="navbar_bottom"><!-- --></A>
270<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
271<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
272<TR>
273<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
274<A NAME="navbar_bottom_firstrow"><!-- --></A>
275<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
276  <TR ALIGN="center" VALIGN="top">
277  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
278  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
279  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
280  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/BM25SimilarityFactory.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
281  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
282  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
283  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
284  </TR>
285</TABLE>
286</TD>
287<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
288</EM>
289</TD>
290</TR>
291
292<TR>
293<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
294&nbsp;PREV CLASS&nbsp;
295&nbsp;<A HREF="../../../../../org/apache/solr/search/similarities/DefaultSimilarityFactory.html" title="class in org.apache.solr.search.similarities"><B>NEXT CLASS</B></A></FONT></TD>
296<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
297  <A HREF="../../../../../index.html?org/apache/solr/search/similarities/BM25SimilarityFactory.html" target="_top"><B>FRAMES</B></A>  &nbsp;
298&nbsp;<A HREF="BM25SimilarityFactory.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
299&nbsp;<SCRIPT type="text/javascript">
300  <!--
301  if(window==top) {
302    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
303  }
304  //-->
305</SCRIPT>
306<NOSCRIPT>
307  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
308</NOSCRIPT>
309
310
311</FONT></TD>
312</TR>
313<TR>
314<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
315  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.solr.schema.SimilarityFactory">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
316<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
317DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
318</TR>
319</TABLE>
320<A NAME="skip-navbar_bottom"></A>
321<!-- ======== END OF BOTTOM NAVBAR ======= -->
322
323<HR>
324
325          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
326          <script src='../../../../../prettify.js' type='text/javascript'></script>
327          <script type='text/javascript'>
328            (function(){
329              var oldonload = window.onload;
330              if (typeof oldonload != 'function') {
331                window.onload = prettyPrint;
332              } else {
333                window.onload = function() {
334                  oldonload();
335                  prettyPrint();
336                }
337              }
338            })();
339          </script>
340       
341</BODY>
342</HTML>
Note: See TracBrowser for help on using the repository browser.