source: sandbox/expresso-solr/solr/docs/api/org/apache/solr/spelling/SpellingOptions.html @ 7588

Revision 7588, 29.1 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>
8SpellingOptions (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="SpellingOptions (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/SpellingOptions.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/spelling/SpellCheckCorrection.html" title="class in org.apache.solr.spelling"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../org/apache/solr/spelling/SpellingQueryConverter.html" title="class in org.apache.solr.spelling"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../index.html?org/apache/solr/spelling/SpellingOptions.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="SpellingOptions.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="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#methods_inherited_from_class_java.lang.Object">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;METHOD</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.spelling</FONT>
92<BR>
93Class SpellingOptions</H2>
94<PRE>
95<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
96  <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.solr.spelling.SpellingOptions</B>
97</PRE>
98<HR>
99<DL>
100<DT><PRE>public class <B>SpellingOptions</B><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>
101</PRE>
102
103<P>
104<HR>
105
106<P>
107<!-- =========== FIELD SUMMARY =========== -->
108
109<A NAME="field_summary"><!-- --></A>
110<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
111<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
112<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
113<B>Field Summary</B></FONT></TH>
114</TR>
115<TR BGCOLOR="white" CLASS="TableRowColor">
116<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
117<CODE>&nbsp;float</CODE></FONT></TD>
118<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SpellingOptions.html#accuracy">accuracy</A></B></CODE>
119
120<BR>
121&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Optionally restrict the results to have a minimum accuracy level.</TD>
122</TR>
123<TR BGCOLOR="white" CLASS="TableRowColor">
124<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
125<CODE>&nbsp;<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></CODE></FONT></TD>
126<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SpellingOptions.html#alternativeTermCount">alternativeTermCount</A></B></CODE>
127
128<BR>
129&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
130</TR>
131<TR BGCOLOR="white" CLASS="TableRowColor">
132<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
133<CODE>&nbsp;int</CODE></FONT></TD>
134<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SpellingOptions.html#count">count</A></B></CODE>
135
136<BR>
137&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The number of suggestions to return, if there are any.</TD>
138</TR>
139<TR BGCOLOR="white" CLASS="TableRowColor">
140<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
141<CODE>&nbsp;<A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A></CODE></FONT></TD>
142<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SpellingOptions.html#customParams">customParams</A></B></CODE>
143
144<BR>
145&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Any other custom params can be passed through.</TD>
146</TR>
147<TR BGCOLOR="white" CLASS="TableRowColor">
148<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
149<CODE>&nbsp;boolean</CODE></FONT></TD>
150<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SpellingOptions.html#extendedResults">extendedResults</A></B></CODE>
151
152<BR>
153&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Provide additional, per implementation, information about the results</TD>
154</TR>
155<TR BGCOLOR="white" CLASS="TableRowColor">
156<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
157<CODE>&nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/index/IndexReader.html?is-external=true" title="class or interface in org.apache.lucene.index">IndexReader</A></CODE></FONT></TD>
158<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SpellingOptions.html#reader">reader</A></B></CODE>
159
160<BR>
161&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;An optional <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/index/IndexReader.html?is-external=true" title="class or interface in org.apache.lucene.index"><CODE>IndexReader</CODE></A></TD>
162</TR>
163<TR BGCOLOR="white" CLASS="TableRowColor">
164<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
165<CODE>&nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//suggest/org/apache/lucene/search/spell/SuggestMode.html?is-external=true" title="class or interface in org.apache.lucene.search.spell">SuggestMode</A></CODE></FONT></TD>
166<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SpellingOptions.html#suggestMode">suggestMode</A></B></CODE>
167
168<BR>
169&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
170</TR>
171<TR BGCOLOR="white" CLASS="TableRowColor">
172<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
173<CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Token.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Token</A>&gt;</CODE></FONT></TD>
174<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SpellingOptions.html#tokens">tokens</A></B></CODE>
175
176<BR>
177&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The tokens to spell check</TD>
178</TR>
179</TABLE>
180&nbsp;
181<!-- ======== CONSTRUCTOR SUMMARY ======== -->
182
183<A NAME="constructor_summary"><!-- --></A>
184<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
185<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
186<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
187<B>Constructor Summary</B></FONT></TH>
188</TR>
189<TR BGCOLOR="white" CLASS="TableRowColor">
190<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SpellingOptions.html#SpellingOptions()">SpellingOptions</A></B>()</CODE>
191
192<BR>
193&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
194</TR>
195<TR BGCOLOR="white" CLASS="TableRowColor">
196<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SpellingOptions.html#SpellingOptions(java.util.Collection, org.apache.lucene.index.IndexReader)">SpellingOptions</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Token.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Token</A>&gt;&nbsp;tokens,
197                <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/index/IndexReader.html?is-external=true" title="class or interface in org.apache.lucene.index">IndexReader</A>&nbsp;reader)</CODE>
198
199<BR>
200&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
201</TR>
202<TR BGCOLOR="white" CLASS="TableRowColor">
203<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SpellingOptions.html#SpellingOptions(java.util.Collection, org.apache.lucene.index.IndexReader, int)">SpellingOptions</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Token.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Token</A>&gt;&nbsp;tokens,
204                <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/index/IndexReader.html?is-external=true" title="class or interface in org.apache.lucene.index">IndexReader</A>&nbsp;reader,
205                int&nbsp;count)</CODE>
206
207<BR>
208&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
209</TR>
210<TR BGCOLOR="white" CLASS="TableRowColor">
211<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SpellingOptions.html#SpellingOptions(java.util.Collection, org.apache.lucene.index.IndexReader, int, java.lang.Integer, org.apache.lucene.search.spell.SuggestMode, boolean, float, org.apache.solr.common.params.SolrParams)">SpellingOptions</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Token.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Token</A>&gt;&nbsp;tokens,
212                <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/index/IndexReader.html?is-external=true" title="class or interface in org.apache.lucene.index">IndexReader</A>&nbsp;reader,
213                int&nbsp;count,
214                <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>&nbsp;alternativeTermCount,
215                <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//suggest/org/apache/lucene/search/spell/SuggestMode.html?is-external=true" title="class or interface in org.apache.lucene.search.spell">SuggestMode</A>&nbsp;suggestMode,
216                boolean&nbsp;extendedResults,
217                float&nbsp;accuracy,
218                <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A>&nbsp;customParams)</CODE>
219
220<BR>
221&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
222</TR>
223<TR BGCOLOR="white" CLASS="TableRowColor">
224<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SpellingOptions.html#SpellingOptions(java.util.Collection, org.apache.lucene.index.IndexReader, int, org.apache.lucene.search.spell.SuggestMode, boolean, float, org.apache.solr.common.params.SolrParams)">SpellingOptions</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Token.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Token</A>&gt;&nbsp;tokens,
225                <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/index/IndexReader.html?is-external=true" title="class or interface in org.apache.lucene.index">IndexReader</A>&nbsp;reader,
226                int&nbsp;count,
227                <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//suggest/org/apache/lucene/search/spell/SuggestMode.html?is-external=true" title="class or interface in org.apache.lucene.search.spell">SuggestMode</A>&nbsp;suggestMode,
228                boolean&nbsp;extendedResults,
229                float&nbsp;accuracy,
230                <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A>&nbsp;customParams)</CODE>
231
232<BR>
233&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
234</TR>
235<TR BGCOLOR="white" CLASS="TableRowColor">
236<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SpellingOptions.html#SpellingOptions(java.util.Collection, int)">SpellingOptions</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Token.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Token</A>&gt;&nbsp;tokens,
237                int&nbsp;count)</CODE>
238
239<BR>
240&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
241</TR>
242</TABLE>
243&nbsp;
244<!-- ========== METHOD SUMMARY =========== -->
245
246<A NAME="method_summary"><!-- --></A>
247<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
248<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
249<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
250<B>Method Summary</B></FONT></TH>
251</TR>
252</TABLE>
253&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
254<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
255<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
256<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>
257</TR>
258<TR BGCOLOR="white" CLASS="TableRowColor">
259<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>
260</TR>
261</TABLE>
262&nbsp;
263<P>
264
265<!-- ============ FIELD DETAIL =========== -->
266
267<A NAME="field_detail"><!-- --></A>
268<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
269<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
270<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
271<B>Field Detail</B></FONT></TH>
272</TR>
273</TABLE>
274
275<A NAME="tokens"><!-- --></A><H3>
276tokens</H3>
277<PRE>
278public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Token.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Token</A>&gt; <B>tokens</B></PRE>
279<DL>
280<DD>The tokens to spell check
281<P>
282<DL>
283</DL>
284</DL>
285<HR>
286
287<A NAME="reader"><!-- --></A><H3>
288reader</H3>
289<PRE>
290public <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/index/IndexReader.html?is-external=true" title="class or interface in org.apache.lucene.index">IndexReader</A> <B>reader</B></PRE>
291<DL>
292<DD>An optional <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/index/IndexReader.html?is-external=true" title="class or interface in org.apache.lucene.index"><CODE>IndexReader</CODE></A>
293<P>
294<DL>
295</DL>
296</DL>
297<HR>
298
299<A NAME="count"><!-- --></A><H3>
300count</H3>
301<PRE>
302public int <B>count</B></PRE>
303<DL>
304<DD>The number of suggestions to return, if there are any. Defaults to 1.
305<P>
306<DL>
307</DL>
308</DL>
309<HR>
310
311<A NAME="alternativeTermCount"><!-- --></A><H3>
312alternativeTermCount</H3>
313<PRE>
314public <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> <B>alternativeTermCount</B></PRE>
315<DL>
316<DL>
317</DL>
318</DL>
319<HR>
320
321<A NAME="suggestMode"><!-- --></A><H3>
322suggestMode</H3>
323<PRE>
324public <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//suggest/org/apache/lucene/search/spell/SuggestMode.html?is-external=true" title="class or interface in org.apache.lucene.search.spell">SuggestMode</A> <B>suggestMode</B></PRE>
325<DL>
326<DL>
327</DL>
328</DL>
329<HR>
330
331<A NAME="extendedResults"><!-- --></A><H3>
332extendedResults</H3>
333<PRE>
334public boolean <B>extendedResults</B></PRE>
335<DL>
336<DD>Provide additional, per implementation, information about the results
337<P>
338<DL>
339</DL>
340</DL>
341<HR>
342
343<A NAME="accuracy"><!-- --></A><H3>
344accuracy</H3>
345<PRE>
346public float <B>accuracy</B></PRE>
347<DL>
348<DD>Optionally restrict the results to have a minimum accuracy level. Per
349 Implementation. By default set to Float.MIN_VALUE.
350<P>
351<DL>
352</DL>
353</DL>
354<HR>
355
356<A NAME="customParams"><!-- --></A><H3>
357customParams</H3>
358<PRE>
359public <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A> <B>customParams</B></PRE>
360<DL>
361<DD>Any other custom params can be passed through. May be null and is null by
362 default.
363<P>
364<DL>
365</DL>
366</DL>
367
368<!-- ========= CONSTRUCTOR DETAIL ======== -->
369
370<A NAME="constructor_detail"><!-- --></A>
371<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
372<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
373<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
374<B>Constructor Detail</B></FONT></TH>
375</TR>
376</TABLE>
377
378<A NAME="SpellingOptions()"><!-- --></A><H3>
379SpellingOptions</H3>
380<PRE>
381public <B>SpellingOptions</B>()</PRE>
382<DL>
383</DL>
384<HR>
385
386<A NAME="SpellingOptions(java.util.Collection, int)"><!-- --></A><H3>
387SpellingOptions</H3>
388<PRE>
389public <B>SpellingOptions</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Token.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Token</A>&gt;&nbsp;tokens,
390                       int&nbsp;count)</PRE>
391<DL>
392</DL>
393<HR>
394
395<A NAME="SpellingOptions(java.util.Collection, org.apache.lucene.index.IndexReader)"><!-- --></A><H3>
396SpellingOptions</H3>
397<PRE>
398public <B>SpellingOptions</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Token.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Token</A>&gt;&nbsp;tokens,
399                       <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/index/IndexReader.html?is-external=true" title="class or interface in org.apache.lucene.index">IndexReader</A>&nbsp;reader)</PRE>
400<DL>
401</DL>
402<HR>
403
404<A NAME="SpellingOptions(java.util.Collection, org.apache.lucene.index.IndexReader, int)"><!-- --></A><H3>
405SpellingOptions</H3>
406<PRE>
407public <B>SpellingOptions</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Token.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Token</A>&gt;&nbsp;tokens,
408                       <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/index/IndexReader.html?is-external=true" title="class or interface in org.apache.lucene.index">IndexReader</A>&nbsp;reader,
409                       int&nbsp;count)</PRE>
410<DL>
411</DL>
412<HR>
413
414<A NAME="SpellingOptions(java.util.Collection, org.apache.lucene.index.IndexReader, int, org.apache.lucene.search.spell.SuggestMode, boolean, float, org.apache.solr.common.params.SolrParams)"><!-- --></A><H3>
415SpellingOptions</H3>
416<PRE>
417public <B>SpellingOptions</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Token.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Token</A>&gt;&nbsp;tokens,
418                       <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/index/IndexReader.html?is-external=true" title="class or interface in org.apache.lucene.index">IndexReader</A>&nbsp;reader,
419                       int&nbsp;count,
420                       <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//suggest/org/apache/lucene/search/spell/SuggestMode.html?is-external=true" title="class or interface in org.apache.lucene.search.spell">SuggestMode</A>&nbsp;suggestMode,
421                       boolean&nbsp;extendedResults,
422                       float&nbsp;accuracy,
423                       <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A>&nbsp;customParams)</PRE>
424<DL>
425</DL>
426<HR>
427
428<A NAME="SpellingOptions(java.util.Collection, org.apache.lucene.index.IndexReader, int, java.lang.Integer, org.apache.lucene.search.spell.SuggestMode, boolean, float, org.apache.solr.common.params.SolrParams)"><!-- --></A><H3>
429SpellingOptions</H3>
430<PRE>
431public <B>SpellingOptions</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Token.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Token</A>&gt;&nbsp;tokens,
432                       <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/index/IndexReader.html?is-external=true" title="class or interface in org.apache.lucene.index">IndexReader</A>&nbsp;reader,
433                       int&nbsp;count,
434                       <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>&nbsp;alternativeTermCount,
435                       <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//suggest/org/apache/lucene/search/spell/SuggestMode.html?is-external=true" title="class or interface in org.apache.lucene.search.spell">SuggestMode</A>&nbsp;suggestMode,
436                       boolean&nbsp;extendedResults,
437                       float&nbsp;accuracy,
438                       <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A>&nbsp;customParams)</PRE>
439<DL>
440</DL>
441<!-- ========= END OF CLASS DATA ========= -->
442<HR>
443
444
445<!-- ======= START OF BOTTOM NAVBAR ====== -->
446<A NAME="navbar_bottom"><!-- --></A>
447<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
448<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
449<TR>
450<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
451<A NAME="navbar_bottom_firstrow"><!-- --></A>
452<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
453  <TR ALIGN="center" VALIGN="top">
454  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
455  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
456  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
457  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/SpellingOptions.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
458  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
459  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
460  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
461  </TR>
462</TABLE>
463</TD>
464<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
465</EM>
466</TD>
467</TR>
468
469<TR>
470<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
471&nbsp;<A HREF="../../../../org/apache/solr/spelling/SpellCheckCorrection.html" title="class in org.apache.solr.spelling"><B>PREV CLASS</B></A>&nbsp;
472&nbsp;<A HREF="../../../../org/apache/solr/spelling/SpellingQueryConverter.html" title="class in org.apache.solr.spelling"><B>NEXT CLASS</B></A></FONT></TD>
473<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
474  <A HREF="../../../../index.html?org/apache/solr/spelling/SpellingOptions.html" target="_top"><B>FRAMES</B></A>  &nbsp;
475&nbsp;<A HREF="SpellingOptions.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
476&nbsp;<SCRIPT type="text/javascript">
477  <!--
478  if(window==top) {
479    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
480  }
481  //-->
482</SCRIPT>
483<NOSCRIPT>
484  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
485</NOSCRIPT>
486
487
488</FONT></TD>
489</TR>
490<TR>
491<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
492  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#methods_inherited_from_class_java.lang.Object">METHOD</A></FONT></TD>
493<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
494DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
495</TR>
496</TABLE>
497<A NAME="skip-navbar_bottom"></A>
498<!-- ======== END OF BOTTOM NAVBAR ======= -->
499
500<HR>
501
502          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
503          <script src='../../../../prettify.js' type='text/javascript'></script>
504          <script type='text/javascript'>
505            (function(){
506              var oldonload = window.onload;
507              if (typeof oldonload != 'function') {
508                window.onload = prettyPrint;
509              } else {
510                window.onload = function() {
511                  oldonload();
512                  prettyPrint();
513                }
514              }
515            })();
516          </script>
517       
518</BODY>
519</HTML>
Note: See TracBrowser for help on using the repository browser.