Package org.apache.solr.highlight

Interface SolrEncoder

All Superinterfaces:

AutoCloseable, NamedListInitializedPlugin, SolrInfoBean, SolrMetricProducer

All Known Implementing Classes:

DefaultEncoder, HtmlEncoder

public interface SolrEncoder
extends SolrInfoBean, NamedListInitializedPlugin

Nested Class Summary

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

SolrInfoBean.Category, SolrInfoBean.Group

Method Summary

Modifier and Type	Method	Description
org.apache.lucene.search.highlight.Encoder	getEncoder(String fieldName, SolrParams params)	Return an Encoder appropriate for this field.

Methods inherited from interface org.apache.solr.util.plugin.NamedListInitializedPlugin

init

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

getCategory, getDescription, getName

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

close, getSolrMetricsContext, initializeMetrics

Method Detail

getEncoder

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

Return an Encoder appropriate for this field.

Parameters:

fieldName - The name of the field

params - The params controlling Highlighting

Returns:

An appropriate Encoder