source: sandbox/expresso-solr/solr/docs/api/org/apache/solr/client/solrj/response/SpellCheckResponse.html @ 7588

Revision 7588, 22.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:26 EDT 2012 -->
6<META http-equiv="Content-Type" content="text/html; charset=utf-8">
7<TITLE>
8SpellCheckResponse (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="SpellCheckResponse (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/SpellCheckResponse.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/client/solrj/response/SolrResponseBase.html" title="class in org.apache.solr.client.solrj.response"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../../../org/apache/solr/client/solrj/response/SpellCheckResponse.Collation.html" title="class in org.apache.solr.client.solrj.response"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../../../index.html?org/apache/solr/client/solrj/response/SpellCheckResponse.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="SpellCheckResponse.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;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&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;FIELD&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.client.solrj.response</FONT>
92<BR>
93Class SpellCheckResponse</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.client.solrj.response.SpellCheckResponse</B>
97</PRE>
98<HR>
99<DL>
100<DT><PRE>public class <B>SpellCheckResponse</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>
104Encapsulates responses from SpellCheckComponent
105<P>
106
107<P>
108<DL>
109<DT><B>Since:</B></DT>
110  <DD>solr 1.3</DD>
111</DL>
112<HR>
113
114<P>
115<!-- ======== NESTED CLASS SUMMARY ======== -->
116
117<A NAME="nested_class_summary"><!-- --></A>
118<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
119<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
120<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
121<B>Nested Class Summary</B></FONT></TH>
122</TR>
123<TR BGCOLOR="white" CLASS="TableRowColor">
124<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
125<CODE>&nbsp;class</CODE></FONT></TD>
126<TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/response/SpellCheckResponse.Collation.html" title="class in org.apache.solr.client.solrj.response">SpellCheckResponse.Collation</A></B></CODE>
127
128<BR>
129&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
130</TR>
131<TR BGCOLOR="white" CLASS="TableRowColor">
132<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
133<CODE>&nbsp;class</CODE></FONT></TD>
134<TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/response/SpellCheckResponse.Correction.html" title="class in org.apache.solr.client.solrj.response">SpellCheckResponse.Correction</A></B></CODE>
135
136<BR>
137&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
138</TR>
139<TR BGCOLOR="white" CLASS="TableRowColor">
140<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
141<CODE>static&nbsp;class</CODE></FONT></TD>
142<TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/response/SpellCheckResponse.Suggestion.html" title="class in org.apache.solr.client.solrj.response">SpellCheckResponse.Suggestion</A></B></CODE>
143
144<BR>
145&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
146</TR>
147</TABLE>
148&nbsp;
149<!-- ======== CONSTRUCTOR SUMMARY ======== -->
150
151<A NAME="constructor_summary"><!-- --></A>
152<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
153<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
154<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
155<B>Constructor Summary</B></FONT></TH>
156</TR>
157<TR BGCOLOR="white" CLASS="TableRowColor">
158<TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/response/SpellCheckResponse.html#SpellCheckResponse(org.apache.solr.common.util.NamedList)">SpellCheckResponse</A></B>(<A HREF="../../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&lt;<A HREF="../../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&lt;<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>&gt;&gt;&nbsp;spellInfo)</CODE>
159
160<BR>
161&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
162</TR>
163</TABLE>
164&nbsp;
165<!-- ========== METHOD SUMMARY =========== -->
166
167<A NAME="method_summary"><!-- --></A>
168<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
169<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
170<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
171<B>Method Summary</B></FONT></TH>
172</TR>
173<TR BGCOLOR="white" CLASS="TableRowColor">
174<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
175<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>
176<TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/response/SpellCheckResponse.html#getCollatedResult()">getCollatedResult</A></B>()</CODE>
177
178<BR>
179&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
180  Return the first collated query string.</TD>
181</TR>
182<TR BGCOLOR="white" CLASS="TableRowColor">
183<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
184<CODE>&nbsp;<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="../../../../../../org/apache/solr/client/solrj/response/SpellCheckResponse.Collation.html" title="class in org.apache.solr.client.solrj.response">SpellCheckResponse.Collation</A>&gt;</CODE></FONT></TD>
185<TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/response/SpellCheckResponse.html#getCollatedResults()">getCollatedResults</A></B>()</CODE>
186
187<BR>
188&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
189  Return all collations.</TD>
190</TR>
191<TR BGCOLOR="white" CLASS="TableRowColor">
192<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
193<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>
194<TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/response/SpellCheckResponse.html#getFirstSuggestion(java.lang.String)">getFirstSuggestion</A></B>(<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;token)</CODE>
195
196<BR>
197&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
198</TR>
199<TR BGCOLOR="white" CLASS="TableRowColor">
200<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
201<CODE>&nbsp;<A HREF="../../../../../../org/apache/solr/client/solrj/response/SpellCheckResponse.Suggestion.html" title="class in org.apache.solr.client.solrj.response">SpellCheckResponse.Suggestion</A></CODE></FONT></TD>
202<TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/response/SpellCheckResponse.html#getSuggestion(java.lang.String)">getSuggestion</A></B>(<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;token)</CODE>
203
204<BR>
205&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
206</TR>
207<TR BGCOLOR="white" CLASS="TableRowColor">
208<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
209<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://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="../../../../../../org/apache/solr/client/solrj/response/SpellCheckResponse.Suggestion.html" title="class in org.apache.solr.client.solrj.response">SpellCheckResponse.Suggestion</A>&gt;</CODE></FONT></TD>
210<TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/response/SpellCheckResponse.html#getSuggestionMap()">getSuggestionMap</A></B>()</CODE>
211
212<BR>
213&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
214</TR>
215<TR BGCOLOR="white" CLASS="TableRowColor">
216<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
217<CODE>&nbsp;<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="../../../../../../org/apache/solr/client/solrj/response/SpellCheckResponse.Suggestion.html" title="class in org.apache.solr.client.solrj.response">SpellCheckResponse.Suggestion</A>&gt;</CODE></FONT></TD>
218<TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/response/SpellCheckResponse.html#getSuggestions()">getSuggestions</A></B>()</CODE>
219
220<BR>
221&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
222</TR>
223<TR BGCOLOR="white" CLASS="TableRowColor">
224<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
225<CODE>&nbsp;boolean</CODE></FONT></TD>
226<TD><CODE><B><A HREF="../../../../../../org/apache/solr/client/solrj/response/SpellCheckResponse.html#isCorrectlySpelled()">isCorrectlySpelled</A></B>()</CODE>
227
228<BR>
229&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
230</TR>
231</TABLE>
232&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
233<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
234<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
235<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>
236</TR>
237<TR BGCOLOR="white" CLASS="TableRowColor">
238<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>
239</TR>
240</TABLE>
241&nbsp;
242<P>
243
244<!-- ========= CONSTRUCTOR DETAIL ======== -->
245
246<A NAME="constructor_detail"><!-- --></A>
247<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
248<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
249<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
250<B>Constructor Detail</B></FONT></TH>
251</TR>
252</TABLE>
253
254<A NAME="SpellCheckResponse(org.apache.solr.common.util.NamedList)"><!-- --></A><H3>
255SpellCheckResponse</H3>
256<PRE>
257public <B>SpellCheckResponse</B>(<A HREF="../../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&lt;<A HREF="../../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&lt;<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>&gt;&gt;&nbsp;spellInfo)</PRE>
258<DL>
259</DL>
260
261<!-- ============ METHOD DETAIL ========== -->
262
263<A NAME="method_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>Method Detail</B></FONT></TH>
268</TR>
269</TABLE>
270
271<A NAME="isCorrectlySpelled()"><!-- --></A><H3>
272isCorrectlySpelled</H3>
273<PRE>
274public boolean <B>isCorrectlySpelled</B>()</PRE>
275<DL>
276<DD><DL>
277</DL>
278</DD>
279</DL>
280<HR>
281
282<A NAME="getSuggestions()"><!-- --></A><H3>
283getSuggestions</H3>
284<PRE>
285public <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="../../../../../../org/apache/solr/client/solrj/response/SpellCheckResponse.Suggestion.html" title="class in org.apache.solr.client.solrj.response">SpellCheckResponse.Suggestion</A>&gt; <B>getSuggestions</B>()</PRE>
286<DL>
287<DD><DL>
288</DL>
289</DD>
290</DL>
291<HR>
292
293<A NAME="getSuggestionMap()"><!-- --></A><H3>
294getSuggestionMap</H3>
295<PRE>
296public <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://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="../../../../../../org/apache/solr/client/solrj/response/SpellCheckResponse.Suggestion.html" title="class in org.apache.solr.client.solrj.response">SpellCheckResponse.Suggestion</A>&gt; <B>getSuggestionMap</B>()</PRE>
297<DL>
298<DD><DL>
299</DL>
300</DD>
301</DL>
302<HR>
303
304<A NAME="getSuggestion(java.lang.String)"><!-- --></A><H3>
305getSuggestion</H3>
306<PRE>
307public <A HREF="../../../../../../org/apache/solr/client/solrj/response/SpellCheckResponse.Suggestion.html" title="class in org.apache.solr.client.solrj.response">SpellCheckResponse.Suggestion</A> <B>getSuggestion</B>(<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;token)</PRE>
308<DL>
309<DD><DL>
310</DL>
311</DD>
312</DL>
313<HR>
314
315<A NAME="getFirstSuggestion(java.lang.String)"><!-- --></A><H3>
316getFirstSuggestion</H3>
317<PRE>
318public <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>getFirstSuggestion</B>(<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;token)</PRE>
319<DL>
320<DD><DL>
321</DL>
322</DD>
323</DL>
324<HR>
325
326<A NAME="getCollatedResult()"><!-- --></A><H3>
327getCollatedResult</H3>
328<PRE>
329public <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>getCollatedResult</B>()</PRE>
330<DL>
331<DD><p>
332  Return the first collated query string.  For convenience and backwards-compatibility.  Use getCollatedResults() for full data.
333 </p>
334<P>
335<DD><DL>
336
337<DT><B>Returns:</B><DD>first collated query string</DL>
338</DD>
339</DL>
340<HR>
341
342<A NAME="getCollatedResults()"><!-- --></A><H3>
343getCollatedResults</H3>
344<PRE>
345public <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="../../../../../../org/apache/solr/client/solrj/response/SpellCheckResponse.Collation.html" title="class in org.apache.solr.client.solrj.response">SpellCheckResponse.Collation</A>&gt; <B>getCollatedResults</B>()</PRE>
346<DL>
347<DD><p>
348  Return all collations. 
349  Will include # of hits and misspelling-to-correction details if "spellcheck.collateExtendedResults was true.
350 </p>
351<P>
352<DD><DL>
353
354<DT><B>Returns:</B><DD>all collations</DL>
355</DD>
356</DL>
357<!-- ========= END OF CLASS DATA ========= -->
358<HR>
359
360
361<!-- ======= START OF BOTTOM NAVBAR ====== -->
362<A NAME="navbar_bottom"><!-- --></A>
363<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
364<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
365<TR>
366<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
367<A NAME="navbar_bottom_firstrow"><!-- --></A>
368<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
369  <TR ALIGN="center" VALIGN="top">
370  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
371  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
372  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
373  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/SpellCheckResponse.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
374  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
375  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
376  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
377  </TR>
378</TABLE>
379</TD>
380<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
381</EM>
382</TD>
383</TR>
384
385<TR>
386<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
387&nbsp;<A HREF="../../../../../../org/apache/solr/client/solrj/response/SolrResponseBase.html" title="class in org.apache.solr.client.solrj.response"><B>PREV CLASS</B></A>&nbsp;
388&nbsp;<A HREF="../../../../../../org/apache/solr/client/solrj/response/SpellCheckResponse.Collation.html" title="class in org.apache.solr.client.solrj.response"><B>NEXT CLASS</B></A></FONT></TD>
389<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
390  <A HREF="../../../../../../index.html?org/apache/solr/client/solrj/response/SpellCheckResponse.html" target="_top"><B>FRAMES</B></A>  &nbsp;
391&nbsp;<A HREF="SpellCheckResponse.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
392&nbsp;<SCRIPT type="text/javascript">
393  <!--
394  if(window==top) {
395    document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
396  }
397  //-->
398</SCRIPT>
399<NOSCRIPT>
400  <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
401</NOSCRIPT>
402
403
404</FONT></TD>
405</TR>
406<TR>
407<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
408  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
409<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
410DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
411</TR>
412</TABLE>
413<A NAME="skip-navbar_bottom"></A>
414<!-- ======== END OF BOTTOM NAVBAR ======= -->
415
416<HR>
417
418          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
419          <script src='../../../../../../prettify.js' type='text/javascript'></script>
420          <script type='text/javascript'>
421            (function(){
422              var oldonload = window.onload;
423              if (typeof oldonload != 'function') {
424                window.onload = prettyPrint;
425              } else {
426                window.onload = function() {
427                  oldonload();
428                  prettyPrint();
429                }
430              }
431            })();
432          </script>
433       
434</BODY>
435</HTML>
Note: See TracBrowser for help on using the repository browser.