Package org.apache.solr.highlight

Class HtmlEncoder

java.lang.Object

org.apache.solr.highlight.HighlightingPluginBase

org.apache.solr.highlight.HtmlEncoder

All Implemented Interfaces:

AutoCloseable, SolrInfoBean, SolrEncoder, SolrMetricProducer, NamedListInitializedPlugin

public class HtmlEncoder
extends HighlightingPluginBase
implements SolrEncoder

Use the SimpleHTMLEncoder

Nested Class Summary

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

SolrInfoBean.Category, SolrInfoBean.Group

Field Summary

Fields inherited from class org.apache.solr.highlight.HighlightingPluginBase

defaults, metricManager, metricNames, numRequests, registry, registryName

Constructor Summary

Constructors

Constructor	Description
HtmlEncoder()

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Simple one or two line description
org.apache.lucene.search.highlight.Encoder	getEncoder(String fieldName, SolrParams params)	Return an Encoder appropriate for this field.

Methods inherited from class org.apache.solr.highlight.HighlightingPluginBase

getCategory, getMetricNames, getMetricRegistry, getName, init, initializeMetrics

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.highlight.SolrEncoder

init

Methods inherited from interface org.apache.solr.core.SolrInfoBean

getCategory, getMetricNames, getMetricRegistry, getMetricsSnapshot, getName, registerMetricName

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

close, getSolrMetricsContext, initializeMetrics

Constructor Detail

HtmlEncoder

public HtmlEncoder()

Method Detail

getEncoder

public org.apache.lucene.search.highlight.Encoder getEncoder(String fieldName,
                                                             SolrParams params)

Description copied from interface: SolrEncoder

Return an Encoder appropriate for this field.

Specified by:

getEncoder in interface SolrEncoder

Parameters:

fieldName - The name of the field

params - The params controlling Highlighting

Returns:

An appropriate Encoder

getDescription

public String getDescription()

Description copied from interface: SolrInfoBean

Simple one or two line description

Specified by:

getDescription in interface SolrInfoBean

Specified by:

getDescription in class HighlightingPluginBase