org.apache.solr.handler.component
Class SuggestComponent

java.lang.Object
  org.apache.solr.handler.component.SearchComponent
      org.apache.solr.handler.component.SuggestComponent

All Implemented Interfaces:

SolrInfoMBean, SuggesterParams, NamedListInitializedPlugin, SolrCoreAware

public class SuggestComponent
extends SearchComponent
implements SolrCoreAware, SuggesterParams

SuggestComponent: interacts with multiple SolrSuggester to serve up suggestions Responsible for routing commands and queries to the appropriate SolrSuggester and for initializing them as specified by SolrConfig

Nested Class Summary

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

SolrInfoMBean.Category

Field Summary

static String	COMPONENT_NAME Name used to identify whether the user query concerns this component
protected NamedList	initParams
protected Map<String,SolrSuggester>	suggesters Key is the dictionary name used in SolrConfig, value is the corrosponding SolrSuggester

Fields inherited from interface org.apache.solr.spelling.suggest.SuggesterParams

SUGGEST_BUILD, SUGGEST_BUILD_ALL, SUGGEST_COUNT, SUGGEST_DICT, SUGGEST_PREFIX, SUGGEST_Q, SUGGEST_RELOAD, SUGGEST_RELOAD_ALL

Constructor Summary

SuggestComponent()

Method Summary

int	distributedProcess(ResponseBuilder rb) Dispatch shard request in STAGE_EXECUTE_QUERY stage
void	finishStage(ResponseBuilder rb) Used in Distributed Search, merges the suggestion results from every shard
String	getDescription() Simple one or two line description
String	getSource() CVS Source, SVN Source, etc
NamedList	getStatistics() Any statistics this instance would like to be publicly available via the Solr Administration interface.
void	inform(SolrCore core)
void	init(NamedList args)
void	prepare(ResponseBuilder rb) Responsible for issuing build and rebload command to the specified SolrSuggester
void	process(ResponseBuilder rb) Responsible for using the specified suggester to get the suggestions for the query and write the results
long	sizeInBytes() Returns the total size of all the suggester

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

getCategory, getDocs, getName, getVersion, handleResponses, modifyRequest, setName

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 String COMPONENT_NAME

Name used to identify whether the user query concerns this component

See Also:

Constant Field Values

initParams

protected NamedList initParams

suggesters

protected Map<String,SolrSuggester> suggesters

Key is the dictionary name used in SolrConfig, value is the corrosponding SolrSuggester

Constructor Detail

SuggestComponent

public SuggestComponent()

Method Detail

init

public void init(NamedList args)

Specified by:

init in interface NamedListInitializedPlugin

Overrides:

init in class SearchComponent

inform

public void inform(SolrCore core)

Specified by:

inform in interface SolrCoreAware

prepare

public void prepare(ResponseBuilder rb)
             throws IOException

Responsible for issuing build and rebload command to the specified SolrSuggester

Specified by:

prepare in class SearchComponent

Parameters:

rb - The ResponseBuilder

Throws:

IOException - If there is a low-level I/O error.

distributedProcess

public int distributedProcess(ResponseBuilder rb)

Dispatch shard request in STAGE_EXECUTE_QUERY stage

Overrides:

distributedProcess in class SearchComponent

Returns:

the next stage for this component

process

public void process(ResponseBuilder rb)
             throws IOException

Responsible for using the specified suggester to get the suggestions for the query and write the results

Specified by:

process in class SearchComponent

Parameters:

rb - The ResponseBuilder

Throws:

IOException - If there is a low-level I/O error.

finishStage

public void finishStage(ResponseBuilder rb)

Used in Distributed Search, merges the suggestion results from every shard

Overrides:

finishStage in class SearchComponent

getDescription

public 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

getSource

public String getSource()

Description copied from interface: SolrInfoMBean

CVS Source, SVN Source, etc

Specified by:

getSource in interface SolrInfoMBean

Specified by:

getSource in class SearchComponent

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

Overrides:

getStatistics in class SearchComponent

sizeInBytes

public long sizeInBytes()

Returns the total size of all the suggester