org.apache.solr.highlight

## Interface SolrFormatter

- All Superinterfaces:
    NamedListInitializedPlugin, SolrInfoMBean
  All Known Implementing Classes:
    HtmlFormatter

      public interface SolrFormatter
      extends SolrInfoMBean, NamedListInitializedPlugin

- - ### Nested Class Summary

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

      `SolrInfoMBean.Category`

  - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `Formatter` | `getFormatter(String fieldName, SolrParams params)` Return a `Formatter` 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.SolrInfoMBean

      `getCategory, getDescription, getDocs, getName, getSource, getStatistics, getVersion`

- - ### 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 interface `NamedListInitializedPlugin`

    - #### getFormatter

          Formatter getFormatter(String fieldName,
                                 SolrParams params)

      Return a `Formatter` appropriate for this field.
      Parameters:
        `fieldName` - The name of the field
        `params` - The params controlling Highlighting
      Returns:
        An appropriate `Formatter`

Copyright © 2000-2016 Apache Software Foundation. All Rights Reserved.