org.apache.solr.handler.component

Class StatsField

java.lang.Object

org.apache.solr.handler.component.StatsField

public class StatsField
extends Object

Models all of the information associated with a single StatsParams.STATS_FIELD instance.

See Also:

StatsComponent

Constructor Summary

Constructors

Constructor and Description
StatsField(ResponseBuilder rb, String statsParam)

Method Summary

Methods

Modifier and Type	Method and Description
DocSet	computeBaseDocSet() Computes a base DocSet for the current request to be used when computing global stats for the local index.
StatsValues	computeLocalStatsValues(DocSet base) Computes the StatsValues for this StatsField relative to the specified DocSet
boolean	getCalcDistinct() Whether or not the effective value of the StatsParams.STATS_CALC_DISTINCT param is true or false for this StatsField
String	getOutputKey() The key to be used when refering to this StatsField instance in the response tp clients.
SchemaField	getSchemaField() The SchemaField whose results these stats are computed over, may be null if the stats are computed over the results of a function or query
SolrIndexSearcher	getSearcher() The searcher that should be used for processing local stats
List<String>	getTagList()
ValueSource	getValueSource() The ValueSource of a function or query whose results these stats are computed over, may be null if the stats are directly over a SchemaField
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

StatsField

public StatsField(ResponseBuilder rb,
          String statsParam)

Parameters:

rb - the current request/response

statsParam - the raw StatsParams.STATS_FIELD string

Method Detail

getOutputKey

public String getOutputKey()

The key to be used when refering to this StatsField instance in the response tp clients.

computeBaseDocSet

public DocSet computeBaseDocSet()
                         throws IOException

Computes a base DocSet for the current request to be used when computing global stats for the local index. This is typically the same as the main DocSet for the ResponseBuilder unless tagged filter queries have been excluded using the ex local param

Throws:

IOException

computeLocalStatsValues

public StatsValues computeLocalStatsValues(DocSet base)
                                    throws IOException

Computes the StatsValues for this StatsField relative to the specified DocSet

Throws:

IOException

See Also:

computeBaseDocSet()

getSearcher

public SolrIndexSearcher getSearcher()

The searcher that should be used for processing local stats

See Also:

SolrQueryRequest.getSearcher()

getSchemaField

public SchemaField getSchemaField()

The SchemaField whose results these stats are computed over, may be null if the stats are computed over the results of a function or query

See Also:

getValueSource()

getValueSource

public ValueSource getValueSource()

The ValueSource of a function or query whose results these stats are computed over, may be null if the stats are directly over a SchemaField

See Also:

getValueSource()

getCalcDistinct

public boolean getCalcDistinct()

Whether or not the effective value of the StatsParams.STATS_CALC_DISTINCT param is true or false for this StatsField

getTagList

public List<String> getTagList()

toString

public String toString()

Overrides:

toString in class Object