org.apache.solr.handler
Class SpellCheckerRequestHandler

java.lang.Object
  extended by org.apache.solr.handler.RequestHandlerBase
      extended by org.apache.solr.handler.SpellCheckerRequestHandler
All Implemented Interfaces:
SolrInfoMBean, SolrRequestHandler

public class SpellCheckerRequestHandler
extends RequestHandlerBase

Takes a string (e.g. a query string) as the value of the "q" parameter and looks up alternative spelling suggestions in the spellchecker. The spellchecker used by this handler is the Lucene contrib SpellChecker.

Author:
Otis Gospodnetic
See Also:
The Lucene Spellchecker documentation

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoMBean
SolrInfoMBean.Category
 
Field Summary
 
Fields inherited from class org.apache.solr.handler.RequestHandlerBase
appends, defaults, invariants
 
Constructor Summary
SpellCheckerRequestHandler()
           
 
Method Summary
 java.lang.String getDescription()
          Simple one or two line description
 java.net.URL[] getDocs()
          Documentation URL list.
 java.lang.String getSource()
          CVS Source, SVN Source, etc
 java.lang.String getSourceId()
          CVS Id, SVN Id, etc
 java.lang.String getVersion()
          Simple common usage version, e.g.
 void handleRequestBody(SolrQueryRequest req, SolrQueryResponse rsp)
           
 void init(NamedList args)
          init will be called just once, immediately after creation.
 
Methods inherited from class org.apache.solr.handler.RequestHandlerBase
getCategory, getName, getStatistics, handleRequest
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SpellCheckerRequestHandler

public SpellCheckerRequestHandler()
Method Detail

init

public void init(NamedList args)
Description copied from interface: SolrRequestHandler
init will be called just once, immediately after creation.

The args are user-level initialization parameters that may be specified when declaring a request handler in solrconfig.xml

Specified by:
init in interface SolrRequestHandler
Overrides:
init in class RequestHandlerBase

handleRequestBody

public void handleRequestBody(SolrQueryRequest req,
                              SolrQueryResponse rsp)
                       throws java.lang.Exception
Specified by:
handleRequestBody in class RequestHandlerBase
Throws:
java.lang.Exception

getVersion

public java.lang.String getVersion()
Description copied from interface: SolrInfoMBean
Simple common usage version, e.g. 2.0

Specified by:
getVersion in interface SolrInfoMBean
Specified by:
getVersion in class RequestHandlerBase

getDescription

public java.lang.String getDescription()
Description copied from interface: SolrInfoMBean
Simple one or two line description

Specified by:
getDescription in interface SolrInfoMBean
Specified by:
getDescription in class RequestHandlerBase

getSourceId

public java.lang.String getSourceId()
Description copied from interface: SolrInfoMBean
CVS Id, SVN Id, etc

Specified by:
getSourceId in interface SolrInfoMBean
Specified by:
getSourceId in class RequestHandlerBase

getSource

public java.lang.String getSource()
Description copied from interface: SolrInfoMBean
CVS Source, SVN Source, etc

Specified by:
getSource in interface SolrInfoMBean
Specified by:
getSource in class RequestHandlerBase

getDocs

public java.net.URL[] getDocs()
Description copied from interface: SolrInfoMBean
Documentation URL list.

Suggested documentation URLs: Homepage for sponsoring project, FAQ on class usage, Design doc for class, Wiki, bug reporting URL, etc...

Specified by:
getDocs in interface SolrInfoMBean
Overrides:
getDocs in class RequestHandlerBase


Copyright © 2006 - 2009 The Apache Software Foundation