public abstract class SearchComponent extends java.lang.Object implements SolrInfoMBean, NamedListInitializedPlugin
SolrInfoMBean.Category
Constructor and Description |
---|
SearchComponent() |
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
|
public abstract void prepare(ResponseBuilder rb) throws java.io.IOException
process(org.apache.solr.handler.component.ResponseBuilder)
method.
Called for every incoming request.
The place to do initialization that is request dependent.rb
- The ResponseBuilder
java.io.IOException
public abstract void process(ResponseBuilder rb) throws java.io.IOException
rb
- The ResponseBuilder
java.io.IOException
public int distributedProcess(ResponseBuilder rb) throws java.io.IOException
java.io.IOException
public void modifyRequest(ResponseBuilder rb, SearchComponent who, ShardRequest sreq)
public void handleResponses(ResponseBuilder rb, ShardRequest sreq)
public void finishStage(ResponseBuilder rb)
public void init(NamedList args)
init
in interface NamedListInitializedPlugin
public java.lang.String getName()
SolrInfoMBean
getName
in interface SolrInfoMBean
public abstract java.lang.String getDescription()
SolrInfoMBean
getDescription
in interface SolrInfoMBean
public abstract java.lang.String getSourceId()
SolrInfoMBean
getSourceId
in interface SolrInfoMBean
public abstract java.lang.String getSource()
SolrInfoMBean
getSource
in interface SolrInfoMBean
public abstract java.lang.String getVersion()
SolrInfoMBean
getVersion
in interface SolrInfoMBean
public SolrInfoMBean.Category getCategory()
SolrInfoMBean
getCategory
in interface SolrInfoMBean
public java.net.URL[] getDocs()
SolrInfoMBean
Suggested documentation URLs: Homepage for sponsoring project, FAQ on class usage, Design doc for class, Wiki, bug reporting URL, etc...
getDocs
in interface SolrInfoMBean
public NamedList getStatistics()
SolrInfoMBean
Any Object type may be stored in the list, but only the
toString()
representation will be used.
getStatistics
in interface SolrInfoMBean