Package org.apache.solr.highlight
Interface SolrFormatter
-
- All Superinterfaces:
NamedListInitializedPlugin
,SolrInfoBean
- All Known Implementing Classes:
HtmlFormatter
public interface SolrFormatter extends SolrInfoBean, NamedListInitializedPlugin
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoBean
SolrInfoBean.Category, SolrInfoBean.Group
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description org.apache.lucene.search.highlight.Formatter
getFormatter(String fieldName, SolrParams params)
Return aFormatter
appropriate for this field.void
init(NamedList args)
init
will be called just once, immediately after creation.-
Methods inherited from interface org.apache.solr.core.SolrInfoBean
getCategory, getDescription, getMetricNames, getMetricRegistry, getMetricsSnapshot, getName, registerMetricName
-
-
-
-
Method Detail
-
init
void init(NamedList args)
init
will be called just once, immediately after creation.The args are user-level initialization parameters that may be specified when declaring a request handler in solrconfig.xml
- Specified by:
init
in interfaceNamedListInitializedPlugin
-
getFormatter
org.apache.lucene.search.highlight.Formatter getFormatter(String fieldName, SolrParams params)
Return aFormatter
appropriate for this field.- Parameters:
fieldName
- The name of the fieldparams
- The params controlling Highlighting- Returns:
- An appropriate
Formatter
-
-