You are viewing a plain text version of this content. The canonical link for it is here.
Posted to solr-commits@lucene.apache.org by gs...@apache.org on 2008/08/06 15:05:48 UTC

svn commit: r683254 - /lucene/solr/trunk/src/java/org/apache/solr/handler/SpellCheckerRequestHandler.java

Author: gsingers
Date: Wed Aug  6 06:05:46 2008
New Revision: 683254

URL: http://svn.apache.org/viewvc?rev=683254&view=rev
Log:
SOLR-474: Updated the javadocs for SpellcheckerReqHandler.  Removed refs to "multiWords", which doesn't exist, clarified a bit on use of extendedResults and multiword queries.

Modified:
    lucene/solr/trunk/src/java/org/apache/solr/handler/SpellCheckerRequestHandler.java

Modified: lucene/solr/trunk/src/java/org/apache/solr/handler/SpellCheckerRequestHandler.java
URL: http://svn.apache.org/viewvc/lucene/solr/trunk/src/java/org/apache/solr/handler/SpellCheckerRequestHandler.java?rev=683254&r1=683253&r2=683254&view=diff
==============================================================================
--- lucene/solr/trunk/src/java/org/apache/solr/handler/SpellCheckerRequestHandler.java (original)
+++ lucene/solr/trunk/src/java/org/apache/solr/handler/SpellCheckerRequestHandler.java Wed Aug  6 06:05:46 2008
@@ -75,14 +75,19 @@
 <str name="words">facial</str>
 &lt;str name="exist"&gt;true&lt;/str&gt; </pre>
  * 
- * <p>If a query string parameter of "multiWords" is used, then each word within the
+ * <p>If a query string parameter of "extendedResults" is used, then each word within the
  * "q" parameter (seperated by a space or +) will 
  * be iterated through the spell checker and will be wrapped in an 
  * NamedList.  Each word will then get its own set of results: words, exists, and
  * suggestions.</p>
+ * <P><bold>NOTE</bold>: Query terms are simply split on whitespace when using extendedResults mode.  This is may not be adequate.
+ *  See the {@link org.apache.solr.handler.component.SpellCheckComponent} for alternatives.
+ * </P>
+ * <p>Also note that multiword queries will be treated as a single term if extendedResults is false.  This may or may not make sense
+ * depending on how the spelling field was indexed.</p>
  * 
  * <p>Examples of the use of the standard ouput (XML) without and with the 
- * use of the "multiWords" parameter are as follows.</p>
+ * use of the "extendedResults" parameter are as follows.</p>
  * 
  * <p> The following URL
  * examples were configured with the solr.SpellCheckerRequestHandler 
@@ -263,7 +268,7 @@
   }
 
   /**
-   * Processes the following query string parameters: q, multiWords, cmd rebuild,
+   * Processes the following query string parameters: q, extendedResults, cmd rebuild,
    * cmd reopen, accuracy, suggestionCount, restrictToField, and onlyMorePopular.
    */
   @Override