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

Revision 7588, 46.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:25 EDT 2012 -->
6<META http-equiv="Content-Type" content="text/html; charset=utf-8">
7<TITLE>
8AbstractLuceneSpellChecker (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="AbstractLuceneSpellChecker (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/AbstractLuceneSpellChecker.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/spelling/ConjunctionSolrSpellChecker.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/AbstractLuceneSpellChecker.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="AbstractLuceneSpellChecker.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="#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.spelling</FONT>
92<BR>
93Class AbstractLuceneSpellChecker</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/spelling/SolrSpellChecker.html" title="class in org.apache.solr.spelling">org.apache.solr.spelling.SolrSpellChecker</A>
97      <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.solr.spelling.AbstractLuceneSpellChecker</B>
98</PRE>
99<DL>
100<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/solr/spelling/FileBasedSpellChecker.html" title="class in org.apache.solr.spelling">FileBasedSpellChecker</A>, <A HREF="../../../../org/apache/solr/spelling/IndexBasedSpellChecker.html" title="class in org.apache.solr.spelling">IndexBasedSpellChecker</A></DD>
101</DL>
102<HR>
103<DL>
104<DT><PRE>public abstract class <B>AbstractLuceneSpellChecker</B><DT>extends <A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html" title="class in org.apache.solr.spelling">SolrSpellChecker</A></DL>
105</PRE>
106
107<P>
108Abstract base class for all Lucene-based spell checking implementations.
109 
110 <p>
111 Refer to <a href="http://wiki.apache.org/solr/SpellCheckComponent">SpellCheckComponent</a>
112 for more details.
113 </p>
114<P>
115
116<P>
117<DL>
118<DT><B>Since:</B></DT>
119  <DD>solr 1.3</DD>
120</DL>
121<HR>
122
123<P>
124<!-- =========== FIELD SUMMARY =========== -->
125
126<A NAME="field_summary"><!-- --></A>
127<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
128<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
129<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
130<B>Field Summary</B></FONT></TH>
131</TR>
132<TR BGCOLOR="white" CLASS="TableRowColor">
133<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
134<CODE>protected &nbsp;float</CODE></FONT></TD>
135<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#accuracy">accuracy</A></B></CODE>
136
137<BR>
138&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
139</TR>
140<TR BGCOLOR="white" CLASS="TableRowColor">
141<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
142<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>
143<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#ACCURACY">ACCURACY</A></B></CODE>
144
145<BR>
146&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
147</TR>
148<TR BGCOLOR="white" CLASS="TableRowColor">
149<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
150<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>
151<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#COMPARATOR_CLASS">COMPARATOR_CLASS</A></B></CODE>
152
153<BR>
154&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
155</TR>
156<TR BGCOLOR="white" CLASS="TableRowColor">
157<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
158<CODE>static&nbsp;int</CODE></FONT></TD>
159<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#DEFAULT_SUGGESTION_COUNT">DEFAULT_SUGGESTION_COUNT</A></B></CODE>
160
161<BR>
162&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
163</TR>
164<TR BGCOLOR="white" CLASS="TableRowColor">
165<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
166<CODE>protected &nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//suggest/org/apache/lucene/search/spell/Dictionary.html?is-external=true" title="class or interface in org.apache.lucene.search.spell">Dictionary</A></CODE></FONT></TD>
167<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#dictionary">dictionary</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;<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>
175<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#FIELD">FIELD</A></B></CODE>
176
177<BR>
178&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
179</TR>
180<TR BGCOLOR="white" CLASS="TableRowColor">
181<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
182<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>
183<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#FREQ_COMP">FREQ_COMP</A></B></CODE>
184
185<BR>
186&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
187</TR>
188<TR BGCOLOR="white" CLASS="TableRowColor">
189<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
190<CODE>protected &nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/store/Directory.html?is-external=true" title="class or interface in org.apache.lucene.store">Directory</A></CODE></FONT></TD>
191<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#index">index</A></B></CODE>
192
193<BR>
194&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
195</TR>
196<TR BGCOLOR="white" CLASS="TableRowColor">
197<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
198<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>
199<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#INDEX_DIR">INDEX_DIR</A></B></CODE>
200
201<BR>
202&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
203</TR>
204<TR BGCOLOR="white" CLASS="TableRowColor">
205<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
206<CODE>protected &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>
207<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#indexDir">indexDir</A></B></CODE>
208
209<BR>
210&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
211</TR>
212<TR BGCOLOR="white" CLASS="TableRowColor">
213<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
214<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>
215<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#LOCATION">LOCATION</A></B></CODE>
216
217<BR>
218&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
219</TR>
220<TR BGCOLOR="white" CLASS="TableRowColor">
221<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
222<CODE>static&nbsp;org.slf4j.Logger</CODE></FONT></TD>
223<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#log">log</A></B></CODE>
224
225<BR>
226&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
227</TR>
228<TR BGCOLOR="white" CLASS="TableRowColor">
229<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
230<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>
231<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#SCORE_COMP">SCORE_COMP</A></B></CODE>
232
233<BR>
234&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
235</TR>
236<TR BGCOLOR="white" CLASS="TableRowColor">
237<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
238<CODE>protected &nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//suggest/org/apache/lucene/search/spell/StringDistance.html?is-external=true" title="class or interface in org.apache.lucene.search.spell">StringDistance</A></CODE></FONT></TD>
239<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#sd">sd</A></B></CODE>
240
241<BR>
242&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
243</TR>
244<TR BGCOLOR="white" CLASS="TableRowColor">
245<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
246<CODE>protected &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>
247<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#sourceLocation">sourceLocation</A></B></CODE>
248
249<BR>
250&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
251</TR>
252<TR BGCOLOR="white" CLASS="TableRowColor">
253<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
254<CODE>protected &nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//suggest/org/apache/lucene/search/spell/SpellChecker.html?is-external=true" title="class or interface in org.apache.lucene.search.spell">SpellChecker</A></CODE></FONT></TD>
255<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#spellChecker">spellChecker</A></B></CODE>
256
257<BR>
258&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
259</TR>
260<TR BGCOLOR="white" CLASS="TableRowColor">
261<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
262<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>
263<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#SPELLCHECKER_ARG_NAME">SPELLCHECKER_ARG_NAME</A></B></CODE>
264
265<BR>
266&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
267</TR>
268<TR BGCOLOR="white" CLASS="TableRowColor">
269<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
270<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>
271<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#STRING_DISTANCE">STRING_DISTANCE</A></B></CODE>
272
273<BR>
274&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
275</TR>
276</TABLE>
277&nbsp;<A NAME="fields_inherited_from_class_org.apache.solr.spelling.SolrSpellChecker"><!-- --></A>
278<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
279<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
280<TH ALIGN="left"><B>Fields inherited from class org.apache.solr.spelling.<A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html" title="class in org.apache.solr.spelling">SolrSpellChecker</A></B></TH>
281</TR>
282<TR BGCOLOR="white" CLASS="TableRowColor">
283<TD><CODE><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#analyzer">analyzer</A>, <A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#DEFAULT_DICTIONARY_NAME">DEFAULT_DICTIONARY_NAME</A>, <A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#DICTIONARY_NAME">DICTIONARY_NAME</A>, <A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#field">field</A>, <A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#FIELD_TYPE">FIELD_TYPE</A>, <A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#fieldTypeName">fieldTypeName</A>, <A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#name">name</A></CODE></TD>
284</TR>
285</TABLE>
286&nbsp;
287<!-- ======== CONSTRUCTOR SUMMARY ======== -->
288
289<A NAME="constructor_summary"><!-- --></A>
290<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
291<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
292<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
293<B>Constructor Summary</B></FONT></TH>
294</TR>
295<TR BGCOLOR="white" CLASS="TableRowColor">
296<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#AbstractLuceneSpellChecker()">AbstractLuceneSpellChecker</A></B>()</CODE>
297
298<BR>
299&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
300</TR>
301</TABLE>
302&nbsp;
303<!-- ========== METHOD SUMMARY =========== -->
304
305<A NAME="method_summary"><!-- --></A>
306<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
307<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
308<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
309<B>Method Summary</B></FONT></TH>
310</TR>
311<TR BGCOLOR="white" CLASS="TableRowColor">
312<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
313<CODE>protected &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>
314<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#determineReader(org.apache.lucene.index.IndexReader)">determineReader</A></B>(<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>
315
316<BR>
317&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
318</TR>
319<TR BGCOLOR="white" CLASS="TableRowColor">
320<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
321<CODE>&nbsp;float</CODE></FONT></TD>
322<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#getAccuracy()">getAccuracy</A></B>()</CODE>
323
324<BR>
325&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the value of <A HREF="../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_ACCURACY"><CODE>SpellingParams.SPELLCHECK_ACCURACY</CODE></A> if supported.</TD>
326</TR>
327<TR BGCOLOR="white" CLASS="TableRowColor">
328<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
329<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>
330<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#getField()">getField</A></B>()</CODE>
331
332<BR>
333&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
334</TR>
335<TR BGCOLOR="white" CLASS="TableRowColor">
336<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
337<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>
338<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#getFieldTypeName()">getFieldTypeName</A></B>()</CODE>
339
340<BR>
341&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
342</TR>
343<TR BGCOLOR="white" CLASS="TableRowColor">
344<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
345<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>
346<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#getIndexDir()">getIndexDir</A></B>()</CODE>
347
348<BR>
349&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
350</TR>
351<TR BGCOLOR="white" CLASS="TableRowColor">
352<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
353<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>
354<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#getSourceLocation()">getSourceLocation</A></B>()</CODE>
355
356<BR>
357&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
358</TR>
359<TR BGCOLOR="white" CLASS="TableRowColor">
360<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
361<CODE>&nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//suggest/org/apache/lucene/search/spell/SpellChecker.html?is-external=true" title="class or interface in org.apache.lucene.search.spell">SpellChecker</A></CODE></FONT></TD>
362<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#getSpellChecker()">getSpellChecker</A></B>()</CODE>
363
364<BR>
365&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
366</TR>
367<TR BGCOLOR="white" CLASS="TableRowColor">
368<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
369<CODE>&nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//suggest/org/apache/lucene/search/spell/StringDistance.html?is-external=true" title="class or interface in org.apache.lucene.search.spell">StringDistance</A></CODE></FONT></TD>
370<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#getStringDistance()">getStringDistance</A></B>()</CODE>
371
372<BR>
373&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the distance implementation used by this spellchecker, or NULL if not applicable.</TD>
374</TR>
375<TR BGCOLOR="white" CLASS="TableRowColor">
376<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
377<CODE>&nbsp;<A HREF="../../../../org/apache/solr/spelling/SpellingResult.html" title="class in org.apache.solr.spelling">SpellingResult</A></CODE></FONT></TD>
378<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#getSuggestions(org.apache.solr.spelling.SpellingOptions)">getSuggestions</A></B>(<A HREF="../../../../org/apache/solr/spelling/SpellingOptions.html" title="class in org.apache.solr.spelling">SpellingOptions</A>&nbsp;options)</CODE>
379
380<BR>
381&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get suggestions for the given query.</TD>
382</TR>
383<TR BGCOLOR="white" CLASS="TableRowColor">
384<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
385<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>
386<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.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,
387     <A HREF="../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</A>&nbsp;core)</CODE>
388
389<BR>
390&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
391</TR>
392<TR BGCOLOR="white" CLASS="TableRowColor">
393<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
394<CODE>protected &nbsp;void</CODE></FONT></TD>
395<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#initIndex()">initIndex</A></B>()</CODE>
396
397<BR>
398&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Initialize the <A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#index"><CODE>index</CODE></A> variable based on the <A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#indexDir"><CODE>indexDir</CODE></A>.</TD>
399</TR>
400<TR BGCOLOR="white" CLASS="TableRowColor">
401<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
402<CODE>&nbsp;void</CODE></FONT></TD>
403<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#reload(org.apache.solr.core.SolrCore, org.apache.solr.search.SolrIndexSearcher)">reload</A></B>(<A HREF="../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</A>&nbsp;core,
404       <A HREF="../../../../org/apache/solr/search/SolrIndexSearcher.html" title="class in org.apache.solr.search">SolrIndexSearcher</A>&nbsp;searcher)</CODE>
405
406<BR>
407&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reloads the index.</TD>
408</TR>
409</TABLE>
410&nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.spelling.SolrSpellChecker"><!-- --></A>
411<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
412<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
413<TH ALIGN="left"><B>Methods inherited from class org.apache.solr.spelling.<A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html" title="class in org.apache.solr.spelling">SolrSpellChecker</A></B></TH>
414</TR>
415<TR BGCOLOR="white" CLASS="TableRowColor">
416<TD><CODE><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#build(org.apache.solr.core.SolrCore, org.apache.solr.search.SolrIndexSearcher)">build</A>, <A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#getDictionaryName()">getDictionaryName</A>, <A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#getQueryAnalyzer()">getQueryAnalyzer</A>, <A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#isSuggestionsMayOverlap()">isSuggestionsMayOverlap</A>, <A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#mergeSuggestions(org.apache.solr.handler.component.SpellCheckMergeData, int, int, boolean)">mergeSuggestions</A></CODE></TD>
417</TR>
418</TABLE>
419&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
420<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
421<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
422<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>
423</TR>
424<TR BGCOLOR="white" CLASS="TableRowColor">
425<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>
426</TR>
427</TABLE>
428&nbsp;
429<P>
430
431<!-- ============ FIELD DETAIL =========== -->
432
433<A NAME="field_detail"><!-- --></A>
434<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
435<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
436<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
437<B>Field Detail</B></FONT></TH>
438</TR>
439</TABLE>
440
441<A NAME="log"><!-- --></A><H3>
442log</H3>
443<PRE>
444public static final org.slf4j.Logger <B>log</B></PRE>
445<DL>
446<DL>
447</DL>
448</DL>
449<HR>
450
451<A NAME="SPELLCHECKER_ARG_NAME"><!-- --></A><H3>
452SPELLCHECKER_ARG_NAME</H3>
453<PRE>
454public 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>SPELLCHECKER_ARG_NAME</B></PRE>
455<DL>
456<DL>
457<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.solr.spelling.AbstractLuceneSpellChecker.SPELLCHECKER_ARG_NAME">Constant Field Values</A></DL>
458</DL>
459<HR>
460
461<A NAME="LOCATION"><!-- --></A><H3>
462LOCATION</H3>
463<PRE>
464public 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>LOCATION</B></PRE>
465<DL>
466<DL>
467<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.solr.spelling.AbstractLuceneSpellChecker.LOCATION">Constant Field Values</A></DL>
468</DL>
469<HR>
470
471<A NAME="INDEX_DIR"><!-- --></A><H3>
472INDEX_DIR</H3>
473<PRE>
474public 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>INDEX_DIR</B></PRE>
475<DL>
476<DL>
477<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.solr.spelling.AbstractLuceneSpellChecker.INDEX_DIR">Constant Field Values</A></DL>
478</DL>
479<HR>
480
481<A NAME="ACCURACY"><!-- --></A><H3>
482ACCURACY</H3>
483<PRE>
484public 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>ACCURACY</B></PRE>
485<DL>
486<DL>
487<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.solr.spelling.AbstractLuceneSpellChecker.ACCURACY">Constant Field Values</A></DL>
488</DL>
489<HR>
490
491<A NAME="STRING_DISTANCE"><!-- --></A><H3>
492STRING_DISTANCE</H3>
493<PRE>
494public 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>STRING_DISTANCE</B></PRE>
495<DL>
496<DL>
497<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.solr.spelling.AbstractLuceneSpellChecker.STRING_DISTANCE">Constant Field Values</A></DL>
498</DL>
499<HR>
500
501<A NAME="COMPARATOR_CLASS"><!-- --></A><H3>
502COMPARATOR_CLASS</H3>
503<PRE>
504public 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>COMPARATOR_CLASS</B></PRE>
505<DL>
506<DL>
507<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.solr.spelling.AbstractLuceneSpellChecker.COMPARATOR_CLASS">Constant Field Values</A></DL>
508</DL>
509<HR>
510
511<A NAME="SCORE_COMP"><!-- --></A><H3>
512SCORE_COMP</H3>
513<PRE>
514public 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>SCORE_COMP</B></PRE>
515<DL>
516<DL>
517<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.solr.spelling.AbstractLuceneSpellChecker.SCORE_COMP">Constant Field Values</A></DL>
518</DL>
519<HR>
520
521<A NAME="FREQ_COMP"><!-- --></A><H3>
522FREQ_COMP</H3>
523<PRE>
524public 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>FREQ_COMP</B></PRE>
525<DL>
526<DL>
527<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.solr.spelling.AbstractLuceneSpellChecker.FREQ_COMP">Constant Field Values</A></DL>
528</DL>
529<HR>
530
531<A NAME="spellChecker"><!-- --></A><H3>
532spellChecker</H3>
533<PRE>
534protected <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//suggest/org/apache/lucene/search/spell/SpellChecker.html?is-external=true" title="class or interface in org.apache.lucene.search.spell">SpellChecker</A> <B>spellChecker</B></PRE>
535<DL>
536<DL>
537</DL>
538</DL>
539<HR>
540
541<A NAME="sourceLocation"><!-- --></A><H3>
542sourceLocation</H3>
543<PRE>
544protected <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>sourceLocation</B></PRE>
545<DL>
546<DL>
547</DL>
548</DL>
549<HR>
550
551<A NAME="index"><!-- --></A><H3>
552index</H3>
553<PRE>
554protected <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/store/Directory.html?is-external=true" title="class or interface in org.apache.lucene.store">Directory</A> <B>index</B></PRE>
555<DL>
556<DL>
557</DL>
558</DL>
559<HR>
560
561<A NAME="dictionary"><!-- --></A><H3>
562dictionary</H3>
563<PRE>
564protected <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//suggest/org/apache/lucene/search/spell/Dictionary.html?is-external=true" title="class or interface in org.apache.lucene.search.spell">Dictionary</A> <B>dictionary</B></PRE>
565<DL>
566<DL>
567</DL>
568</DL>
569<HR>
570
571<A NAME="DEFAULT_SUGGESTION_COUNT"><!-- --></A><H3>
572DEFAULT_SUGGESTION_COUNT</H3>
573<PRE>
574public static final int <B>DEFAULT_SUGGESTION_COUNT</B></PRE>
575<DL>
576<DL>
577<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.solr.spelling.AbstractLuceneSpellChecker.DEFAULT_SUGGESTION_COUNT">Constant Field Values</A></DL>
578</DL>
579<HR>
580
581<A NAME="indexDir"><!-- --></A><H3>
582indexDir</H3>
583<PRE>
584protected <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>indexDir</B></PRE>
585<DL>
586<DL>
587</DL>
588</DL>
589<HR>
590
591<A NAME="accuracy"><!-- --></A><H3>
592accuracy</H3>
593<PRE>
594protected float <B>accuracy</B></PRE>
595<DL>
596<DL>
597</DL>
598</DL>
599<HR>
600
601<A NAME="FIELD"><!-- --></A><H3>
602FIELD</H3>
603<PRE>
604public 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>FIELD</B></PRE>
605<DL>
606<DL>
607<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.solr.spelling.AbstractLuceneSpellChecker.FIELD">Constant Field Values</A></DL>
608</DL>
609<HR>
610
611<A NAME="sd"><!-- --></A><H3>
612sd</H3>
613<PRE>
614protected <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//suggest/org/apache/lucene/search/spell/StringDistance.html?is-external=true" title="class or interface in org.apache.lucene.search.spell">StringDistance</A> <B>sd</B></PRE>
615<DL>
616<DL>
617</DL>
618</DL>
619
620<!-- ========= CONSTRUCTOR DETAIL ======== -->
621
622<A NAME="constructor_detail"><!-- --></A>
623<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
624<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
625<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
626<B>Constructor Detail</B></FONT></TH>
627</TR>
628</TABLE>
629
630<A NAME="AbstractLuceneSpellChecker()"><!-- --></A><H3>
631AbstractLuceneSpellChecker</H3>
632<PRE>
633public <B>AbstractLuceneSpellChecker</B>()</PRE>
634<DL>
635</DL>
636
637<!-- ============ METHOD DETAIL ========== -->
638
639<A NAME="method_detail"><!-- --></A>
640<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
641<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
642<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
643<B>Method Detail</B></FONT></TH>
644</TR>
645</TABLE>
646
647<A NAME="init(org.apache.solr.common.util.NamedList, org.apache.solr.core.SolrCore)"><!-- --></A><H3>
648init</H3>
649<PRE>
650public <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,
651                   <A HREF="../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</A>&nbsp;core)</PRE>
652<DL>
653<DD><DL>
654<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#init(org.apache.solr.common.util.NamedList, org.apache.solr.core.SolrCore)">init</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html" title="class in org.apache.solr.spelling">SolrSpellChecker</A></CODE></DL>
655</DD>
656<DD><DL>
657</DL>
658</DD>
659</DL>
660<HR>
661
662<A NAME="getSuggestions(org.apache.solr.spelling.SpellingOptions)"><!-- --></A><H3>
663getSuggestions</H3>
664<PRE>
665public <A HREF="../../../../org/apache/solr/spelling/SpellingResult.html" title="class in org.apache.solr.spelling">SpellingResult</A> <B>getSuggestions</B>(<A HREF="../../../../org/apache/solr/spelling/SpellingOptions.html" title="class in org.apache.solr.spelling">SpellingOptions</A>&nbsp;options)
666                              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>
667<DL>
668<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#getSuggestions(org.apache.solr.spelling.SpellingOptions)">SolrSpellChecker</A></CODE></B></DD>
669<DD>Get suggestions for the given query.  Tokenizes the query using a field appropriate Analyzer.
670 The <A HREF="../../../../org/apache/solr/spelling/SpellingResult.html#getSuggestions()"><CODE>SpellingResult.getSuggestions()</CODE></A> suggestions must be ordered by best suggestion first.
671 <p/>
672<P>
673<DD><DL>
674<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#getSuggestions(org.apache.solr.spelling.SpellingOptions)">getSuggestions</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html" title="class in org.apache.solr.spelling">SolrSpellChecker</A></CODE></DL>
675</DD>
676<DD><DL>
677<DT><B>Parameters:</B><DD><CODE>options</CODE> - The <A HREF="../../../../org/apache/solr/spelling/SpellingOptions.html" title="class in org.apache.solr.spelling"><CODE>SpellingOptions</CODE></A> to use
678<DT><B>Returns:</B><DD>The <A HREF="../../../../org/apache/solr/spelling/SpellingResult.html" title="class in org.apache.solr.spelling"><CODE>SpellingResult</CODE></A> suggestions
679<DT><B>Throws:</B>
680<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> - if there is an error producing suggestions</DL>
681</DD>
682</DL>
683<HR>
684
685<A NAME="determineReader(org.apache.lucene.index.IndexReader)"><!-- --></A><H3>
686determineReader</H3>
687<PRE>
688protected <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>determineReader</B>(<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>
689<DL>
690<DD><DL>
691</DL>
692</DD>
693</DL>
694<HR>
695
696<A NAME="reload(org.apache.solr.core.SolrCore, org.apache.solr.search.SolrIndexSearcher)"><!-- --></A><H3>
697reload</H3>
698<PRE>
699public void <B>reload</B>(<A HREF="../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</A>&nbsp;core,
700                   <A HREF="../../../../org/apache/solr/search/SolrIndexSearcher.html" title="class in org.apache.solr.search">SolrIndexSearcher</A>&nbsp;searcher)
701            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>
702<DL>
703<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#reload(org.apache.solr.core.SolrCore, org.apache.solr.search.SolrIndexSearcher)">SolrSpellChecker</A></CODE></B></DD>
704<DD>Reloads the index.  Useful if an external process is responsible for building the spell checker.
705<P>
706<DD><DL>
707<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#reload(org.apache.solr.core.SolrCore, org.apache.solr.search.SolrIndexSearcher)">reload</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html" title="class in org.apache.solr.spelling">SolrSpellChecker</A></CODE></DL>
708</DD>
709<DD><DL>
710
711<DT><B>Throws:</B>
712<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>
713</DD>
714</DL>
715<HR>
716
717<A NAME="initIndex()"><!-- --></A><H3>
718initIndex</H3>
719<PRE>
720protected void <B>initIndex</B>()
721                  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>
722<DL>
723<DD>Initialize the <A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#index"><CODE>index</CODE></A> variable based on the <A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#indexDir"><CODE>indexDir</CODE></A>.  Does not actually create the spelling index.
724<P>
725<DD><DL>
726
727<DT><B>Throws:</B>
728<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>
729</DD>
730</DL>
731<HR>
732
733<A NAME="getAccuracy()"><!-- --></A><H3>
734getAccuracy</H3>
735<PRE>
736public float <B>getAccuracy</B>()</PRE>
737<DL>
738<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#getAccuracy()">SolrSpellChecker</A></CODE></B></DD>
739<DD>Get the value of <A HREF="../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_ACCURACY"><CODE>SpellingParams.SPELLCHECK_ACCURACY</CODE></A> if supported. 
740 Otherwise throws UnsupportedOperationException.
741<P>
742<DD><DL>
743<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#getAccuracy()">getAccuracy</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html" title="class in org.apache.solr.spelling">SolrSpellChecker</A></CODE></DL>
744</DD>
745<DD><DL>
746</DL>
747</DD>
748</DL>
749<HR>
750
751<A NAME="getField()"><!-- --></A><H3>
752getField</H3>
753<PRE>
754public <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>getField</B>()</PRE>
755<DL>
756<DD><DL>
757</DL>
758</DD>
759</DL>
760<HR>
761
762<A NAME="getFieldTypeName()"><!-- --></A><H3>
763getFieldTypeName</H3>
764<PRE>
765public <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>getFieldTypeName</B>()</PRE>
766<DL>
767<DD><DL>
768</DL>
769</DD>
770</DL>
771<HR>
772
773<A NAME="getIndexDir()"><!-- --></A><H3>
774getIndexDir</H3>
775<PRE>
776public <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>getIndexDir</B>()</PRE>
777<DL>
778<DD><DL>
779</DL>
780</DD>
781</DL>
782<HR>
783
784<A NAME="getSourceLocation()"><!-- --></A><H3>
785getSourceLocation</H3>
786<PRE>
787public <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>getSourceLocation</B>()</PRE>
788<DL>
789<DD><DL>
790</DL>
791</DD>
792</DL>
793<HR>
794
795<A NAME="getStringDistance()"><!-- --></A><H3>
796getStringDistance</H3>
797<PRE>
798public <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//suggest/org/apache/lucene/search/spell/StringDistance.html?is-external=true" title="class or interface in org.apache.lucene.search.spell">StringDistance</A> <B>getStringDistance</B>()</PRE>
799<DL>
800<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#getStringDistance()">SolrSpellChecker</A></CODE></B></DD>
801<DD>Get the distance implementation used by this spellchecker, or NULL if not applicable.
802<P>
803<DD><DL>
804<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#getStringDistance()">getStringDistance</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html" title="class in org.apache.solr.spelling">SolrSpellChecker</A></CODE></DL>
805</DD>
806<DD><DL>
807</DL>
808</DD>
809</DL>
810<HR>
811
812<A NAME="getSpellChecker()"><!-- --></A><H3>
813getSpellChecker</H3>
814<PRE>
815public <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//suggest/org/apache/lucene/search/spell/SpellChecker.html?is-external=true" title="class or interface in org.apache.lucene.search.spell">SpellChecker</A> <B>getSpellChecker</B>()</PRE>
816<DL>
817<DD><DL>
818</DL>
819</DD>
820</DL>
821<!-- ========= END OF CLASS DATA ========= -->
822<HR>
823
824
825<!-- ======= START OF BOTTOM NAVBAR ====== -->
826<A NAME="navbar_bottom"><!-- --></A>
827<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
828<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
829<TR>
830<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
831<A NAME="navbar_bottom_firstrow"><!-- --></A>
832<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
833  <TR ALIGN="center" VALIGN="top">
834  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
835  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
836  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
837  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/AbstractLuceneSpellChecker.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
838  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
839  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
840  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
841  </TR>
842</TABLE>
843</TD>
844<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
845</EM>
846</TD>
847</TR>
848
849<TR>
850<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
851&nbsp;PREV CLASS&nbsp;
852&nbsp;<A HREF="../../../../org/apache/solr/spelling/ConjunctionSolrSpellChecker.html" title="class in org.apache.solr.spelling"><B>NEXT CLASS</B></A></FONT></TD>
853<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
854  <A HREF="../../../../index.html?org/apache/solr/spelling/AbstractLuceneSpellChecker.html" target="_top"><B>FRAMES</B></A>  &nbsp;
855&nbsp;<A HREF="AbstractLuceneSpellChecker.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
856&nbsp;<SCRIPT type="text/javascript">
857  <!--
858  if(window==top) {
859    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
860  }
861  //-->
862</SCRIPT>
863<NOSCRIPT>
864  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
865</NOSCRIPT>
866
867
868</FONT></TD>
869</TR>
870<TR>
871<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
872  SUMMARY:&nbsp;NESTED&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>
873<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
874DETAIL:&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>
875</TR>
876</TABLE>
877<A NAME="skip-navbar_bottom"></A>
878<!-- ======== END OF BOTTOM NAVBAR ======= -->
879
880<HR>
881
882          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
883          <script src='../../../../prettify.js' type='text/javascript'></script>
884          <script type='text/javascript'>
885            (function(){
886              var oldonload = window.onload;
887              if (typeof oldonload != 'function') {
888                window.onload = prettyPrint;
889              } else {
890                window.onload = function() {
891                  oldonload();
892                  prettyPrint();
893                }
894              }
895            })();
896          </script>
897       
898</BODY>
899</HTML>
Note: See TracBrowser for help on using the repository browser.