org.apache.solr.handler.component

Class QueryComponent

java.lang.Object

org.apache.solr.handler.component.SearchComponent

org.apache.solr.handler.component.QueryComponent

All Implemented Interfaces:

SolrInfoMBean, NamedListInitializedPlugin

public class QueryComponent
extends SearchComponent

TODO!

Since:

solr 1.3

Version:

$Id: QueryComponent.java 1338227 2012-05-14 14:38:37Z mvg $

Nested Class Summary

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

SolrInfoMBean.Category

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT_NAME
private static EndResultTransformer	MAIN_END_RESULT_TRANSFORMER
private static EndResultTransformer	SIMPLE_END_RESULT_TRANSFORMER

Constructor Summary

Constructors

Constructor and Description
QueryComponent()

Method Summary

Modifier and Type	Method and Description
private void	createDistributedIdf(ResponseBuilder rb)
private void	createMainQuery(ResponseBuilder rb)
private void	createRetrieveDocs(ResponseBuilder rb)
int	distributedProcess(ResponseBuilder rb) Process for a distributed search.
protected void	doFieldSortValues(ResponseBuilder rb, SolrIndexSearcher searcher)
protected void	doPrefetch(ResponseBuilder rb)
void	finishStage(ResponseBuilder rb) Called after all responses have been received for this stage.
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.
private int	groupedDistributedProcess(ResponseBuilder rb)
private void	groupedFinishStage(ResponseBuilder rb)
private void	handleGroupedResponses(ResponseBuilder rb, ShardRequest sreq)
private void	handleRegularResponses(ResponseBuilder rb, ShardRequest sreq)
void	handleResponses(ResponseBuilder rb, ShardRequest sreq) Called after all responses for a single request were received
private void	mergeIds(ResponseBuilder rb, ShardRequest sreq)
void	prepare(ResponseBuilder rb) Prepare the response.
void	process(ResponseBuilder rb) Actually run the query
private int	regularDistributedProcess(ResponseBuilder rb)
private void	regularFinishStage(ResponseBuilder rb)
private void	returnFields(ResponseBuilder rb, ShardRequest sreq)

Methods inherited from class org.apache.solr.handler.component.SearchComponent

getCategory, getName, getStatistics, init, modifyRequest

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_NAME

public static final java.lang.String COMPONENT_NAME

See Also:

Constant Field Values

MAIN_END_RESULT_TRANSFORMER

private static final EndResultTransformer MAIN_END_RESULT_TRANSFORMER

SIMPLE_END_RESULT_TRANSFORMER

private static final EndResultTransformer SIMPLE_END_RESULT_TRANSFORMER

Constructor Detail

QueryComponent

public QueryComponent()

Method Detail

prepare

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

Description copied from class: SearchComponent

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

Specified by:

prepare in class SearchComponent

Parameters:

rb - The ResponseBuilder

Throws:

java.io.IOException

process

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

Actually run the query

Specified by:

process in class SearchComponent

Parameters:

rb - The ResponseBuilder

Throws:

java.io.IOException

doFieldSortValues

protected void doFieldSortValues(ResponseBuilder rb,
                                 SolrIndexSearcher searcher)
                          throws java.io.IOException

Throws:

java.io.IOException

doPrefetch

protected void doPrefetch(ResponseBuilder rb)
                   throws java.io.IOException

Throws:

java.io.IOException

distributedProcess

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

Description copied from class: SearchComponent

Process for a distributed search.

Overrides:

distributedProcess in class SearchComponent

Returns:

the next stage for this component

Throws:

java.io.IOException

groupedDistributedProcess

private int groupedDistributedProcess(ResponseBuilder rb)

regularDistributedProcess

private int regularDistributedProcess(ResponseBuilder rb)

handleResponses

public void handleResponses(ResponseBuilder rb,
                            ShardRequest sreq)

Description copied from class: SearchComponent

Called after all responses for a single request were received

Overrides:

handleResponses in class SearchComponent

handleGroupedResponses

private void handleGroupedResponses(ResponseBuilder rb,
                                    ShardRequest sreq)

handleRegularResponses

private void handleRegularResponses(ResponseBuilder rb,
                                    ShardRequest sreq)

finishStage

public void finishStage(ResponseBuilder rb)

Description copied from class: SearchComponent

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

Overrides:

finishStage in class SearchComponent

groupedFinishStage

private void groupedFinishStage(ResponseBuilder rb)

regularFinishStage

private void regularFinishStage(ResponseBuilder rb)

createDistributedIdf

private void createDistributedIdf(ResponseBuilder rb)

createMainQuery

private void createMainQuery(ResponseBuilder rb)

mergeIds

private void mergeIds(ResponseBuilder rb,
                      ShardRequest sreq)

createRetrieveDocs

private void createRetrieveDocs(ResponseBuilder rb)

returnFields

private void returnFields(ResponseBuilder rb,
                          ShardRequest sreq)

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 SearchComponent

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 SearchComponent

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 SearchComponent

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 SearchComponent

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 SearchComponent