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

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