org.apache.solr.highlight

Class HtmlFormatter

java.lang.Object

org.apache.solr.highlight.HighlightingPluginBase

org.apache.solr.highlight.HtmlFormatter

All Implemented Interfaces:

SolrInfoMBean, SolrFormatter, NamedListInitializedPlugin

public class HtmlFormatter
extends HighlightingPluginBase
implements SolrFormatter

Use the SimpleHTMLFormatter

Nested Class Summary

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

SolrInfoMBean.Category

Field Summary

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

defaults, numRequests

Constructor Summary

Constructors

Constructor and Description
HtmlFormatter()

Method Summary

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

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

getCategory, getDocs, getName, getSource, getStatistics, getVersion, init

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.SolrFormatter

init

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

getCategory, getDocs, getName, getSource, getStatistics, getVersion

Constructor Detail

HtmlFormatter

public HtmlFormatter()

Method Detail

getFormatter

public org.apache.lucene.search.highlight.Formatter getFormatter(String fieldName,
                                                                 SolrParams params)

Description copied from interface: SolrFormatter

Return a Formatter appropriate for this field.

Specified by:

getFormatter in interface SolrFormatter

Parameters:

fieldName - The name of the field

params - The params controlling Highlighting

Returns:

An appropriate Formatter

getDescription

public String getDescription()

Description copied from interface: SolrInfoMBean

Simple one or two line description

Specified by:

getDescription in interface SolrInfoMBean

Specified by:

getDescription in class HighlightingPluginBase