Package org.apache.solr.handler.component

Class SearchComponent

java.lang.Object

org.apache.solr.handler.component.SearchComponent

All Implemented Interfaces:

AutoCloseable, SolrInfoBean, SolrMetricProducer, NamedListInitializedPlugin

Direct Known Subclasses:

ActiveTasksListComponent, DebugComponent, ExpandComponent, FacetComponent, FacetModule, HighlightComponent, MoreLikeThisComponent, PhrasesIdentificationComponent, QueryCancellationComponent, QueryComponent, QueryElevationComponent, RealTimeGetComponent, ResponseLogComponent, SpellCheckComponent, StatsComponent, SuggestComponent, TermsComponent, TermVectorComponent

public abstract class SearchComponent
extends Object
implements SolrInfoBean, NamedListInitializedPlugin

TODO!

Since:

solr 1.3

Nested Class Summary

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

SolrInfoBean.Category, SolrInfoBean.Group

Field Summary

Fields

Modifier and Type	Field	Description
protected SolrMetricsContext	solrMetricsContext
static final Map<String,Class<? extends SearchComponent>>	standard_components

Fields inherited from interface org.apache.solr.metrics.SolrMetricProducer

CATEGORY_ATTR, HANDLER_ATTR, NAME_ATTR, OPERATION_ATTR, PLUGIN_NAME_ATTR, RESULT_ATTR, TYPE_ATTR

Constructor Summary

Constructors

Constructor	Description
SearchComponent()

Method Summary

Modifier and Type	Method	Description
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
abstract String	getDescription()	Simple one or two line description
String	getName()	Simple common usage name, e.g.
SolrMetricsContext	getSolrMetricsContext()	Implementations should return the context used in SolrMetricProducer.initializeMetrics(SolrMetricsContext, Attributes) to ensure proper cleanup of metrics at the end of the life-cycle of this component.
void	handleResponses(ResponseBuilder rb, ShardRequest sreq)	Called after all responses for a single request were received
void	initializeMetrics(SolrMetricsContext parentContext, io.opentelemetry.api.common.Attributes attributes)	Implementation should initialize all metrics to a SolrMetricsContext Registry/MeterProvider with Attributes as the common set of attributes that will be attached to every metric that is initialized for that class/component
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

Methods inherited from interface org.apache.solr.util.plugin.NamedListInitializedPlugin

init

Methods inherited from interface org.apache.solr.metrics.SolrMetricProducer

close

Field Details

solrMetricsContext

protected SolrMetricsContext solrMetricsContext

standard_components

public static final Map<String,Class<? extends SearchComponent>> standard_components

Constructor Details

SearchComponent

public SearchComponent()

Method Details

prepare

public abstract void prepare(ResponseBuilder rb)
                      throws IOException

Prepare the response. Guaranteed to be called before any SearchComponent process(org.apache.solr.handler.component.ResponseBuilder) method. Called for every incoming request.

The place to do initialization that is request dependent.

Parameters:

rb - The ResponseBuilder

Throws:

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

process

public abstract void process(ResponseBuilder rb)
                      throws IOException

Process the request for this component

Parameters:

rb - The ResponseBuilder

Throws:

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

distributedProcess

public int distributedProcess(ResponseBuilder rb)
                       throws IOException

Process for a distributed search.

Returns:

the next stage for this component

Throws:

IOException

modifyRequest

public void modifyRequest(ResponseBuilder rb,
 SearchComponent who,
 ShardRequest sreq)

Called after another component adds a request

handleResponses

public void handleResponses(ResponseBuilder rb,
 ShardRequest sreq)

Called after all responses for a single request were received

finishStage

public void finishStage(ResponseBuilder rb)

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

setName

public void setName(String name)

Sets the name of the SearchComponent. The name of the component is usually the name defined for it in the configuration.

getName

public String getName()

Description copied from interface: SolrInfoBean

Simple common usage name, e.g. BasicQueryHandler, or fully qualified class name.

Specified by:

getName in interface SolrInfoBean

getDescription

public abstract String getDescription()

Description copied from interface: SolrInfoBean

Simple one or two line description

Specified by:

getDescription in interface SolrInfoBean

getCategory

public SolrInfoBean.Category getCategory()

Description copied from interface: SolrInfoBean

Category of this component

Specified by:

getCategory in interface SolrInfoBean

getSolrMetricsContext

public SolrMetricsContext getSolrMetricsContext()

Description copied from interface: SolrMetricProducer

Implementations should return the context used in SolrMetricProducer.initializeMetrics(SolrMetricsContext, Attributes) to ensure proper cleanup of metrics at the end of the life-cycle of this component. This should be the child context if one was created, or null if the parent context was used.

Specified by:

getSolrMetricsContext in interface SolrMetricProducer

initializeMetrics

public void initializeMetrics(SolrMetricsContext parentContext,
 io.opentelemetry.api.common.Attributes attributes)

Description copied from interface: SolrMetricProducer

Implementation should initialize all metrics to a SolrMetricsContext Registry/MeterProvider with Attributes as the common set of attributes that will be attached to every metric that is initialized for that class/component

Specified by:

initializeMetrics in interface SolrMetricProducer

Parameters:

parentContext - The registry that the component will initialize metrics to

attributes - Base set of attributes that will be bound to all metrics for that component