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

Revision 7588, 32.3 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>
8SolrSpellChecker (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="SolrSpellChecker (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/SolrSpellChecker.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/ResultEntry.html" title="class in org.apache.solr.spelling"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../org/apache/solr/spelling/SpellCheckCollation.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/SolrSpellChecker.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="SolrSpellChecker.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 SolrSpellChecker</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.SolrSpellChecker</B>
97</PRE>
98<DL>
99<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html" title="class in org.apache.solr.spelling">AbstractLuceneSpellChecker</A>, <A HREF="../../../../org/apache/solr/spelling/ConjunctionSolrSpellChecker.html" title="class in org.apache.solr.spelling">ConjunctionSolrSpellChecker</A>, <A HREF="../../../../org/apache/solr/spelling/DirectSolrSpellChecker.html" title="class in org.apache.solr.spelling">DirectSolrSpellChecker</A>, <A HREF="../../../../org/apache/solr/spelling/suggest/Suggester.html" title="class in org.apache.solr.spelling.suggest">Suggester</A>, <A HREF="../../../../org/apache/solr/spelling/WordBreakSolrSpellChecker.html" title="class in org.apache.solr.spelling">WordBreakSolrSpellChecker</A></DD>
100</DL>
101<HR>
102<DL>
103<DT><PRE>public abstract class <B>SolrSpellChecker</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>
104</PRE>
105
106<P>
107<p>
108 Refer to <a href="http://wiki.apache.org/solr/SpellCheckComponent">SpellCheckComponent</a>
109 for more details.
110 </p>
111<P>
112
113<P>
114<DL>
115<DT><B>Since:</B></DT>
116  <DD>solr 1.3</DD>
117</DL>
118<HR>
119
120<P>
121<!-- =========== FIELD SUMMARY =========== -->
122
123<A NAME="field_summary"><!-- --></A>
124<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
125<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
126<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
127<B>Field Summary</B></FONT></TH>
128</TR>
129<TR BGCOLOR="white" CLASS="TableRowColor">
130<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
131<CODE>protected &nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Analyzer.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Analyzer</A></CODE></FONT></TD>
132<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#analyzer">analyzer</A></B></CODE>
133
134<BR>
135&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
136</TR>
137<TR BGCOLOR="white" CLASS="TableRowColor">
138<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
139<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>
140<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#DEFAULT_DICTIONARY_NAME">DEFAULT_DICTIONARY_NAME</A></B></CODE>
141
142<BR>
143&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
144</TR>
145<TR BGCOLOR="white" CLASS="TableRowColor">
146<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
147<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>
148<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#DICTIONARY_NAME">DICTIONARY_NAME</A></B></CODE>
149
150<BR>
151&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
152</TR>
153<TR BGCOLOR="white" CLASS="TableRowColor">
154<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
155<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>
156<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#field">field</A></B></CODE>
157
158<BR>
159&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
160</TR>
161<TR BGCOLOR="white" CLASS="TableRowColor">
162<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
163<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>
164<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#FIELD">FIELD</A></B></CODE>
165
166<BR>
167&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
168</TR>
169<TR BGCOLOR="white" CLASS="TableRowColor">
170<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
171<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>
172<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#FIELD_TYPE">FIELD_TYPE</A></B></CODE>
173
174<BR>
175&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
176</TR>
177<TR BGCOLOR="white" CLASS="TableRowColor">
178<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
179<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>
180<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#fieldTypeName">fieldTypeName</A></B></CODE>
181
182<BR>
183&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
184</TR>
185<TR BGCOLOR="white" CLASS="TableRowColor">
186<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
187<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>
188<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#name">name</A></B></CODE>
189
190<BR>
191&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Dictionary name</TD>
192</TR>
193</TABLE>
194&nbsp;
195<!-- ======== CONSTRUCTOR SUMMARY ======== -->
196
197<A NAME="constructor_summary"><!-- --></A>
198<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
199<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
200<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
201<B>Constructor Summary</B></FONT></TH>
202</TR>
203<TR BGCOLOR="white" CLASS="TableRowColor">
204<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#SolrSpellChecker()">SolrSpellChecker</A></B>()</CODE>
205
206<BR>
207&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
208</TR>
209</TABLE>
210&nbsp;
211<!-- ========== METHOD SUMMARY =========== -->
212
213<A NAME="method_summary"><!-- --></A>
214<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
215<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
216<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
217<B>Method Summary</B></FONT></TH>
218</TR>
219<TR BGCOLOR="white" CLASS="TableRowColor">
220<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
221<CODE>abstract &nbsp;void</CODE></FONT></TD>
222<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#build(org.apache.solr.core.SolrCore, org.apache.solr.search.SolrIndexSearcher)">build</A></B>(<A HREF="../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</A>&nbsp;core,
223      <A HREF="../../../../org/apache/solr/search/SolrIndexSearcher.html" title="class in org.apache.solr.search">SolrIndexSearcher</A>&nbsp;searcher)</CODE>
224
225<BR>
226&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(re)Builds the spelling index.</TD>
227</TR>
228<TR BGCOLOR="white" CLASS="TableRowColor">
229<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
230<CODE>protected &nbsp;float</CODE></FONT></TD>
231<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#getAccuracy()">getAccuracy</A></B>()</CODE>
232
233<BR>
234&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>
235</TR>
236<TR BGCOLOR="white" CLASS="TableRowColor">
237<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
238<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>
239<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#getDictionaryName()">getDictionaryName</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>&nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Analyzer.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Analyzer</A></CODE></FONT></TD>
247<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#getQueryAnalyzer()">getQueryAnalyzer</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/StringDistance.html?is-external=true" title="class or interface in org.apache.lucene.search.spell">StringDistance</A></CODE></FONT></TD>
255<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#getStringDistance()">getStringDistance</A></B>()</CODE>
256
257<BR>
258&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the distance implementation used by this spellchecker, or NULL if not applicable.</TD>
259</TR>
260<TR BGCOLOR="white" CLASS="TableRowColor">
261<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
262<CODE>abstract &nbsp;<A HREF="../../../../org/apache/solr/spelling/SpellingResult.html" title="class in org.apache.solr.spelling">SpellingResult</A></CODE></FONT></TD>
263<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.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>
264
265<BR>
266&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get suggestions for the given query.</TD>
267</TR>
268<TR BGCOLOR="white" CLASS="TableRowColor">
269<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
270<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>
271<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.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,
272     <A HREF="../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</A>&nbsp;core)</CODE>
273
274<BR>
275&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
276</TR>
277<TR BGCOLOR="white" CLASS="TableRowColor">
278<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
279<CODE>&nbsp;boolean</CODE></FONT></TD>
280<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#isSuggestionsMayOverlap()">isSuggestionsMayOverlap</A></B>()</CODE>
281
282<BR>
283&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
284</TR>
285<TR BGCOLOR="white" CLASS="TableRowColor">
286<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
287<CODE>&nbsp;<A HREF="../../../../org/apache/solr/spelling/SpellingResult.html" title="class in org.apache.solr.spelling">SpellingResult</A></CODE></FONT></TD>
288<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.html#mergeSuggestions(org.apache.solr.handler.component.SpellCheckMergeData, int, int, boolean)">mergeSuggestions</A></B>(<A HREF="../../../../org/apache/solr/handler/component/SpellCheckMergeData.html" title="class in org.apache.solr.handler.component">SpellCheckMergeData</A>&nbsp;mergeData,
289                 int&nbsp;numSug,
290                 int&nbsp;count,
291                 boolean&nbsp;extendedResults)</CODE>
292
293<BR>
294&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Integrate spelling suggestions from the various shards in a distributed environment.</TD>
295</TR>
296<TR BGCOLOR="white" CLASS="TableRowColor">
297<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
298<CODE>abstract &nbsp;void</CODE></FONT></TD>
299<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/SolrSpellChecker.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,
300       <A HREF="../../../../org/apache/solr/search/SolrIndexSearcher.html" title="class in org.apache.solr.search">SolrIndexSearcher</A>&nbsp;searcher)</CODE>
301
302<BR>
303&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reloads the index.</TD>
304</TR>
305</TABLE>
306&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
307<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
308<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
309<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>
310</TR>
311<TR BGCOLOR="white" CLASS="TableRowColor">
312<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>
313</TR>
314</TABLE>
315&nbsp;
316<P>
317
318<!-- ============ FIELD DETAIL =========== -->
319
320<A NAME="field_detail"><!-- --></A>
321<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
322<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
323<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
324<B>Field Detail</B></FONT></TH>
325</TR>
326</TABLE>
327
328<A NAME="DICTIONARY_NAME"><!-- --></A><H3>
329DICTIONARY_NAME</H3>
330<PRE>
331public 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>DICTIONARY_NAME</B></PRE>
332<DL>
333<DL>
334<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.solr.spelling.SolrSpellChecker.DICTIONARY_NAME">Constant Field Values</A></DL>
335</DL>
336<HR>
337
338<A NAME="DEFAULT_DICTIONARY_NAME"><!-- --></A><H3>
339DEFAULT_DICTIONARY_NAME</H3>
340<PRE>
341public 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>DEFAULT_DICTIONARY_NAME</B></PRE>
342<DL>
343<DL>
344<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.solr.spelling.SolrSpellChecker.DEFAULT_DICTIONARY_NAME">Constant Field Values</A></DL>
345</DL>
346<HR>
347
348<A NAME="FIELD"><!-- --></A><H3>
349FIELD</H3>
350<PRE>
351public 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>
352<DL>
353<DL>
354<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.solr.spelling.SolrSpellChecker.FIELD">Constant Field Values</A></DL>
355</DL>
356<HR>
357
358<A NAME="FIELD_TYPE"><!-- --></A><H3>
359FIELD_TYPE</H3>
360<PRE>
361public 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_TYPE</B></PRE>
362<DL>
363<DL>
364<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.solr.spelling.SolrSpellChecker.FIELD_TYPE">Constant Field Values</A></DL>
365</DL>
366<HR>
367
368<A NAME="name"><!-- --></A><H3>
369name</H3>
370<PRE>
371protected <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>name</B></PRE>
372<DL>
373<DD>Dictionary name
374<P>
375<DL>
376</DL>
377</DL>
378<HR>
379
380<A NAME="analyzer"><!-- --></A><H3>
381analyzer</H3>
382<PRE>
383protected <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Analyzer.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Analyzer</A> <B>analyzer</B></PRE>
384<DL>
385<DL>
386</DL>
387</DL>
388<HR>
389
390<A NAME="field"><!-- --></A><H3>
391field</H3>
392<PRE>
393protected <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>
394<DL>
395<DL>
396</DL>
397</DL>
398<HR>
399
400<A NAME="fieldTypeName"><!-- --></A><H3>
401fieldTypeName</H3>
402<PRE>
403protected <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>fieldTypeName</B></PRE>
404<DL>
405<DL>
406</DL>
407</DL>
408
409<!-- ========= CONSTRUCTOR DETAIL ======== -->
410
411<A NAME="constructor_detail"><!-- --></A>
412<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
413<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
414<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
415<B>Constructor Detail</B></FONT></TH>
416</TR>
417</TABLE>
418
419<A NAME="SolrSpellChecker()"><!-- --></A><H3>
420SolrSpellChecker</H3>
421<PRE>
422public <B>SolrSpellChecker</B>()</PRE>
423<DL>
424</DL>
425
426<!-- ============ METHOD DETAIL ========== -->
427
428<A NAME="method_detail"><!-- --></A>
429<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
430<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
431<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
432<B>Method Detail</B></FONT></TH>
433</TR>
434</TABLE>
435
436<A NAME="init(org.apache.solr.common.util.NamedList, org.apache.solr.core.SolrCore)"><!-- --></A><H3>
437init</H3>
438<PRE>
439public <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,
440                   <A HREF="../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</A>&nbsp;core)</PRE>
441<DL>
442<DD><DL>
443</DL>
444</DD>
445</DL>
446<HR>
447
448<A NAME="mergeSuggestions(org.apache.solr.handler.component.SpellCheckMergeData, int, int, boolean)"><!-- --></A><H3>
449mergeSuggestions</H3>
450<PRE>
451public <A HREF="../../../../org/apache/solr/spelling/SpellingResult.html" title="class in org.apache.solr.spelling">SpellingResult</A> <B>mergeSuggestions</B>(<A HREF="../../../../org/apache/solr/handler/component/SpellCheckMergeData.html" title="class in org.apache.solr.handler.component">SpellCheckMergeData</A>&nbsp;mergeData,
452                                       int&nbsp;numSug,
453                                       int&nbsp;count,
454                                       boolean&nbsp;extendedResults)</PRE>
455<DL>
456<DD>Integrate spelling suggestions from the various shards in a distributed environment.
457<P>
458<DD><DL>
459<DT><B>Parameters:</B><DD><CODE>mergeData</CODE> - <DD><CODE>numSug</CODE> - <DD><CODE>count</CODE> - <DD><CODE>extendedResults</CODE> - </DL>
460</DD>
461</DL>
462<HR>
463
464<A NAME="getQueryAnalyzer()"><!-- --></A><H3>
465getQueryAnalyzer</H3>
466<PRE>
467public <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/Analyzer.html?is-external=true" title="class or interface in org.apache.lucene.analysis">Analyzer</A> <B>getQueryAnalyzer</B>()</PRE>
468<DL>
469<DD><DL>
470</DL>
471</DD>
472</DL>
473<HR>
474
475<A NAME="getDictionaryName()"><!-- --></A><H3>
476getDictionaryName</H3>
477<PRE>
478public <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>getDictionaryName</B>()</PRE>
479<DL>
480<DD><DL>
481</DL>
482</DD>
483</DL>
484<HR>
485
486<A NAME="reload(org.apache.solr.core.SolrCore, org.apache.solr.search.SolrIndexSearcher)"><!-- --></A><H3>
487reload</H3>
488<PRE>
489public abstract void <B>reload</B>(<A HREF="../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</A>&nbsp;core,
490                            <A HREF="../../../../org/apache/solr/search/SolrIndexSearcher.html" title="class in org.apache.solr.search">SolrIndexSearcher</A>&nbsp;searcher)
491                     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>
492<DL>
493<DD>Reloads the index.  Useful if an external process is responsible for building the spell checker.
494<P>
495<DD><DL>
496
497<DT><B>Throws:</B>
498<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>
499</DD>
500</DL>
501<HR>
502
503<A NAME="build(org.apache.solr.core.SolrCore, org.apache.solr.search.SolrIndexSearcher)"><!-- --></A><H3>
504build</H3>
505<PRE>
506public abstract void <B>build</B>(<A HREF="../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</A>&nbsp;core,
507                           <A HREF="../../../../org/apache/solr/search/SolrIndexSearcher.html" title="class in org.apache.solr.search">SolrIndexSearcher</A>&nbsp;searcher)</PRE>
508<DL>
509<DD>(re)Builds the spelling index.  May be a NOOP if the implementation doesn't require building, or can't be rebuilt.
510<P>
511<DD><DL>
512</DL>
513</DD>
514</DL>
515<HR>
516
517<A NAME="getAccuracy()"><!-- --></A><H3>
518getAccuracy</H3>
519<PRE>
520protected float <B>getAccuracy</B>()</PRE>
521<DL>
522<DD>Get the value of <A HREF="../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_ACCURACY"><CODE>SpellingParams.SPELLCHECK_ACCURACY</CODE></A> if supported. 
523 Otherwise throws UnsupportedOperationException.
524<P>
525<DD><DL>
526</DL>
527</DD>
528</DL>
529<HR>
530
531<A NAME="getStringDistance()"><!-- --></A><H3>
532getStringDistance</H3>
533<PRE>
534protected <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>
535<DL>
536<DD>Get the distance implementation used by this spellchecker, or NULL if not applicable.
537<P>
538<DD><DL>
539</DL>
540</DD>
541</DL>
542<HR>
543
544<A NAME="getSuggestions(org.apache.solr.spelling.SpellingOptions)"><!-- --></A><H3>
545getSuggestions</H3>
546<PRE>
547public abstract <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)
548                                       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>
549<DL>
550<DD>Get suggestions for the given query.  Tokenizes the query using a field appropriate Analyzer.
551 The <A HREF="../../../../org/apache/solr/spelling/SpellingResult.html#getSuggestions()"><CODE>SpellingResult.getSuggestions()</CODE></A> suggestions must be ordered by best suggestion first.
552 <p/>
553<P>
554<DD><DL>
555<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
556<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
557<DT><B>Throws:</B>
558<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>
559</DD>
560</DL>
561<HR>
562
563<A NAME="isSuggestionsMayOverlap()"><!-- --></A><H3>
564isSuggestionsMayOverlap</H3>
565<PRE>
566public boolean <B>isSuggestionsMayOverlap</B>()</PRE>
567<DL>
568<DD><DL>
569</DL>
570</DD>
571</DL>
572<!-- ========= END OF CLASS DATA ========= -->
573<HR>
574
575
576<!-- ======= START OF BOTTOM NAVBAR ====== -->
577<A NAME="navbar_bottom"><!-- --></A>
578<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
579<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
580<TR>
581<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
582<A NAME="navbar_bottom_firstrow"><!-- --></A>
583<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
584  <TR ALIGN="center" VALIGN="top">
585  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
586  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
587  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
588  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/SolrSpellChecker.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
589  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
590  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
591  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
592  </TR>
593</TABLE>
594</TD>
595<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
596</EM>
597</TD>
598</TR>
599
600<TR>
601<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
602&nbsp;<A HREF="../../../../org/apache/solr/spelling/ResultEntry.html" title="class in org.apache.solr.spelling"><B>PREV CLASS</B></A>&nbsp;
603&nbsp;<A HREF="../../../../org/apache/solr/spelling/SpellCheckCollation.html" title="class in org.apache.solr.spelling"><B>NEXT CLASS</B></A></FONT></TD>
604<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
605  <A HREF="../../../../index.html?org/apache/solr/spelling/SolrSpellChecker.html" target="_top"><B>FRAMES</B></A>  &nbsp;
606&nbsp;<A HREF="SolrSpellChecker.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
607&nbsp;<SCRIPT type="text/javascript">
608  <!--
609  if(window==top) {
610    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
611  }
612  //-->
613</SCRIPT>
614<NOSCRIPT>
615  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
616</NOSCRIPT>
617
618
619</FONT></TD>
620</TR>
621<TR>
622<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
623  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>
624<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
625DETAIL:&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>
626</TR>
627</TABLE>
628<A NAME="skip-navbar_bottom"></A>
629<!-- ======== END OF BOTTOM NAVBAR ======= -->
630
631<HR>
632
633          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
634          <script src='../../../../prettify.js' type='text/javascript'></script>
635          <script type='text/javascript'>
636            (function(){
637              var oldonload = window.onload;
638              if (typeof oldonload != 'function') {
639                window.onload = prettyPrint;
640              } else {
641                window.onload = function() {
642                  oldonload();
643                  prettyPrint();
644                }
645              }
646            })();
647          </script>
648       
649</BODY>
650</HTML>
Note: See TracBrowser for help on using the repository browser.