org.apache.solr.handler.component

Class SearchComponent

java.lang.Object

org.apache.solr.handler.component.SearchComponent

All Implemented Interfaces:

SolrInfoMBean, NamedListInitializedPlugin

Direct Known Subclasses:

DebugComponent, FacetComponent, HighlightComponent, MoreLikeThisComponent, QueryComponent, QueryElevationComponent, SpellCheckComponent, StatsComponent, TermsComponent, TermVectorComponent

public abstract class SearchComponent
extends java.lang.Object
implements SolrInfoMBean, NamedListInitializedPlugin

TODO!

Since:

solr 1.3

Version:

$Id: SearchComponent.java 1052938 2010-12-26 20:21:48Z rmuir $

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoMBean

SolrInfoMBean.Category

Constructor Summary

Constructors

Constructor and Description
SearchComponent()

Method Summary

Modifier and Type	Method and Description
int	distributedProcess(ResponseBuilder rb) Process for a distributed search.
void	finishStage(ResponseBuilder rb) Called after all responses have been received for this stage.
SolrInfoMBean.Category	getCategory() Purpose of this Class
abstract java.lang.String	getDescription() Simple one or two line description
java.net.URL[]	getDocs() Documentation URL list.
java.lang.String	getName() Simple common usage name, e.g.
abstract java.lang.String	getSource() CVS Source, SVN Source, etc
abstract java.lang.String	getSourceId() CVS Id, SVN Id, etc
NamedList	getStatistics() Any statistics this instance would like to be publicly available via the Solr Administration interface.
abstract java.lang.String	getVersion() Simple common usage version, e.g.
void	handleResponses(ResponseBuilder rb, ShardRequest sreq) Called after all responses for a single request were received
void	init(NamedList args)
void	modifyRequest(ResponseBuilder rb, SearchComponent who, ShardRequest sreq) Called after another component adds a request
abstract void	prepare(ResponseBuilder rb) Prepare the response.
abstract void	process(ResponseBuilder rb) Process the request for this component

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchComponent

public SearchComponent()

Method Detail

prepare

public abstract void prepare(ResponseBuilder rb)
                      throws java.io.IOException

Prepare the response. Guaranteed to be called before any SearchComponent process(org.apache.solr.handler.component.ResponseBuilder) method. Called for every incoming request. The place to do initialization that is request dependent.

Parameters:

rb - The ResponseBuilder

Throws:

java.io.IOException

process

public abstract void process(ResponseBuilder rb)
                      throws java.io.IOException

Process the request for this component

Parameters:

rb - The ResponseBuilder

Throws:

java.io.IOException

distributedProcess

public int distributedProcess(ResponseBuilder rb)
                       throws java.io.IOException

Process for a distributed search.

Returns:

the next stage for this component

Throws:

java.io.IOException

modifyRequest

public void modifyRequest(ResponseBuilder rb,
                          SearchComponent who,
                          ShardRequest sreq)

Called after another component adds a request

handleResponses

public void handleResponses(ResponseBuilder rb,
                            ShardRequest sreq)

Called after all responses for a single request were received

finishStage

public void finishStage(ResponseBuilder rb)

Called after all responses have been received for this stage. Useful when different requests are sent to each shard.

init

public void init(NamedList args)

Specified by:

init in interface NamedListInitializedPlugin

getName

public java.lang.String getName()

Description copied from interface: SolrInfoMBean

Simple common usage name, e.g. BasicQueryHandler, or fully qualified clas name.

Specified by:

getName in interface SolrInfoMBean

getDescription

public abstract java.lang.String getDescription()

Description copied from interface: SolrInfoMBean

Simple one or two line description

Specified by:

getDescription in interface SolrInfoMBean

getSourceId

public abstract java.lang.String getSourceId()

Description copied from interface: SolrInfoMBean

CVS Id, SVN Id, etc

Specified by:

getSourceId in interface SolrInfoMBean

getSource

public abstract java.lang.String getSource()

Description copied from interface: SolrInfoMBean

CVS Source, SVN Source, etc

Specified by:

getSource in interface SolrInfoMBean

getVersion

public abstract java.lang.String getVersion()

Description copied from interface: SolrInfoMBean

Simple common usage version, e.g. 2.0

Specified by:

getVersion in interface SolrInfoMBean

getCategory

public SolrInfoMBean.Category getCategory()

Description copied from interface: SolrInfoMBean

Purpose of this Class

Specified by:

getCategory in interface SolrInfoMBean

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

getStatistics

public NamedList getStatistics()

Description copied from interface: SolrInfoMBean

Any statistics this instance would like to be publicly available via the Solr Administration interface.

Any Object type may be stored in the list, but only the toString() representation will be used.

Specified by:

getStatistics in interface SolrInfoMBean