org.apache.solr.highlight

Class HighlightingPluginBase

java.lang.Object

org.apache.solr.highlight.HighlightingPluginBase

All Implemented Interfaces:

AutoCloseable, SolrInfoBean, SolrMetricProducer

Direct Known Subclasses:

DefaultEncoder, GapFragmenter, HtmlEncoder, HtmlFormatter, RegexFragmenter, SimpleFragListBuilder, SingleFragListBuilder, SolrBoundaryScanner, SolrFragmentsBuilder, WeightedFragListBuilder

public abstract class HighlightingPluginBase
extends Object
implements SolrInfoBean, SolrMetricProducer

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 and Description
protected SolrParams	defaults
protected SolrMetricManager	metricManager
protected Set<String>	metricNames
protected com.codahale.metrics.Counter	numRequests
protected com.codahale.metrics.MetricRegistry	registry
protected String	registryName

Constructor Summary

Constructors

Constructor and Description
HighlightingPluginBase()

Method Summary

Modifier and Type	Method and Description
SolrInfoBean.Category	getCategory() Category of this component
abstract String	getDescription() Simple one or two line description
Set<String>	getMetricNames() Modifiable set of metric names that this component reports (default is null, which means none).
com.codahale.metrics.MetricRegistry	getMetricRegistry() An instance of MetricRegistry that this component uses for metrics reporting (default is null, which means no registry).
String	getName() Simple common usage name, e.g.
void	init(NamedList args)
void	initializeMetrics(SolrMetricManager manager, String registryName, String tag, String scope) Initializes metrics specific to this producer

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

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

close, getSolrMetricsContext, getUniqueMetricTag, initializeMetrics

Field Detail

numRequests

protected com.codahale.metrics.Counter numRequests

defaults

protected SolrParams defaults

metricNames

protected Set<String> metricNames

registry

protected com.codahale.metrics.MetricRegistry registry

metricManager

protected SolrMetricManager metricManager

registryName

protected String registryName

Constructor Detail

HighlightingPluginBase

public HighlightingPluginBase()

Method Detail

init

public void init(NamedList args)

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

getMetricNames

public Set<String> getMetricNames()

Description copied from interface: SolrInfoBean

Modifiable set of metric names that this component reports (default is null, which means none). If not null then this set is used by SolrInfoBean.registerMetricName(String) to capture what metrics names are reported from this component.

NOTE: this set has to allow iteration under modifications.

Specified by:

getMetricNames in interface SolrInfoBean

getMetricRegistry

public com.codahale.metrics.MetricRegistry getMetricRegistry()

Description copied from interface: SolrInfoBean

An instance of MetricRegistry that this component uses for metrics reporting (default is null, which means no registry).

Specified by:

getMetricRegistry in interface SolrInfoBean

initializeMetrics

public void initializeMetrics(SolrMetricManager manager,
                              String registryName,
                              String tag,
                              String scope)

Description copied from interface: SolrMetricProducer

Initializes metrics specific to this producer

Specified by:

initializeMetrics in interface SolrMetricProducer

Parameters:

manager - an instance of SolrMetricManager

registryName - registry name where metrics are registered

tag - a symbolic tag that represents this instance of the producer, or a group of related instances that have the same life-cycle. This tag is used when managing life-cycle of some metrics.

scope - scope of the metrics (eg. handler name) to separate metrics of components with the same implementation but different scope.