Class StatsComponent
java.lang.Object
org.apache.solr.handler.component.SearchComponent
org.apache.solr.handler.component.StatsComponent
- All Implemented Interfaces:
AutoCloseable,SolrInfoBean,SolrMetricProducer,NamedListInitializedPlugin
Stats component calculates simple statistics on numeric field values
- Since:
- solr 1.4
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoBean
SolrInfoBean.Category, SolrInfoBean.Group -
Field Summary
FieldsFields inherited from class org.apache.solr.handler.component.SearchComponent
solrMetricsContext, standard_componentsFields 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 -
Method Summary
Modifier and TypeMethodDescriptionstatic org.apache.solr.common.util.NamedList<org.apache.solr.common.util.NamedList<org.apache.solr.common.util.NamedList<?>>> convertToResponse(Map<String, StatsValues> statsValues) Given a map ofStatsValuesusing the appropriate response key, builds up the necessary "stats" data structure for including in the response -- including the esoteric "stats_fields" wrapper.intProcess for a distributed search.voidCalled after all responses have been received for this stage.Simple one or two line descriptionvoidhandleResponses(ResponseBuilder rb, ShardRequest sreq) Called after all responses for a single request were receivedvoidmodifyRequest(ResponseBuilder rb, SearchComponent who, ShardRequest sreq) Called after another component adds a requestvoidPrepare the response.voidProcess the request for this componentstatic org.apache.solr.common.util.NamedList<org.apache.solr.common.util.NamedList<?>> unwrapStats(org.apache.solr.common.util.NamedList<org.apache.solr.common.util.NamedList<org.apache.solr.common.util.NamedList<?>>> stats) Helper to pull the "stats_fields" out of the extra "stats" wrapperMethods inherited from class org.apache.solr.handler.component.SearchComponent
getCategory, getName, getSolrMetricsContext, initializeMetrics, setNameMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.solr.util.plugin.NamedListInitializedPlugin
initMethods inherited from interface org.apache.solr.metrics.SolrMetricProducer
close
-
Field Details
-
COMPONENT_NAME
- See Also:
-
-
Constructor Details
-
StatsComponent
public StatsComponent()
-
-
Method Details
-
prepare
Description copied from class:SearchComponentPrepare the response. Guaranteed to be called before any SearchComponentSearchComponent.process(org.apache.solr.handler.component.ResponseBuilder)method. Called for every incoming request.The place to do initialization that is request dependent.
- Specified by:
preparein classSearchComponent- Parameters:
rb- TheResponseBuilder- Throws:
IOException- If there is a low-level I/O error.
-
process
Description copied from class:SearchComponentProcess the request for this component- Specified by:
processin classSearchComponent- Parameters:
rb- TheResponseBuilder- Throws:
IOException- If there is a low-level I/O error.
-
distributedProcess
Description copied from class:SearchComponentProcess for a distributed search.- Overrides:
distributedProcessin classSearchComponent- Returns:
- the next stage for this component
- Throws:
IOException
-
modifyRequest
Description copied from class:SearchComponentCalled after another component adds a request- Overrides:
modifyRequestin classSearchComponent
-
handleResponses
Description copied from class:SearchComponentCalled after all responses for a single request were received- Overrides:
handleResponsesin classSearchComponent
-
finishStage
Description copied from class:SearchComponentCalled after all responses have been received for this stage. Useful when different requests are sent to each shard.- Overrides:
finishStagein classSearchComponent
-
unwrapStats
public static org.apache.solr.common.util.NamedList<org.apache.solr.common.util.NamedList<?>> unwrapStats(org.apache.solr.common.util.NamedList<org.apache.solr.common.util.NamedList<org.apache.solr.common.util.NamedList<?>>> stats) Helper to pull the "stats_fields" out of the extra "stats" wrapper -
convertToResponse
public static org.apache.solr.common.util.NamedList<org.apache.solr.common.util.NamedList<org.apache.solr.common.util.NamedList<?>>> convertToResponse(Map<String, StatsValues> statsValues) Given a map ofStatsValuesusing the appropriate response key, builds up the necessary "stats" data structure for including in the response -- including the esoteric "stats_fields" wrapper. -
getDescription
Description copied from interface:SolrInfoBeanSimple one or two line description- Specified by:
getDescriptionin interfaceSolrInfoBean- Specified by:
getDescriptionin classSearchComponent
-