Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Annotate
Revision Log

SpellingParams.html @ 7588

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

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

Context Navigation

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

Download in other formats: