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:24 EDT 2012 --> |
---|
6 | <META http-equiv="Content-Type" content="text/html; charset=utf-8"> |
---|
7 | <TITLE> |
---|
8 | SpellCheckComponent (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="SpellCheckComponent (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/SpellCheckComponent.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/handler/component/ShardResponse.html" title="class in org.apache.solr.handler.component"><B>PREV CLASS</B></A> |
---|
59 | <A HREF="../../../../../org/apache/solr/handler/component/SpellCheckMergeData.html" title="class in org.apache.solr.handler.component"><B>NEXT CLASS</B></A></FONT></TD> |
---|
60 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
61 | <A HREF="../../../../../index.html?org/apache/solr/handler/component/SpellCheckComponent.html" target="_top"><B>FRAMES</B></A> |
---|
62 | <A HREF="SpellCheckComponent.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> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
80 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
81 | DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <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"> |
---|
91 | org.apache.solr.handler.component</FONT> |
---|
92 | <BR> |
---|
93 | Class SpellCheckComponent</H2> |
---|
94 | <PRE> |
---|
95 | <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> |
---|
96 | <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">org.apache.solr.handler.component.SearchComponent</A> |
---|
97 | <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.solr.handler.component.SpellCheckComponent</B> |
---|
98 | </PRE> |
---|
99 | <DL> |
---|
100 | <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html" title="interface in org.apache.solr.common.params">SpellingParams</A>, <A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A>, <A HREF="../../../../../org/apache/solr/util/plugin/NamedListInitializedPlugin.html" title="interface in org.apache.solr.util.plugin">NamedListInitializedPlugin</A>, <A HREF="../../../../../org/apache/solr/util/plugin/SolrCoreAware.html" title="interface in org.apache.solr.util.plugin">SolrCoreAware</A></DD> |
---|
101 | </DL> |
---|
102 | <HR> |
---|
103 | <DL> |
---|
104 | <DT><PRE>public class <B>SpellCheckComponent</B><DT>extends <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A><DT>implements <A HREF="../../../../../org/apache/solr/util/plugin/SolrCoreAware.html" title="interface in org.apache.solr.util.plugin">SolrCoreAware</A>, <A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html" title="interface in org.apache.solr.common.params">SpellingParams</A></DL> |
---|
105 | </PRE> |
---|
106 | |
---|
107 | <P> |
---|
108 | A SearchComponent implementation which provides support for spell checking |
---|
109 | and suggestions using the Lucene contributed SpellChecker. |
---|
110 | |
---|
111 | <p> |
---|
112 | Refer to http://wiki.apache.org/solr/SpellCheckComponent for more details |
---|
113 | </p> |
---|
114 | <P> |
---|
115 | |
---|
116 | <P> |
---|
117 | <DL> |
---|
118 | <DT><B>Since:</B></DT> |
---|
119 | <DD>solr 1.3</DD> |
---|
120 | </DL> |
---|
121 | <HR> |
---|
122 | |
---|
123 | <P> |
---|
124 | <!-- ======== NESTED CLASS SUMMARY ======== --> |
---|
125 | |
---|
126 | <A NAME="nested_class_summary"><!-- --></A> |
---|
127 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
128 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
129 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
130 | <B>Nested Class Summary</B></FONT></TH> |
---|
131 | </TR> |
---|
132 | </TABLE> |
---|
133 | <A NAME="nested_classes_inherited_from_class_org.apache.solr.core.SolrInfoMBean"><!-- --></A> |
---|
134 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
135 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
---|
136 | <TH ALIGN="left"><B>Nested classes/interfaces inherited from interface org.apache.solr.core.<A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></B></TH> |
---|
137 | </TR> |
---|
138 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
139 | <TD><CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.Category.html" title="enum in org.apache.solr.core">SolrInfoMBean.Category</A></CODE></TD> |
---|
140 | </TR> |
---|
141 | </TABLE> |
---|
142 | |
---|
143 | <!-- =========== FIELD SUMMARY =========== --> |
---|
144 | |
---|
145 | <A NAME="field_summary"><!-- --></A> |
---|
146 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
147 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
148 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
149 | <B>Field Summary</B></FONT></TH> |
---|
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/handler/component/SpellCheckComponent.html#COMPONENT_NAME">COMPONENT_NAME</A></B></CODE> |
---|
155 | |
---|
156 | <BR> |
---|
157 | Base name for all spell checker query parameters.</TD> |
---|
158 | </TR> |
---|
159 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
160 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
161 | <CODE>static boolean</CODE></FONT></TD> |
---|
162 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/SpellCheckComponent.html#DEFAULT_ONLY_MORE_POPULAR">DEFAULT_ONLY_MORE_POPULAR</A></B></CODE> |
---|
163 | |
---|
164 | <BR> |
---|
165 | </TD> |
---|
166 | </TR> |
---|
167 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
168 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
169 | <CODE>protected <A HREF="../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A></CODE></FONT></TD> |
---|
170 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/SpellCheckComponent.html#initParams">initParams</A></B></CODE> |
---|
171 | |
---|
172 | <BR> |
---|
173 | </TD> |
---|
174 | </TR> |
---|
175 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
176 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
177 | <CODE>protected <A HREF="../../../../../org/apache/solr/spelling/QueryConverter.html" title="class in org.apache.solr.spelling">QueryConverter</A></CODE></FONT></TD> |
---|
178 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/SpellCheckComponent.html#queryConverter">queryConverter</A></B></CODE> |
---|
179 | |
---|
180 | <BR> |
---|
181 | </TD> |
---|
182 | </TR> |
---|
183 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
184 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
185 | <CODE>protected <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><<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/spelling/SolrSpellChecker.html" title="class in org.apache.solr.spelling">SolrSpellChecker</A>></CODE></FONT></TD> |
---|
186 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/SpellCheckComponent.html#spellCheckers">spellCheckers</A></B></CODE> |
---|
187 | |
---|
188 | <BR> |
---|
189 | Key is the dictionary, value is the SpellChecker for that dictionary name</TD> |
---|
190 | </TR> |
---|
191 | </TABLE> |
---|
192 | <A NAME="fields_inherited_from_class_org.apache.solr.common.params.SpellingParams"><!-- --></A> |
---|
193 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
194 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
---|
195 | <TH ALIGN="left"><B>Fields inherited from interface org.apache.solr.common.params.<A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html" title="interface in org.apache.solr.common.params">SpellingParams</A></B></TH> |
---|
196 | </TR> |
---|
197 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
198 | <TD><CODE><A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_ACCURACY">SPELLCHECK_ACCURACY</A>, <A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_ALTERNATIVE_TERM_COUNT">SPELLCHECK_ALTERNATIVE_TERM_COUNT</A>, <A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_BUILD">SPELLCHECK_BUILD</A>, <A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_COLLATE">SPELLCHECK_COLLATE</A>, <A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_COLLATE_EXTENDED_RESULTS">SPELLCHECK_COLLATE_EXTENDED_RESULTS</A>, <A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_COLLATE_PARAM_OVERRIDE">SPELLCHECK_COLLATE_PARAM_OVERRIDE</A>, <A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_COUNT">SPELLCHECK_COUNT</A>, <A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_DICT">SPELLCHECK_DICT</A>, <A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_EXTENDED_RESULTS">SPELLCHECK_EXTENDED_RESULTS</A>, <A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_MAX_COLLATION_EVALUATIONS">SPELLCHECK_MAX_COLLATION_EVALUATIONS</A>, <A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_MAX_COLLATION_TRIES">SPELLCHECK_MAX_COLLATION_TRIES</A>, <A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_MAX_COLLATIONS">SPELLCHECK_MAX_COLLATIONS</A>, <A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_MAX_RESULTS_FOR_SUGGEST">SPELLCHECK_MAX_RESULTS_FOR_SUGGEST</A>, <A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_ONLY_MORE_POPULAR">SPELLCHECK_ONLY_MORE_POPULAR</A>, <A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_PREFIX">SPELLCHECK_PREFIX</A>, <A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_Q">SPELLCHECK_Q</A>, <A HREF="../../../../../org/apache/solr/common/params/SpellingParams.html#SPELLCHECK_RELOAD">SPELLCHECK_RELOAD</A></CODE></TD> |
---|
199 | </TR> |
---|
200 | </TABLE> |
---|
201 | |
---|
202 | <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
---|
203 | |
---|
204 | <A NAME="constructor_summary"><!-- --></A> |
---|
205 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
206 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
207 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
208 | <B>Constructor Summary</B></FONT></TH> |
---|
209 | </TR> |
---|
210 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
211 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/SpellCheckComponent.html#SpellCheckComponent()">SpellCheckComponent</A></B>()</CODE> |
---|
212 | |
---|
213 | <BR> |
---|
214 | </TD> |
---|
215 | </TR> |
---|
216 | </TABLE> |
---|
217 | |
---|
218 | <!-- ========== METHOD SUMMARY =========== --> |
---|
219 | |
---|
220 | <A NAME="method_summary"><!-- --></A> |
---|
221 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
222 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
223 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
224 | <B>Method Summary</B></FONT></TH> |
---|
225 | </TR> |
---|
226 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
227 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
228 | <CODE>protected void</CODE></FONT></TD> |
---|
229 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/SpellCheckComponent.html#addCollationsToResponse(org.apache.solr.common.params.SolrParams, org.apache.solr.spelling.SpellingResult, org.apache.solr.handler.component.ResponseBuilder, java.lang.String, org.apache.solr.common.util.NamedList, boolean)">addCollationsToResponse</A></B>(<A HREF="../../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A> params, |
---|
230 | <A HREF="../../../../../org/apache/solr/spelling/SpellingResult.html" title="class in org.apache.solr.spelling">SpellingResult</A> spellingResult, |
---|
231 | <A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A> rb, |
---|
232 | <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> q, |
---|
233 | <A HREF="../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A> response, |
---|
234 | boolean suggestionsMayOverlap)</CODE> |
---|
235 | |
---|
236 | <BR> |
---|
237 | </TD> |
---|
238 | </TR> |
---|
239 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
240 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
241 | <CODE> void</CODE></FONT></TD> |
---|
242 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/SpellCheckComponent.html#finishStage(org.apache.solr.handler.component.ResponseBuilder)">finishStage</A></B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A> rb)</CODE> |
---|
243 | |
---|
244 | <BR> |
---|
245 | Called after all responses have been received for this stage.</TD> |
---|
246 | </TR> |
---|
247 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
248 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
249 | <CODE>protected <A HREF="../../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A></CODE></FONT></TD> |
---|
250 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/SpellCheckComponent.html#getCustomParams(java.lang.String, org.apache.solr.common.params.SolrParams)">getCustomParams</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> dictionary, |
---|
251 | <A HREF="../../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A> params)</CODE> |
---|
252 | |
---|
253 | <BR> |
---|
254 | For every param that is of the form "spellcheck.[dictionary name].XXXX=YYYY, add |
---|
255 | XXXX=YYYY as a param to the custom param list</TD> |
---|
256 | </TR> |
---|
257 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
258 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
259 | <CODE> <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> |
---|
260 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/SpellCheckComponent.html#getDescription()">getDescription</A></B>()</CODE> |
---|
261 | |
---|
262 | <BR> |
---|
263 | Simple one or two line description</TD> |
---|
264 | </TR> |
---|
265 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
266 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
267 | <CODE> <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> |
---|
268 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/SpellCheckComponent.html#getSource()">getSource</A></B>()</CODE> |
---|
269 | |
---|
270 | <BR> |
---|
271 | CVS Source, SVN Source, etc</TD> |
---|
272 | </TR> |
---|
273 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
274 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
275 | <CODE>protected <A HREF="../../../../../org/apache/solr/spelling/SolrSpellChecker.html" title="class in org.apache.solr.spelling">SolrSpellChecker</A></CODE></FONT></TD> |
---|
276 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/SpellCheckComponent.html#getSpellChecker(org.apache.solr.common.params.SolrParams)">getSpellChecker</A></B>(<A HREF="../../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A> params)</CODE> |
---|
277 | |
---|
278 | <BR> |
---|
279 | </TD> |
---|
280 | </TR> |
---|
281 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
282 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
283 | <CODE> <A HREF="../../../../../org/apache/solr/spelling/SolrSpellChecker.html" title="class in org.apache.solr.spelling">SolrSpellChecker</A></CODE></FONT></TD> |
---|
284 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/SpellCheckComponent.html#getSpellChecker(java.lang.String)">getSpellChecker</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> name)</CODE> |
---|
285 | |
---|
286 | <BR> |
---|
287 | </TD> |
---|
288 | </TR> |
---|
289 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
290 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
291 | <CODE> <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><<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/spelling/SolrSpellChecker.html" title="class in org.apache.solr.spelling">SolrSpellChecker</A>></CODE></FONT></TD> |
---|
292 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/SpellCheckComponent.html#getSpellCheckers()">getSpellCheckers</A></B>()</CODE> |
---|
293 | |
---|
294 | <BR> |
---|
295 | </TD> |
---|
296 | </TR> |
---|
297 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
298 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
299 | <CODE> void</CODE></FONT></TD> |
---|
300 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/SpellCheckComponent.html#inform(org.apache.solr.core.SolrCore)">inform</A></B>(<A HREF="../../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</A> core)</CODE> |
---|
301 | |
---|
302 | <BR> |
---|
303 | </TD> |
---|
304 | </TR> |
---|
305 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
306 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
307 | <CODE> void</CODE></FONT></TD> |
---|
308 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/SpellCheckComponent.html#init(org.apache.solr.common.util.NamedList)">init</A></B>(<A HREF="../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A> args)</CODE> |
---|
309 | |
---|
310 | <BR> |
---|
311 | </TD> |
---|
312 | </TR> |
---|
313 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
314 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
315 | <CODE> void</CODE></FONT></TD> |
---|
316 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/SpellCheckComponent.html#modifyRequest(org.apache.solr.handler.component.ResponseBuilder, org.apache.solr.handler.component.SearchComponent, org.apache.solr.handler.component.ShardRequest)">modifyRequest</A></B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A> rb, |
---|
317 | <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A> who, |
---|
318 | <A HREF="../../../../../org/apache/solr/handler/component/ShardRequest.html" title="class in org.apache.solr.handler.component">ShardRequest</A> sreq)</CODE> |
---|
319 | |
---|
320 | <BR> |
---|
321 | Called after another component adds a request</TD> |
---|
322 | </TR> |
---|
323 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
324 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
325 | <CODE> void</CODE></FONT></TD> |
---|
326 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/SpellCheckComponent.html#prepare(org.apache.solr.handler.component.ResponseBuilder)">prepare</A></B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A> rb)</CODE> |
---|
327 | |
---|
328 | <BR> |
---|
329 | Prepare the response.</TD> |
---|
330 | </TR> |
---|
331 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
332 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
333 | <CODE> void</CODE></FONT></TD> |
---|
334 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/SpellCheckComponent.html#process(org.apache.solr.handler.component.ResponseBuilder)">process</A></B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A> rb)</CODE> |
---|
335 | |
---|
336 | <BR> |
---|
337 | Process the request for this component</TD> |
---|
338 | </TR> |
---|
339 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
340 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
341 | <CODE>protected <A HREF="../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A></CODE></FONT></TD> |
---|
342 | <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/SpellCheckComponent.html#toNamedList(boolean, org.apache.solr.spelling.SpellingResult, java.lang.String, boolean, boolean, boolean)">toNamedList</A></B>(boolean shardRequest, |
---|
343 | <A HREF="../../../../../org/apache/solr/spelling/SpellingResult.html" title="class in org.apache.solr.spelling">SpellingResult</A> spellingResult, |
---|
344 | <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> origQuery, |
---|
345 | boolean extendedResults, |
---|
346 | boolean collate, |
---|
347 | boolean correctlySpelled)</CODE> |
---|
348 | |
---|
349 | <BR> |
---|
350 | </TD> |
---|
351 | </TR> |
---|
352 | </TABLE> |
---|
353 | <A NAME="methods_inherited_from_class_org.apache.solr.handler.component.SearchComponent"><!-- --></A> |
---|
354 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
355 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
---|
356 | <TH ALIGN="left"><B>Methods inherited from class org.apache.solr.handler.component.<A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A></B></TH> |
---|
357 | </TR> |
---|
358 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
359 | <TD><CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#distributedProcess(org.apache.solr.handler.component.ResponseBuilder)">distributedProcess</A>, <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getCategory()">getCategory</A>, <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getDocs()">getDocs</A>, <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getName()">getName</A>, <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getStatistics()">getStatistics</A>, <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getVersion()">getVersion</A>, <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#handleResponses(org.apache.solr.handler.component.ResponseBuilder, org.apache.solr.handler.component.ShardRequest)">handleResponses</A></CODE></TD> |
---|
360 | </TR> |
---|
361 | </TABLE> |
---|
362 | <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
---|
363 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
364 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
---|
365 | <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> |
---|
366 | </TR> |
---|
367 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
368 | <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> |
---|
369 | </TR> |
---|
370 | </TABLE> |
---|
371 | |
---|
372 | <P> |
---|
373 | |
---|
374 | <!-- ============ FIELD DETAIL =========== --> |
---|
375 | |
---|
376 | <A NAME="field_detail"><!-- --></A> |
---|
377 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
378 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
379 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
380 | <B>Field Detail</B></FONT></TH> |
---|
381 | </TR> |
---|
382 | </TABLE> |
---|
383 | |
---|
384 | <A NAME="DEFAULT_ONLY_MORE_POPULAR"><!-- --></A><H3> |
---|
385 | DEFAULT_ONLY_MORE_POPULAR</H3> |
---|
386 | <PRE> |
---|
387 | public static final boolean <B>DEFAULT_ONLY_MORE_POPULAR</B></PRE> |
---|
388 | <DL> |
---|
389 | <DL> |
---|
390 | <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.handler.component.SpellCheckComponent.DEFAULT_ONLY_MORE_POPULAR">Constant Field Values</A></DL> |
---|
391 | </DL> |
---|
392 | <HR> |
---|
393 | |
---|
394 | <A NAME="COMPONENT_NAME"><!-- --></A><H3> |
---|
395 | COMPONENT_NAME</H3> |
---|
396 | <PRE> |
---|
397 | public 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>COMPONENT_NAME</B></PRE> |
---|
398 | <DL> |
---|
399 | <DD>Base name for all spell checker query parameters. This name is also used to |
---|
400 | register this component with SearchHandler. |
---|
401 | <P> |
---|
402 | <DL> |
---|
403 | <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.handler.component.SpellCheckComponent.COMPONENT_NAME">Constant Field Values</A></DL> |
---|
404 | </DL> |
---|
405 | <HR> |
---|
406 | |
---|
407 | <A NAME="initParams"><!-- --></A><H3> |
---|
408 | initParams</H3> |
---|
409 | <PRE> |
---|
410 | protected <A HREF="../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A> <B>initParams</B></PRE> |
---|
411 | <DL> |
---|
412 | <DL> |
---|
413 | </DL> |
---|
414 | </DL> |
---|
415 | <HR> |
---|
416 | |
---|
417 | <A NAME="spellCheckers"><!-- --></A><H3> |
---|
418 | spellCheckers</H3> |
---|
419 | <PRE> |
---|
420 | protected <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><<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/spelling/SolrSpellChecker.html" title="class in org.apache.solr.spelling">SolrSpellChecker</A>> <B>spellCheckers</B></PRE> |
---|
421 | <DL> |
---|
422 | <DD>Key is the dictionary, value is the SpellChecker for that dictionary name |
---|
423 | <P> |
---|
424 | <DL> |
---|
425 | </DL> |
---|
426 | </DL> |
---|
427 | <HR> |
---|
428 | |
---|
429 | <A NAME="queryConverter"><!-- --></A><H3> |
---|
430 | queryConverter</H3> |
---|
431 | <PRE> |
---|
432 | protected <A HREF="../../../../../org/apache/solr/spelling/QueryConverter.html" title="class in org.apache.solr.spelling">QueryConverter</A> <B>queryConverter</B></PRE> |
---|
433 | <DL> |
---|
434 | <DL> |
---|
435 | </DL> |
---|
436 | </DL> |
---|
437 | |
---|
438 | <!-- ========= CONSTRUCTOR DETAIL ======== --> |
---|
439 | |
---|
440 | <A NAME="constructor_detail"><!-- --></A> |
---|
441 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
442 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
443 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
444 | <B>Constructor Detail</B></FONT></TH> |
---|
445 | </TR> |
---|
446 | </TABLE> |
---|
447 | |
---|
448 | <A NAME="SpellCheckComponent()"><!-- --></A><H3> |
---|
449 | SpellCheckComponent</H3> |
---|
450 | <PRE> |
---|
451 | public <B>SpellCheckComponent</B>()</PRE> |
---|
452 | <DL> |
---|
453 | </DL> |
---|
454 | |
---|
455 | <!-- ============ METHOD DETAIL ========== --> |
---|
456 | |
---|
457 | <A NAME="method_detail"><!-- --></A> |
---|
458 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
459 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
460 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
461 | <B>Method Detail</B></FONT></TH> |
---|
462 | </TR> |
---|
463 | </TABLE> |
---|
464 | |
---|
465 | <A NAME="init(org.apache.solr.common.util.NamedList)"><!-- --></A><H3> |
---|
466 | init</H3> |
---|
467 | <PRE> |
---|
468 | public void <B>init</B>(<A HREF="../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A> args)</PRE> |
---|
469 | <DL> |
---|
470 | <DD><DL> |
---|
471 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/util/plugin/NamedListInitializedPlugin.html#init(org.apache.solr.common.util.NamedList)">init</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/solr/util/plugin/NamedListInitializedPlugin.html" title="interface in org.apache.solr.util.plugin">NamedListInitializedPlugin</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#init(org.apache.solr.common.util.NamedList)">init</A></CODE> in class <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A></CODE></DL> |
---|
472 | </DD> |
---|
473 | <DD><DL> |
---|
474 | </DL> |
---|
475 | </DD> |
---|
476 | </DL> |
---|
477 | <HR> |
---|
478 | |
---|
479 | <A NAME="prepare(org.apache.solr.handler.component.ResponseBuilder)"><!-- --></A><H3> |
---|
480 | prepare</H3> |
---|
481 | <PRE> |
---|
482 | public void <B>prepare</B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A> rb) |
---|
483 | throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
---|
484 | <DL> |
---|
485 | <DD><B>Description copied from class: <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#prepare(org.apache.solr.handler.component.ResponseBuilder)">SearchComponent</A></CODE></B></DD> |
---|
486 | <DD>Prepare the response. Guaranteed to be called before any SearchComponent <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#process(org.apache.solr.handler.component.ResponseBuilder)"><CODE>SearchComponent.process(org.apache.solr.handler.component.ResponseBuilder)</CODE></A> method. |
---|
487 | Called for every incoming request. |
---|
488 | |
---|
489 | The place to do initialization that is request dependent. |
---|
490 | <P> |
---|
491 | <DD><DL> |
---|
492 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#prepare(org.apache.solr.handler.component.ResponseBuilder)">prepare</A></CODE> in class <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A></CODE></DL> |
---|
493 | </DD> |
---|
494 | <DD><DL> |
---|
495 | <DT><B>Parameters:</B><DD><CODE>rb</CODE> - The <A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component"><CODE>ResponseBuilder</CODE></A> |
---|
496 | <DT><B>Throws:</B> |
---|
497 | <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> |
---|
498 | </DD> |
---|
499 | </DL> |
---|
500 | <HR> |
---|
501 | |
---|
502 | <A NAME="process(org.apache.solr.handler.component.ResponseBuilder)"><!-- --></A><H3> |
---|
503 | process</H3> |
---|
504 | <PRE> |
---|
505 | public void <B>process</B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A> rb) |
---|
506 | throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
---|
507 | <DL> |
---|
508 | <DD><B>Description copied from class: <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#process(org.apache.solr.handler.component.ResponseBuilder)">SearchComponent</A></CODE></B></DD> |
---|
509 | <DD>Process the request for this component |
---|
510 | <P> |
---|
511 | <DD><DL> |
---|
512 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#process(org.apache.solr.handler.component.ResponseBuilder)">process</A></CODE> in class <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A></CODE></DL> |
---|
513 | </DD> |
---|
514 | <DD><DL> |
---|
515 | <DT><B>Parameters:</B><DD><CODE>rb</CODE> - The <A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component"><CODE>ResponseBuilder</CODE></A> |
---|
516 | <DT><B>Throws:</B> |
---|
517 | <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> |
---|
518 | </DD> |
---|
519 | </DL> |
---|
520 | <HR> |
---|
521 | |
---|
522 | <A NAME="addCollationsToResponse(org.apache.solr.common.params.SolrParams, org.apache.solr.spelling.SpellingResult, org.apache.solr.handler.component.ResponseBuilder, java.lang.String, org.apache.solr.common.util.NamedList, boolean)"><!-- --></A><H3> |
---|
523 | addCollationsToResponse</H3> |
---|
524 | <PRE> |
---|
525 | protected void <B>addCollationsToResponse</B>(<A HREF="../../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A> params, |
---|
526 | <A HREF="../../../../../org/apache/solr/spelling/SpellingResult.html" title="class in org.apache.solr.spelling">SpellingResult</A> spellingResult, |
---|
527 | <A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A> rb, |
---|
528 | <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> q, |
---|
529 | <A HREF="../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A> response, |
---|
530 | boolean suggestionsMayOverlap)</PRE> |
---|
531 | <DL> |
---|
532 | <DD><DL> |
---|
533 | </DL> |
---|
534 | </DD> |
---|
535 | <DD><DL> |
---|
536 | </DL> |
---|
537 | </DD> |
---|
538 | </DL> |
---|
539 | <HR> |
---|
540 | |
---|
541 | <A NAME="getCustomParams(java.lang.String, org.apache.solr.common.params.SolrParams)"><!-- --></A><H3> |
---|
542 | getCustomParams</H3> |
---|
543 | <PRE> |
---|
544 | protected <A HREF="../../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A> <B>getCustomParams</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> dictionary, |
---|
545 | <A HREF="../../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A> params)</PRE> |
---|
546 | <DL> |
---|
547 | <DD>For every param that is of the form "spellcheck.[dictionary name].XXXX=YYYY, add |
---|
548 | XXXX=YYYY as a param to the custom param list |
---|
549 | <P> |
---|
550 | <DD><DL> |
---|
551 | </DL> |
---|
552 | </DD> |
---|
553 | <DD><DL> |
---|
554 | <DT><B>Parameters:</B><DD><CODE>params</CODE> - The original SolrParams |
---|
555 | <DT><B>Returns:</B><DD>The new Params</DL> |
---|
556 | </DD> |
---|
557 | </DL> |
---|
558 | <HR> |
---|
559 | |
---|
560 | <A NAME="modifyRequest(org.apache.solr.handler.component.ResponseBuilder, org.apache.solr.handler.component.SearchComponent, org.apache.solr.handler.component.ShardRequest)"><!-- --></A><H3> |
---|
561 | modifyRequest</H3> |
---|
562 | <PRE> |
---|
563 | public void <B>modifyRequest</B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A> rb, |
---|
564 | <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A> who, |
---|
565 | <A HREF="../../../../../org/apache/solr/handler/component/ShardRequest.html" title="class in org.apache.solr.handler.component">ShardRequest</A> sreq)</PRE> |
---|
566 | <DL> |
---|
567 | <DD><B>Description copied from class: <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#modifyRequest(org.apache.solr.handler.component.ResponseBuilder, org.apache.solr.handler.component.SearchComponent, org.apache.solr.handler.component.ShardRequest)">SearchComponent</A></CODE></B></DD> |
---|
568 | <DD>Called after another component adds a request |
---|
569 | <P> |
---|
570 | <DD><DL> |
---|
571 | <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#modifyRequest(org.apache.solr.handler.component.ResponseBuilder, org.apache.solr.handler.component.SearchComponent, org.apache.solr.handler.component.ShardRequest)">modifyRequest</A></CODE> in class <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A></CODE></DL> |
---|
572 | </DD> |
---|
573 | <DD><DL> |
---|
574 | </DL> |
---|
575 | </DD> |
---|
576 | </DL> |
---|
577 | <HR> |
---|
578 | |
---|
579 | <A NAME="finishStage(org.apache.solr.handler.component.ResponseBuilder)"><!-- --></A><H3> |
---|
580 | finishStage</H3> |
---|
581 | <PRE> |
---|
582 | public void <B>finishStage</B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A> rb)</PRE> |
---|
583 | <DL> |
---|
584 | <DD><B>Description copied from class: <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#finishStage(org.apache.solr.handler.component.ResponseBuilder)">SearchComponent</A></CODE></B></DD> |
---|
585 | <DD>Called after all responses have been received for this stage. |
---|
586 | Useful when different requests are sent to each shard. |
---|
587 | <P> |
---|
588 | <DD><DL> |
---|
589 | <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#finishStage(org.apache.solr.handler.component.ResponseBuilder)">finishStage</A></CODE> in class <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A></CODE></DL> |
---|
590 | </DD> |
---|
591 | <DD><DL> |
---|
592 | </DL> |
---|
593 | </DD> |
---|
594 | </DL> |
---|
595 | <HR> |
---|
596 | |
---|
597 | <A NAME="getSpellChecker(org.apache.solr.common.params.SolrParams)"><!-- --></A><H3> |
---|
598 | getSpellChecker</H3> |
---|
599 | <PRE> |
---|
600 | protected <A HREF="../../../../../org/apache/solr/spelling/SolrSpellChecker.html" title="class in org.apache.solr.spelling">SolrSpellChecker</A> <B>getSpellChecker</B>(<A HREF="../../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A> params)</PRE> |
---|
601 | <DL> |
---|
602 | <DD><DL> |
---|
603 | </DL> |
---|
604 | </DD> |
---|
605 | <DD><DL> |
---|
606 | </DL> |
---|
607 | </DD> |
---|
608 | </DL> |
---|
609 | <HR> |
---|
610 | |
---|
611 | <A NAME="getSpellChecker(java.lang.String)"><!-- --></A><H3> |
---|
612 | getSpellChecker</H3> |
---|
613 | <PRE> |
---|
614 | public <A HREF="../../../../../org/apache/solr/spelling/SolrSpellChecker.html" title="class in org.apache.solr.spelling">SolrSpellChecker</A> <B>getSpellChecker</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> name)</PRE> |
---|
615 | <DL> |
---|
616 | <DD><DL> |
---|
617 | </DL> |
---|
618 | </DD> |
---|
619 | <DD><DL> |
---|
620 | |
---|
621 | <DT><B>Returns:</B><DD>the spellchecker registered to a given name</DL> |
---|
622 | </DD> |
---|
623 | </DL> |
---|
624 | <HR> |
---|
625 | |
---|
626 | <A NAME="toNamedList(boolean, org.apache.solr.spelling.SpellingResult, java.lang.String, boolean, boolean, boolean)"><!-- --></A><H3> |
---|
627 | toNamedList</H3> |
---|
628 | <PRE> |
---|
629 | protected <A HREF="../../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A> <B>toNamedList</B>(boolean shardRequest, |
---|
630 | <A HREF="../../../../../org/apache/solr/spelling/SpellingResult.html" title="class in org.apache.solr.spelling">SpellingResult</A> spellingResult, |
---|
631 | <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> origQuery, |
---|
632 | boolean extendedResults, |
---|
633 | boolean collate, |
---|
634 | boolean correctlySpelled)</PRE> |
---|
635 | <DL> |
---|
636 | <DD><DL> |
---|
637 | </DL> |
---|
638 | </DD> |
---|
639 | <DD><DL> |
---|
640 | </DL> |
---|
641 | </DD> |
---|
642 | </DL> |
---|
643 | <HR> |
---|
644 | |
---|
645 | <A NAME="inform(org.apache.solr.core.SolrCore)"><!-- --></A><H3> |
---|
646 | inform</H3> |
---|
647 | <PRE> |
---|
648 | public void <B>inform</B>(<A HREF="../../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</A> core)</PRE> |
---|
649 | <DL> |
---|
650 | <DD><DL> |
---|
651 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/util/plugin/SolrCoreAware.html#inform(org.apache.solr.core.SolrCore)">inform</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/solr/util/plugin/SolrCoreAware.html" title="interface in org.apache.solr.util.plugin">SolrCoreAware</A></CODE></DL> |
---|
652 | </DD> |
---|
653 | <DD><DL> |
---|
654 | </DL> |
---|
655 | </DD> |
---|
656 | </DL> |
---|
657 | <HR> |
---|
658 | |
---|
659 | <A NAME="getSpellCheckers()"><!-- --></A><H3> |
---|
660 | getSpellCheckers</H3> |
---|
661 | <PRE> |
---|
662 | public <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><<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/spelling/SolrSpellChecker.html" title="class in org.apache.solr.spelling">SolrSpellChecker</A>> <B>getSpellCheckers</B>()</PRE> |
---|
663 | <DL> |
---|
664 | <DD><DL> |
---|
665 | </DL> |
---|
666 | </DD> |
---|
667 | <DD><DL> |
---|
668 | </DL> |
---|
669 | </DD> |
---|
670 | </DL> |
---|
671 | <HR> |
---|
672 | |
---|
673 | <A NAME="getDescription()"><!-- --></A><H3> |
---|
674 | getDescription</H3> |
---|
675 | <PRE> |
---|
676 | public <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>getDescription</B>()</PRE> |
---|
677 | <DL> |
---|
678 | <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getDescription()">SolrInfoMBean</A></CODE></B></DD> |
---|
679 | <DD>Simple one or two line description |
---|
680 | <P> |
---|
681 | <DD><DL> |
---|
682 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getDescription()">getDescription</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getDescription()">getDescription</A></CODE> in class <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A></CODE></DL> |
---|
683 | </DD> |
---|
684 | <DD><DL> |
---|
685 | </DL> |
---|
686 | </DD> |
---|
687 | </DL> |
---|
688 | <HR> |
---|
689 | |
---|
690 | <A NAME="getSource()"><!-- --></A><H3> |
---|
691 | getSource</H3> |
---|
692 | <PRE> |
---|
693 | public <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>getSource</B>()</PRE> |
---|
694 | <DL> |
---|
695 | <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getSource()">SolrInfoMBean</A></CODE></B></DD> |
---|
696 | <DD>CVS Source, SVN Source, etc |
---|
697 | <P> |
---|
698 | <DD><DL> |
---|
699 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getSource()">getSource</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getSource()">getSource</A></CODE> in class <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A></CODE></DL> |
---|
700 | </DD> |
---|
701 | <DD><DL> |
---|
702 | </DL> |
---|
703 | </DD> |
---|
704 | </DL> |
---|
705 | <!-- ========= END OF CLASS DATA ========= --> |
---|
706 | <HR> |
---|
707 | |
---|
708 | |
---|
709 | <!-- ======= START OF BOTTOM NAVBAR ====== --> |
---|
710 | <A NAME="navbar_bottom"><!-- --></A> |
---|
711 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
---|
712 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
---|
713 | <TR> |
---|
714 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
---|
715 | <A NAME="navbar_bottom_firstrow"><!-- --></A> |
---|
716 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
---|
717 | <TR ALIGN="center" VALIGN="top"> |
---|
718 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
---|
719 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
720 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
721 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SpellCheckComponent.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
---|
722 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
723 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
724 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
---|
725 | </TR> |
---|
726 | </TABLE> |
---|
727 | </TD> |
---|
728 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
---|
729 | </EM> |
---|
730 | </TD> |
---|
731 | </TR> |
---|
732 | |
---|
733 | <TR> |
---|
734 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
735 | <A HREF="../../../../../org/apache/solr/handler/component/ShardResponse.html" title="class in org.apache.solr.handler.component"><B>PREV CLASS</B></A> |
---|
736 | <A HREF="../../../../../org/apache/solr/handler/component/SpellCheckMergeData.html" title="class in org.apache.solr.handler.component"><B>NEXT CLASS</B></A></FONT></TD> |
---|
737 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
738 | <A HREF="../../../../../index.html?org/apache/solr/handler/component/SpellCheckComponent.html" target="_top"><B>FRAMES</B></A> |
---|
739 | <A HREF="SpellCheckComponent.html" target="_top"><B>NO FRAMES</B></A> |
---|
740 | <SCRIPT type="text/javascript"> |
---|
741 | <!-- |
---|
742 | if(window==top) { |
---|
743 | document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
---|
744 | } |
---|
745 | //--> |
---|
746 | </SCRIPT> |
---|
747 | <NOSCRIPT> |
---|
748 | <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
---|
749 | </NOSCRIPT> |
---|
750 | |
---|
751 | |
---|
752 | </FONT></TD> |
---|
753 | </TR> |
---|
754 | <TR> |
---|
755 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
756 | SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
757 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
758 | DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
---|
759 | </TR> |
---|
760 | </TABLE> |
---|
761 | <A NAME="skip-navbar_bottom"></A> |
---|
762 | <!-- ======== END OF BOTTOM NAVBAR ======= --> |
---|
763 | |
---|
764 | <HR> |
---|
765 | |
---|
766 | <address>Copyright © 2000-2012 Apache Software Foundation. All Rights Reserved.</address> |
---|
767 | <script src='../../../../../prettify.js' type='text/javascript'></script> |
---|
768 | <script type='text/javascript'> |
---|
769 | (function(){ |
---|
770 | var oldonload = window.onload; |
---|
771 | if (typeof oldonload != 'function') { |
---|
772 | window.onload = prettyPrint; |
---|
773 | } else { |
---|
774 | window.onload = function() { |
---|
775 | oldonload(); |
---|
776 | prettyPrint(); |
---|
777 | } |
---|
778 | } |
---|
779 | })(); |
---|
780 | </script> |
---|
781 | |
---|
782 | </BODY> |
---|
783 | </HTML> |
---|