Package 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

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 SolrParams	defaults
protected Set<String>	metricNames
protected com.codahale.metrics.Counter	numRequests
protected SolrMetricsContext	solrMetricsContext

Constructor Summary

Constructors

Constructor	Description
HighlightingPluginBase()

Method Summary

Modifier and Type	Method	Description
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, String) to ensure proper cleanup of metrics at the end of the life-cycle of this component.
void	init(NamedList<?> args)
void	initializeMetrics(SolrMetricsContext parentContext, String scope)	Initialize 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.metrics.SolrMetricProducer

close

Field Detail

numRequests

protected com.codahale.metrics.Counter numRequests

defaults

protected SolrParams defaults

metricNames

protected Set<String> metricNames

solrMetricsContext

protected SolrMetricsContext solrMetricsContext

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

getSolrMetricsContext

public SolrMetricsContext getSolrMetricsContext()

Description copied from interface: SolrMetricProducer

Implementations should return the context used in SolrMetricProducer.initializeMetrics(SolrMetricsContext, String) 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,
                              String scope)

Description copied from interface: SolrMetricProducer

Initialize metrics specific to this producer.

Specified by:

initializeMetrics in interface SolrMetricProducer

Parameters:

parentContext - parent metrics context. If this component has the same life-cycle as the parent it can simply use the parent context, otherwise it should obtain a child context using SolrMetricsContext.getChildContext(Object) passing this as the child object.

scope - component scope