org.apache.solr.request
Class DisMaxRequestHandler

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

public class DisMaxRequestHandler
extends RequestHandlerBase

A Generic query plugin designed to be given a simple query expression from a user, which it will then query against a variety of pre-configured fields, in a variety of ways, using BooleanQueries, DisjunctionMaxQueries, and PhraseQueries.

All of the following options may be configured for this plugin in the solrconfig as defaults, and may be overriden as request parameters

The following options are only available as request params...

 :TODO: document facet param support

 


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
DisMaxRequestHandler()
           
 
Method Summary
 java.lang.String getDescription()
          Simple one or two line description
 java.net.URL[] getDocs()
          Documentation URL list.
protected  NamedList getFacetInfo(SolrQueryRequest req, SolrQueryResponse rsp, DocSet mainSet)
          Fetches information about Facets for this request.
 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)
          Sets the default variables for any useful info it finds in the config.
 
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

DisMaxRequestHandler

public DisMaxRequestHandler()
Method Detail

init

public void init(NamedList args)
Sets the default variables for any useful info it finds in the config. If a config option is not in the format expected, logs a warning and ignores it.

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

getFacetInfo

protected NamedList getFacetInfo(SolrQueryRequest req,
                                 SolrQueryResponse rsp,
                                 DocSet mainSet)
Fetches information about Facets for this request. Subclasses may with to override this method to provide more advanced faceting behavior.

See Also:
SimpleFacets.getFacetCounts()

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

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

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 - 2008 The Apache Software Foundation