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

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