|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.solr.handler.component.SearchComponent
public abstract class SearchComponent
TODO!
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoMBean |
---|
SolrInfoMBean.Category |
Constructor Summary | |
---|---|
SearchComponent()
|
Method Summary | |
---|---|
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 String |
getDescription()
Simple one or two line description |
URL[] |
getDocs()
Documentation URL list. |
String |
getName()
Simple common usage name, e.g. |
abstract String |
getSource()
CVS Source, SVN Source, etc |
NamedList |
getStatistics()
Any statistics this instance would like to be publicly available via the Solr Administration interface. |
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 |
void |
setName(String name)
Sets the name of the SearchComponent. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SearchComponent()
Method Detail |
---|
public abstract void prepare(ResponseBuilder rb) throws 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
IOException
- If there is a low-level I/O error.public abstract void process(ResponseBuilder rb) throws IOException
rb
- The ResponseBuilder
IOException
- If there is a low-level I/O error.public int distributedProcess(ResponseBuilder rb) throws IOException
IOException
public void modifyRequest(ResponseBuilder rb, SearchComponent who, ShardRequest sreq)
public void handleResponses(ResponseBuilder rb, ShardRequest sreq)
public void finishStage(ResponseBuilder rb)
public void setName(String name)
public void init(NamedList args)
init
in interface NamedListInitializedPlugin
public String getName()
SolrInfoMBean
getName
in interface SolrInfoMBean
public abstract String getDescription()
SolrInfoMBean
getDescription
in interface SolrInfoMBean
public abstract String getSource()
SolrInfoMBean
getSource
in interface SolrInfoMBean
public String getVersion()
SolrInfoMBean
getVersion
in interface SolrInfoMBean
public SolrInfoMBean.Category getCategory()
SolrInfoMBean
getCategory
in interface SolrInfoMBean
public 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
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |