Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Annotate
Revision Log

SpellingParams.html @ 7588

Revision 7588, 30.1 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:30 EDT 2012 -->
6	<META http-equiv="Content-Type" content="text/html; charset=utf-8">
7	<TITLE>
8	SpellingParams (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">
16	function windowTitle()
17	{
18	if (location.href.indexOf('is-external=true') == -1) {
19	parent.document.title="SpellingParams (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> </TD>
42	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
43	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
44	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SpellingParams.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
45	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
46	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
47	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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	<A HREF="../../../../../org/apache/solr/common/params/SpatialParams.html" title="interface in org.apache.solr.common.params"><B>PREV CLASS</B></A>
59	<A HREF="../../../../../org/apache/solr/common/params/StatsParams.html" title="interface in org.apache.solr.common.params"><B>NEXT CLASS</B></A></FONT></TD>
60	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61	<A HREF="../../../../../index.html?org/apache/solr/common/params/SpellingParams.html" target="_top"><B>FRAMES</B></A>
62	<A HREF="SpellingParams.html" target="_top"><B>NO FRAMES</B></A>
63	<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: NESTED \| <A HREF="#field_summary">FIELD</A> \| CONSTR \| METHOD</FONT></TD>
80	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81	DETAIL: <A HREF="#field_detail">FIELD</A> \| CONSTR \| METHOD</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">
91	org.apache.solr.common.params</FONT>
92	<BR>
93	Interface SpellingParams</H2>
94	<HR>
95	<DL>
96	<DT><PRE>public interface <B>SpellingParams</B></DL>
97	</PRE>
98
99	<P>
100	Parameters used for spellchecking
101	<P>
102
103	<P>
104	<DL>
105	<DT><B>Since:</B></DT>
106	<DD>solr 1.3</DD>
107	</DL>
108	<HR>
109
110	<P>
111	<!-- =========== FIELD SUMMARY =========== -->
112
113	<A NAME="field_summary"><!-- --></A>
114	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
115	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
116	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
117	<B>Field Summary</B></FONT></TH>
118	</TR>
119	<TR BGCOLOR="white" CLASS="TableRowColor">
120	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
121	<CODE>static <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>
122	<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_ACCURACY">SPELLCHECK_ACCURACY</A></B></CODE>
123
124	<BR>
125	Certain spelling implementations may allow for an accuracy setting.</TD>
126	</TR>
127	<TR BGCOLOR="white" CLASS="TableRowColor">
128	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
129	<CODE>static <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/common/params/SpellingParams.html#SPELLCHECK_ALTERNATIVE_TERM_COUNT">SPELLCHECK_ALTERNATIVE_TERM_COUNT</A></B></CODE>
131
132	<BR>
133	The count of suggestions to return for each query term existing in the index and/or dictionary.</TD>
134	</TR>
135	<TR BGCOLOR="white" CLASS="TableRowColor">
136	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
137	<CODE>static <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/common/params/SpellingParams.html#SPELLCHECK_BUILD">SPELLCHECK_BUILD</A></B></CODE>
139
140	<BR>
141	Whether to build the index or not.</TD>
142	</TR>
143	<TR BGCOLOR="white" CLASS="TableRowColor">
144	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
145	<CODE>static <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>
146	<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_COLLATE">SPELLCHECK_COLLATE</A></B></CODE>
147
148	<BR>
149	Take the top suggestion for each token and create a new query from it</TD>
150	</TR>
151	<TR BGCOLOR="white" CLASS="TableRowColor">
152	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
153	<CODE>static <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>
154	<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_COLLATE_EXTENDED_RESULTS">SPELLCHECK_COLLATE_EXTENDED_RESULTS</A></B></CODE>
155
156	<BR>
157
158	Whether to use the Extended Results Format for collations.</TD>
159	</TR>
160	<TR BGCOLOR="white" CLASS="TableRowColor">
161	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
162	<CODE>static <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>
163	<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_COLLATE_PARAM_OVERRIDE">SPELLCHECK_COLLATE_PARAM_OVERRIDE</A></B></CODE>
164
165	<BR>
166
167	For use with <A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_MAX_COLLATION_TRIES"><CODE>SPELLCHECK_MAX_COLLATION_TRIES</CODE></A>, use this to override any original query parameters
168	when issuing test queries.</TD>
169	</TR>
170	<TR BGCOLOR="white" CLASS="TableRowColor">
171	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
172	<CODE>static <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>
173	<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_COUNT">SPELLCHECK_COUNT</A></B></CODE>
174
175	<BR>
176	The count of suggestions to return for each query term not in the index and/or dictionary.</TD>
177	</TR>
178	<TR BGCOLOR="white" CLASS="TableRowColor">
179	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
180	<CODE>static <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>
181	<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_DICT">SPELLCHECK_DICT</A></B></CODE>
182
183	<BR>
184	The name of the dictionary to be used for giving the suggestion for a
185	request.</TD>
186	</TR>
187	<TR BGCOLOR="white" CLASS="TableRowColor">
188	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
189	<CODE>static <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>
190	<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_EXTENDED_RESULTS">SPELLCHECK_EXTENDED_RESULTS</A></B></CODE>
191
192	<BR>
193	Whether to use the extended response format, which is more complicated but
194	richer.</TD>
195	</TR>
196	<TR BGCOLOR="white" CLASS="TableRowColor">
197	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
198	<CODE>static <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>
199	<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_MAX_COLLATION_EVALUATIONS">SPELLCHECK_MAX_COLLATION_EVALUATIONS</A></B></CODE>
200
201	<BR>
202
203	The maximum number of word correction combinations to rank and evaluate prior to deciding which collation
204	candidates to test against the index.</TD>
205	</TR>
206	<TR BGCOLOR="white" CLASS="TableRowColor">
207	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
208	<CODE>static <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>
209	<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_MAX_COLLATION_TRIES">SPELLCHECK_MAX_COLLATION_TRIES</A></B></CODE>
210
211	<BR>
212
213	The maximum number of collations to test by querying against the index.</TD>
214	</TR>
215	<TR BGCOLOR="white" CLASS="TableRowColor">
216	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
217	<CODE>static <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>
218	<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_MAX_COLLATIONS">SPELLCHECK_MAX_COLLATIONS</A></B></CODE>
219
220	<BR>
221
222	The maximum number of collations to return.</TD>
223	</TR>
224	<TR BGCOLOR="white" CLASS="TableRowColor">
225	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
226	<CODE>static <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>
227	<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_MAX_RESULTS_FOR_SUGGEST">SPELLCHECK_MAX_RESULTS_FOR_SUGGEST</A></B></CODE>
228
229	<BR>
230
231	The maximum number of hits the request can return in order to both
232	generate spelling suggestions and set the "correctlySpelled" element to "false".</TD>
233	</TR>
234	<TR BGCOLOR="white" CLASS="TableRowColor">
235	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
236	<CODE>static <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>
237	<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_ONLY_MORE_POPULAR">SPELLCHECK_ONLY_MORE_POPULAR</A></B></CODE>
238
239	<BR>
240	When this parameter is set to true and the misspelled word exists in the
241	user field, only words that occur more frequently in the Solr field than
242	the one given will be returned.</TD>
243	</TR>
244	<TR BGCOLOR="white" CLASS="TableRowColor">
245	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
246	<CODE>static <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>
247	<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_PREFIX">SPELLCHECK_PREFIX</A></B></CODE>
248
249	<BR>
250	</TD>
251	</TR>
252	<TR BGCOLOR="white" CLASS="TableRowColor">
253	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
254	<CODE>static <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>
255	<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_Q">SPELLCHECK_Q</A></B></CODE>
256
257	<BR>
258	Use the value for this parameter as the query to spell check.</TD>
259	</TR>
260	<TR BGCOLOR="white" CLASS="TableRowColor">
261	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
262	<CODE>static <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>
263	<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_RELOAD">SPELLCHECK_RELOAD</A></B></CODE>
264
265	<BR>
266	Whether to reload the index.</TD>
267	</TR>
268	</TABLE>
269
270	<P>
271
272	<!-- ============ FIELD DETAIL =========== -->
273
274	<A NAME="field_detail"><!-- --></A>
275	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
276	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
277	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
278	<B>Field Detail</B></FONT></TH>
279	</TR>
280	</TABLE>
281
282	<A NAME="SPELLCHECK_PREFIX"><!-- --></A><H3>
283	SPELLCHECK_PREFIX</H3>
284	<PRE>
285	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>SPELLCHECK_PREFIX</B></PRE>
286	<DL>
287	<DL>
288	<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.SpellingParams.SPELLCHECK_PREFIX">Constant Field Values</A></DL>
289	</DL>
290	<HR>
291
292	<A NAME="SPELLCHECK_DICT"><!-- --></A><H3>
293	SPELLCHECK_DICT</H3>
294	<PRE>
295	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>SPELLCHECK_DICT</B></PRE>
296	<DL>
297	<DD>The name of the dictionary to be used for giving the suggestion for a
298	request. The value for this parameter is configured in solrconfig.xml
299	<P>
300	<DL>
301	<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.SpellingParams.SPELLCHECK_DICT">Constant Field Values</A></DL>
302	</DL>
303	<HR>
304
305	<A NAME="SPELLCHECK_COUNT"><!-- --></A><H3>
306	SPELLCHECK_COUNT</H3>
307	<PRE>
308	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>SPELLCHECK_COUNT</B></PRE>
309	<DL>
310	<DD>The count of suggestions to return for each query term not in the index and/or dictionary.
311	<p/>
312	If this parameter is absent in the request then only one suggestion is
313	returned. If it is more than one then a maximum of given suggestions are
314	returned for each token in the query.
315	<P>
316	<DL>
317	<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.SpellingParams.SPELLCHECK_COUNT">Constant Field Values</A></DL>
318	</DL>
319	<HR>
320
321	<A NAME="SPELLCHECK_ALTERNATIVE_TERM_COUNT"><!-- --></A><H3>
322	SPELLCHECK_ALTERNATIVE_TERM_COUNT</H3>
323	<PRE>
324	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>SPELLCHECK_ALTERNATIVE_TERM_COUNT</B></PRE>
325	<DL>
326	<DD>The count of suggestions to return for each query term existing in the index and/or dictionary.
327	<p/>
328	If this parameter is absent in the request then no suggestions are generated. This parameter allows
329	for receiving alternative terms to use in context-sensitive spelling corrections.
330	<P>
331	<DL>
332	<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.SpellingParams.SPELLCHECK_ALTERNATIVE_TERM_COUNT">Constant Field Values</A></DL>
333	</DL>
334	<HR>
335
336	<A NAME="SPELLCHECK_MAX_RESULTS_FOR_SUGGEST"><!-- --></A><H3>
337	SPELLCHECK_MAX_RESULTS_FOR_SUGGEST</H3>
338	<PRE>
339	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>SPELLCHECK_MAX_RESULTS_FOR_SUGGEST</B></PRE>
340	<DL>
341	<DD><p>
342	The maximum number of hits the request can return in order to both
343	generate spelling suggestions and set the "correctlySpelled" element to "false".
344	Note that this parameter is typically of use only in conjunction with "spellcheck.alternativeTermCount".
345	</p>
346	<p>
347	If left unspecified, the default behavior will prevail. That is, "correctlySpelled" will be false and suggestions
348	will be returned only if one or more of the query terms are absent from the dictionary and/or index. If set to zero,
349	the "correctlySpelled" flag will be false only if the response returns zero hits. If set to a value greater than zero,
350	suggestions will be returned even if hits are returned (up to the specified number). This number also will serve as
351	the threshold in determining the value of "correctlySpelled". Specifying a value greater than zero is useful
352	for creating "did-you-mean" suggestions for queries that return a low number of hits.
353	</p>
354	<P>
355	<DL>
356	<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.SpellingParams.SPELLCHECK_MAX_RESULTS_FOR_SUGGEST">Constant Field Values</A></DL>
357	</DL>
358	<HR>
359
360	<A NAME="SPELLCHECK_ONLY_MORE_POPULAR"><!-- --></A><H3>
361	SPELLCHECK_ONLY_MORE_POPULAR</H3>
362	<PRE>
363	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>SPELLCHECK_ONLY_MORE_POPULAR</B></PRE>
364	<DL>
365	<DD>When this parameter is set to true and the misspelled word exists in the
366	user field, only words that occur more frequently in the Solr field than
367	the one given will be returned. The default value is false.
368	<p/>
369	<b>This is applicable only for dictionaries built from Solr fields.</b>
370	<P>
371	<DL>
372	<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.SpellingParams.SPELLCHECK_ONLY_MORE_POPULAR">Constant Field Values</A></DL>
373	</DL>
374	<HR>
375
376	<A NAME="SPELLCHECK_EXTENDED_RESULTS"><!-- --></A><H3>
377	SPELLCHECK_EXTENDED_RESULTS</H3>
378	<PRE>
379	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>SPELLCHECK_EXTENDED_RESULTS</B></PRE>
380	<DL>
381	<DD>Whether to use the extended response format, which is more complicated but
382	richer. Returns the document frequency for each suggestion and returns one
383	suggestion block for each term in the query string. Default is false.
384	<p/>
385	<b>This is applicable only for dictionaries built from Solr fields.</b>
386	<P>
387	<DL>
388	<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.SpellingParams.SPELLCHECK_EXTENDED_RESULTS">Constant Field Values</A></DL>
389	</DL>
390	<HR>
391
392	<A NAME="SPELLCHECK_Q"><!-- --></A><H3>
393	SPELLCHECK_Q</H3>
394	<PRE>
395	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>SPELLCHECK_Q</B></PRE>
396	<DL>
397	<DD>Use the value for this parameter as the query to spell check.
398	<p/>
399	This parameter is <b>optional</b>. If absent, then the q parameter is
400	used.
401	<P>
402	<DL>
403	<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.SpellingParams.SPELLCHECK_Q">Constant Field Values</A></DL>
404	</DL>
405	<HR>
406
407	<A NAME="SPELLCHECK_BUILD"><!-- --></A><H3>
408	SPELLCHECK_BUILD</H3>
409	<PRE>
410	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>SPELLCHECK_BUILD</B></PRE>
411	<DL>
412	<DD>Whether to build the index or not. Optional and false by default.
413	<P>
414	<DL>
415	<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.SpellingParams.SPELLCHECK_BUILD">Constant Field Values</A></DL>
416	</DL>
417	<HR>
418
419	<A NAME="SPELLCHECK_RELOAD"><!-- --></A><H3>
420	SPELLCHECK_RELOAD</H3>
421	<PRE>
422	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>SPELLCHECK_RELOAD</B></PRE>
423	<DL>
424	<DD>Whether to reload the index. Optional and false by default.
425	<P>
426	<DL>
427	<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.SpellingParams.SPELLCHECK_RELOAD">Constant Field Values</A></DL>
428	</DL>
429	<HR>
430
431	<A NAME="SPELLCHECK_COLLATE"><!-- --></A><H3>
432	SPELLCHECK_COLLATE</H3>
433	<PRE>
434	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>SPELLCHECK_COLLATE</B></PRE>
435	<DL>
436	<DD>Take the top suggestion for each token and create a new query from it
437	<P>
438	<DL>
439	<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.SpellingParams.SPELLCHECK_COLLATE">Constant Field Values</A></DL>
440	</DL>
441	<HR>
442
443	<A NAME="SPELLCHECK_MAX_COLLATIONS"><!-- --></A><H3>
444	SPELLCHECK_MAX_COLLATIONS</H3>
445	<PRE>
446	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>SPELLCHECK_MAX_COLLATIONS</B></PRE>
447	<DL>
448	<DD><p>
449	The maximum number of collations to return. Default=1. Ignored if "spellcheck.collate" is false.
450	</p>
451	<P>
452	<DL>
453	<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.SpellingParams.SPELLCHECK_MAX_COLLATIONS">Constant Field Values</A></DL>
454	</DL>
455	<HR>
456
457	<A NAME="SPELLCHECK_MAX_COLLATION_TRIES"><!-- --></A><H3>
458	SPELLCHECK_MAX_COLLATION_TRIES</H3>
459	<PRE>
460	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>SPELLCHECK_MAX_COLLATION_TRIES</B></PRE>
461	<DL>
462	<DD><p>
463	The maximum number of collations to test by querying against the index.
464	When testing, the collation is substituted for the original query's "q" param. Any "qf"s are retained.
465	If this is set to zero, does not test for hits before returning collations (returned collations may result in zero hits).
466	Default=0. Ignored of "spellcheck.collate" is false.
467	</p>
468	<P>
469	<DL>
470	<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.SpellingParams.SPELLCHECK_MAX_COLLATION_TRIES">Constant Field Values</A></DL>
471	</DL>
472	<HR>
473
474	<A NAME="SPELLCHECK_MAX_COLLATION_EVALUATIONS"><!-- --></A><H3>
475	SPELLCHECK_MAX_COLLATION_EVALUATIONS</H3>
476	<PRE>
477	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>SPELLCHECK_MAX_COLLATION_EVALUATIONS</B></PRE>
478	<DL>
479	<DD><p>
480	The maximum number of word correction combinations to rank and evaluate prior to deciding which collation
481	candidates to test against the index. This is a performance safety-net in cases a user enters a query with
482	many misspelled words. The default is 10,000 combinations.
483	</p>
484	<P>
485	<DL>
486	<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.SpellingParams.SPELLCHECK_MAX_COLLATION_EVALUATIONS">Constant Field Values</A></DL>
487	</DL>
488	<HR>
489
490	<A NAME="SPELLCHECK_COLLATE_EXTENDED_RESULTS"><!-- --></A><H3>
491	SPELLCHECK_COLLATE_EXTENDED_RESULTS</H3>
492	<PRE>
493	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>SPELLCHECK_COLLATE_EXTENDED_RESULTS</B></PRE>
494	<DL>
495	<DD><p>
496	Whether to use the Extended Results Format for collations.
497	Includes "before>after" pairs to easily allow clients to generate messages like "no results for PORK. did you mean POLK?"
498	Also indicates the # of hits each collation will return on re-query. Default=false, which retains 1.4-compatible output.
499	</p>
500	<P>
501	<DL>
502	<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.SpellingParams.SPELLCHECK_COLLATE_EXTENDED_RESULTS">Constant Field Values</A></DL>
503	</DL>
504	<HR>
505
506	<A NAME="SPELLCHECK_COLLATE_PARAM_OVERRIDE"><!-- --></A><H3>
507	SPELLCHECK_COLLATE_PARAM_OVERRIDE</H3>
508	<PRE>
509	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>SPELLCHECK_COLLATE_PARAM_OVERRIDE</B></PRE>
510	<DL>
511	<DD><p>
512	For use with <A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_MAX_COLLATION_TRIES"><CODE>SPELLCHECK_MAX_COLLATION_TRIES</CODE></A>, use this to override any original query parameters
513	when issuing test queries. For instance, if the original query has "mm=1" but it is preferred to test collations
514	with "mm=100%", then use "spellcheck.collateParam.mm=100%".
515	</p>
516	<P>
517	<DL>
518	<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.SpellingParams.SPELLCHECK_COLLATE_PARAM_OVERRIDE">Constant Field Values</A></DL>
519	</DL>
520	<HR>
521
522	<A NAME="SPELLCHECK_ACCURACY"><!-- --></A><H3>
523	SPELLCHECK_ACCURACY</H3>
524	<PRE>
525	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>SPELLCHECK_ACCURACY</B></PRE>
526	<DL>
527	<DD>Certain spelling implementations may allow for an accuracy setting.
528	<P>
529	<DL>
530	<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.SpellingParams.SPELLCHECK_ACCURACY">Constant Field Values</A></DL>
531	</DL>
532	<!-- ========= END OF CLASS DATA ========= -->
533	<HR>
534
535
536	<!-- ======= START OF BOTTOM NAVBAR ====== -->
537	<A NAME="navbar_bottom"><!-- --></A>
538	<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
539	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
540	<TR>
541	<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
542	<A NAME="navbar_bottom_firstrow"><!-- --></A>
543	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
544	<TR ALIGN="center" VALIGN="top">
545	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
546	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
547	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
548	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SpellingParams.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
549	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
550	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
551	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
552	</TR>
553	</TABLE>
554	</TD>
555	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
556	</EM>
557	</TD>
558	</TR>
559
560	<TR>
561	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
562	<A HREF="../../../../../org/apache/solr/common/params/SpatialParams.html" title="interface in org.apache.solr.common.params"><B>PREV CLASS</B></A>
563	<A HREF="../../../../../org/apache/solr/common/params/StatsParams.html" title="interface in org.apache.solr.common.params"><B>NEXT CLASS</B></A></FONT></TD>
564	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
565	<A HREF="../../../../../index.html?org/apache/solr/common/params/SpellingParams.html" target="_top"><B>FRAMES</B></A>
566	<A HREF="SpellingParams.html" target="_top"><B>NO FRAMES</B></A>
567	<SCRIPT type="text/javascript">
568	<!--
569	if(window==top) {
570	document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
571	}
572	//-->
573	</SCRIPT>
574	<NOSCRIPT>
575	<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
576	</NOSCRIPT>
577
578
579	</FONT></TD>
580	</TR>
581	<TR>
582	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
583	SUMMARY: NESTED \| <A HREF="#field_summary">FIELD</A> \| CONSTR \| METHOD</FONT></TD>
584	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
585	DETAIL: <A HREF="#field_detail">FIELD</A> \| CONSTR \| METHOD</FONT></TD>
586	</TR>
587	</TABLE>
588	<A NAME="skip-navbar_bottom"></A>
589	<!-- ======== END OF BOTTOM NAVBAR ======= -->
590
591	<HR>
592
593	<address>Copyright © 2000-2012 Apache Software Foundation. All Rights Reserved.</address>
594	<script src='../../../../../prettify.js' type='text/javascript'></script>
595	<script type='text/javascript'>
596	(function(){
597	var oldonload = window.onload;
598	if (typeof oldonload != 'function') {
599	window.onload = prettyPrint;
600	} else {
601	window.onload = function() {
602	oldonload();
603	prettyPrint();
604	}
605	}
606	})();
607	</script>
608
609	</BODY>
610	</HTML>

Note: See TracBrowser for help on using the repository browser.

Context Navigation

source: sandbox/expresso-solr/solr/docs/api/solrj/org/apache/solr/common/params/SpellingParams.html @ 7588

Download in other formats: