org.apache.solr.handler.component

Class TermsComponent

java.lang.Object

org.apache.solr.handler.component.SearchComponent

org.apache.solr.handler.component.TermsComponent

All Implemented Interfaces:

SolrInfoBean, NamedListInitializedPlugin

public class TermsComponent
extends SearchComponent

Return TermEnum information, useful for things like auto suggest.

 <searchComponent name="termsComponent" class="solr.TermsComponent"/>

 <requestHandler name="/terms" class="solr.SearchHandler">
   <lst name="defaults">
     <bool name="terms">true</bool>
   </lst>
   <arr name="components">
     <str>termsComponent</str>
   </arr>
 </requestHandler>

See Also:

See Lucene's TermEnum class

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TermsComponent.TermCountComparator Comparator for TermsResponse.Term sorting This sorts term by frequency in descending order
static class	TermsComponent.TermsHelper

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

SolrInfoBean.Category, SolrInfoBean.Group

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_NAME
static int	UNLIMITED_MAX_COUNT

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

metricNames, registry, standard_components

Constructor Summary

Constructors

Constructor and Description
TermsComponent()

Method Summary

Modifier and Type	Method and Description
protected void	checkShardsWhitelist(ResponseBuilder rb, List<String> lst)
int	distributedProcess(ResponseBuilder rb) Process for a distributed search.
void	finishStage(ResponseBuilder rb) Called after all responses have been received for this stage.
SolrInfoBean.Category	getCategory() Category of this component
String	getDescription() Simple one or two line description
void	handleResponses(ResponseBuilder rb, ShardRequest sreq) Called after all responses for a single request were received
void	init(NamedList args)
void	prepare(ResponseBuilder rb) Prepare the response.
void	process(ResponseBuilder rb) Process the request for this component

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

getMetricNames, getMetricRegistry, getName, modifyRequest, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.solr.core.SolrInfoBean

getMetricsSnapshot, registerMetricName

Field Detail

UNLIMITED_MAX_COUNT

public static final int UNLIMITED_MAX_COUNT

See Also:

Constant Field Values

COMPONENT_NAME

public static final String COMPONENT_NAME

See Also:

Constant Field Values

Constructor Detail

TermsComponent

public TermsComponent()

Method Detail

init

public void init(NamedList args)

Specified by:

init in interface NamedListInitializedPlugin

Overrides:

init in class SearchComponent

prepare

public void prepare(ResponseBuilder rb)
             throws 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:

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

checkShardsWhitelist

protected void checkShardsWhitelist(ResponseBuilder rb,
                                    List<String> lst)

process

public void process(ResponseBuilder rb)
             throws IOException

Description copied from class: SearchComponent

Process the request for this component

Specified by:

process in class SearchComponent

Parameters:

rb - The ResponseBuilder

Throws:

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

distributedProcess

public int distributedProcess(ResponseBuilder rb)
                       throws IOException

Description copied from class: SearchComponent

Process for a distributed search.

Overrides:

distributedProcess in class SearchComponent

Returns:

the next stage for this component

Throws:

IOException

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

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

getDescription

public String getDescription()

Description copied from interface: SolrInfoBean

Simple one or two line description

Specified by:

getDescription in interface SolrInfoBean

Specified by:

getDescription in class SearchComponent

getCategory

public SolrInfoBean.Category getCategory()

Description copied from interface: SolrInfoBean

Category of this component

Specified by:

getCategory in interface SolrInfoBean

Overrides:

getCategory in class SearchComponent