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

Revision 7588, 27.5 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>
8FileBasedSpellChecker (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="FileBasedSpellChecker (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/FileBasedSpellChecker.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/DirectSolrSpellChecker.html" title="class in org.apache.solr.spelling"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../org/apache/solr/spelling/IndexBasedSpellChecker.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/FileBasedSpellChecker.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="FileBasedSpellChecker.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 FileBasedSpellChecker</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 "><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html" title="class in org.apache.solr.spelling">org.apache.solr.spelling.AbstractLuceneSpellChecker</A>
98          <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.solr.spelling.FileBasedSpellChecker</B>
99</PRE>
100<HR>
101<DL>
102<DT><PRE>public class <B>FileBasedSpellChecker</B><DT>extends <A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html" title="class in org.apache.solr.spelling">AbstractLuceneSpellChecker</A></DL>
103</PRE>
104
105<P>
106<p>
107 A spell checker implementation that loads words from a text file (one word per line).
108 </p>
109<P>
110
111<P>
112<DL>
113<DT><B>Since:</B></DT>
114  <DD>solr 1.3</DD>
115</DL>
116<HR>
117
118<P>
119<!-- =========== FIELD SUMMARY =========== -->
120
121<A NAME="field_summary"><!-- --></A>
122<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
123<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
124<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
125<B>Field Summary</B></FONT></TH>
126</TR>
127<TR BGCOLOR="white" CLASS="TableRowColor">
128<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
129<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>
130<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/FileBasedSpellChecker.html#SOURCE_FILE_CHAR_ENCODING">SOURCE_FILE_CHAR_ENCODING</A></B></CODE>
131
132<BR>
133&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
134</TR>
135<TR BGCOLOR="white" CLASS="TableRowColor">
136<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
137<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>
138<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/FileBasedSpellChecker.html#WORD_FIELD_NAME">WORD_FIELD_NAME</A></B></CODE>
139
140<BR>
141&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
142</TR>
143</TABLE>
144&nbsp;<A NAME="fields_inherited_from_class_org.apache.solr.spelling.AbstractLuceneSpellChecker"><!-- --></A>
145<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
146<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
147<TH ALIGN="left"><B>Fields inherited from class org.apache.solr.spelling.<A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html" title="class in org.apache.solr.spelling">AbstractLuceneSpellChecker</A></B></TH>
148</TR>
149<TR BGCOLOR="white" CLASS="TableRowColor">
150<TD><CODE><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#accuracy">accuracy</A>, <A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#ACCURACY">ACCURACY</A>, <A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#COMPARATOR_CLASS">COMPARATOR_CLASS</A>, <A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#DEFAULT_SUGGESTION_COUNT">DEFAULT_SUGGESTION_COUNT</A>, <A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#dictionary">dictionary</A>, <A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#FIELD">FIELD</A>, <A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#FREQ_COMP">FREQ_COMP</A>, <A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#index">index</A>, <A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#INDEX_DIR">INDEX_DIR</A>, <A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#indexDir">indexDir</A>, <A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#LOCATION">LOCATION</A>, <A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#SCORE_COMP">SCORE_COMP</A>, <A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#sd">sd</A>, <A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#sourceLocation">sourceLocation</A>, <A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#spellChecker">spellChecker</A>, <A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#SPELLCHECKER_ARG_NAME">SPELLCHECKER_ARG_NAME</A>, <A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#STRING_DISTANCE">STRING_DISTANCE</A></CODE></TD>
151</TR>
152</TABLE>
153&nbsp;<A NAME="fields_inherited_from_class_org.apache.solr.spelling.SolrSpellChecker"><!-- --></A>
154<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
155<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
156<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>
157</TR>
158<TR BGCOLOR="white" CLASS="TableRowColor">
159<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>
160</TR>
161</TABLE>
162&nbsp;
163<!-- ======== CONSTRUCTOR SUMMARY ======== -->
164
165<A NAME="constructor_summary"><!-- --></A>
166<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
167<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
168<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
169<B>Constructor Summary</B></FONT></TH>
170</TR>
171<TR BGCOLOR="white" CLASS="TableRowColor">
172<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/FileBasedSpellChecker.html#FileBasedSpellChecker()">FileBasedSpellChecker</A></B>()</CODE>
173
174<BR>
175&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
176</TR>
177</TABLE>
178&nbsp;
179<!-- ========== METHOD SUMMARY =========== -->
180
181<A NAME="method_summary"><!-- --></A>
182<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
183<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
184<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
185<B>Method Summary</B></FONT></TH>
186</TR>
187<TR BGCOLOR="white" CLASS="TableRowColor">
188<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
189<CODE>&nbsp;void</CODE></FONT></TD>
190<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/FileBasedSpellChecker.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,
191      <A HREF="../../../../org/apache/solr/search/SolrIndexSearcher.html" title="class in org.apache.solr.search">SolrIndexSearcher</A>&nbsp;searcher)</CODE>
192
193<BR>
194&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(re)Builds the spelling index.</TD>
195</TR>
196<TR BGCOLOR="white" CLASS="TableRowColor">
197<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
198<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>
199<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/FileBasedSpellChecker.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>
200
201<BR>
202&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Override to return null, since there is no reader associated with a file based index</TD>
203</TR>
204<TR BGCOLOR="white" CLASS="TableRowColor">
205<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
206<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>
207<TD><CODE><B><A HREF="../../../../org/apache/solr/spelling/FileBasedSpellChecker.html#getCharacterEncoding()">getCharacterEncoding</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>&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/FileBasedSpellChecker.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,
216     <A HREF="../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</A>&nbsp;core)</CODE>
217
218<BR>
219&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
220</TR>
221</TABLE>
222&nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.spelling.AbstractLuceneSpellChecker"><!-- --></A>
223<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
224<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
225<TH ALIGN="left"><B>Methods inherited from class org.apache.solr.spelling.<A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html" title="class in org.apache.solr.spelling">AbstractLuceneSpellChecker</A></B></TH>
226</TR>
227<TR BGCOLOR="white" CLASS="TableRowColor">
228<TD><CODE><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#getAccuracy()">getAccuracy</A>, <A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#getField()">getField</A>, <A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#getFieldTypeName()">getFieldTypeName</A>, <A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#getIndexDir()">getIndexDir</A>, <A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#getSourceLocation()">getSourceLocation</A>, <A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#getSpellChecker()">getSpellChecker</A>, <A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#getStringDistance()">getStringDistance</A>, <A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#getSuggestions(org.apache.solr.spelling.SpellingOptions)">getSuggestions</A>, <A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#initIndex()">initIndex</A>, <A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#reload(org.apache.solr.core.SolrCore, org.apache.solr.search.SolrIndexSearcher)">reload</A></CODE></TD>
229</TR>
230</TABLE>
231&nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.spelling.SolrSpellChecker"><!-- --></A>
232<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
233<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
234<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>
235</TR>
236<TR BGCOLOR="white" CLASS="TableRowColor">
237<TD><CODE><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>
238</TR>
239</TABLE>
240&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
241<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
242<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
243<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>
244</TR>
245<TR BGCOLOR="white" CLASS="TableRowColor">
246<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>
247</TR>
248</TABLE>
249&nbsp;
250<P>
251
252<!-- ============ FIELD DETAIL =========== -->
253
254<A NAME="field_detail"><!-- --></A>
255<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
256<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
257<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
258<B>Field Detail</B></FONT></TH>
259</TR>
260</TABLE>
261
262<A NAME="SOURCE_FILE_CHAR_ENCODING"><!-- --></A><H3>
263SOURCE_FILE_CHAR_ENCODING</H3>
264<PRE>
265public 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>SOURCE_FILE_CHAR_ENCODING</B></PRE>
266<DL>
267<DL>
268<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.solr.spelling.FileBasedSpellChecker.SOURCE_FILE_CHAR_ENCODING">Constant Field Values</A></DL>
269</DL>
270<HR>
271
272<A NAME="WORD_FIELD_NAME"><!-- --></A><H3>
273WORD_FIELD_NAME</H3>
274<PRE>
275public 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>WORD_FIELD_NAME</B></PRE>
276<DL>
277<DL>
278<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.solr.spelling.FileBasedSpellChecker.WORD_FIELD_NAME">Constant Field Values</A></DL>
279</DL>
280
281<!-- ========= CONSTRUCTOR DETAIL ======== -->
282
283<A NAME="constructor_detail"><!-- --></A>
284<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
285<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
286<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
287<B>Constructor Detail</B></FONT></TH>
288</TR>
289</TABLE>
290
291<A NAME="FileBasedSpellChecker()"><!-- --></A><H3>
292FileBasedSpellChecker</H3>
293<PRE>
294public <B>FileBasedSpellChecker</B>()</PRE>
295<DL>
296</DL>
297
298<!-- ============ METHOD DETAIL ========== -->
299
300<A NAME="method_detail"><!-- --></A>
301<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
302<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
303<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
304<B>Method Detail</B></FONT></TH>
305</TR>
306</TABLE>
307
308<A NAME="init(org.apache.solr.common.util.NamedList, org.apache.solr.core.SolrCore)"><!-- --></A><H3>
309init</H3>
310<PRE>
311public <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,
312                   <A HREF="../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</A>&nbsp;core)</PRE>
313<DL>
314<DD><DL>
315<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.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/AbstractLuceneSpellChecker.html" title="class in org.apache.solr.spelling">AbstractLuceneSpellChecker</A></CODE></DL>
316</DD>
317<DD><DL>
318</DL>
319</DD>
320</DL>
321<HR>
322
323<A NAME="build(org.apache.solr.core.SolrCore, org.apache.solr.search.SolrIndexSearcher)"><!-- --></A><H3>
324build</H3>
325<PRE>
326public void <B>build</B>(<A HREF="../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</A>&nbsp;core,
327                  <A HREF="../../../../org/apache/solr/search/SolrIndexSearcher.html" title="class in org.apache.solr.search">SolrIndexSearcher</A>&nbsp;searcher)</PRE>
328<DL>
329<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>
330<DD>(re)Builds the spelling index.  May be a NOOP if the implementation doesn't require building, or can't be rebuilt.
331<P>
332<DD><DL>
333<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>
334</DD>
335<DD><DL>
336</DL>
337</DD>
338</DL>
339<HR>
340
341<A NAME="determineReader(org.apache.lucene.index.IndexReader)"><!-- --></A><H3>
342determineReader</H3>
343<PRE>
344protected <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>
345<DL>
346<DD>Override to return null, since there is no reader associated with a file based index
347<P>
348<DD><DL>
349<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html#determineReader(org.apache.lucene.index.IndexReader)">determineReader</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/spelling/AbstractLuceneSpellChecker.html" title="class in org.apache.solr.spelling">AbstractLuceneSpellChecker</A></CODE></DL>
350</DD>
351<DD><DL>
352</DL>
353</DD>
354</DL>
355<HR>
356
357<A NAME="getCharacterEncoding()"><!-- --></A><H3>
358getCharacterEncoding</H3>
359<PRE>
360public <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>getCharacterEncoding</B>()</PRE>
361<DL>
362<DD><DL>
363</DL>
364</DD>
365</DL>
366<!-- ========= END OF CLASS DATA ========= -->
367<HR>
368
369
370<!-- ======= START OF BOTTOM NAVBAR ====== -->
371<A NAME="navbar_bottom"><!-- --></A>
372<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
373<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
374<TR>
375<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
376<A NAME="navbar_bottom_firstrow"><!-- --></A>
377<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
378  <TR ALIGN="center" VALIGN="top">
379  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
380  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
381  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
382  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/FileBasedSpellChecker.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
383  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
384  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
385  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
386  </TR>
387</TABLE>
388</TD>
389<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
390</EM>
391</TD>
392</TR>
393
394<TR>
395<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
396&nbsp;<A HREF="../../../../org/apache/solr/spelling/DirectSolrSpellChecker.html" title="class in org.apache.solr.spelling"><B>PREV CLASS</B></A>&nbsp;
397&nbsp;<A HREF="../../../../org/apache/solr/spelling/IndexBasedSpellChecker.html" title="class in org.apache.solr.spelling"><B>NEXT CLASS</B></A></FONT></TD>
398<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
399  <A HREF="../../../../index.html?org/apache/solr/spelling/FileBasedSpellChecker.html" target="_top"><B>FRAMES</B></A>  &nbsp;
400&nbsp;<A HREF="FileBasedSpellChecker.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
401&nbsp;<SCRIPT type="text/javascript">
402  <!--
403  if(window==top) {
404    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
405  }
406  //-->
407</SCRIPT>
408<NOSCRIPT>
409  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
410</NOSCRIPT>
411
412
413</FONT></TD>
414</TR>
415<TR>
416<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
417  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>
418<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
419DETAIL:&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>
420</TR>
421</TABLE>
422<A NAME="skip-navbar_bottom"></A>
423<!-- ======== END OF BOTTOM NAVBAR ======= -->
424
425<HR>
426
427          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
428          <script src='../../../../prettify.js' type='text/javascript'></script>
429          <script type='text/javascript'>
430            (function(){
431              var oldonload = window.onload;
432              if (typeof oldonload != 'function') {
433                window.onload = prettyPrint;
434              } else {
435                window.onload = function() {
436                  oldonload();
437                  prettyPrint();
438                }
439              }
440            })();
441          </script>
442       
443</BODY>
444</HTML>
Note: See TracBrowser for help on using the repository browser.