SolrEncoder (Solr 3.6.2 API)
Keywords: org.apache.solr.highlight.SolrEncoder interface

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.solr.highlight
Interface SolrEncoder

All Superinterfaces:
  NamedListInitializedPlugin, SolrInfoMBean

All Known Implementing Classes:
  DefaultEncoder, HtmlEncoder

    public interface SolrEncoder

extends SolrInfoMBean, NamedListInitializedPlugin

Nested Class Summary

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

Method Summary
`Encoder` | `getEncoder(String fieldName, SolrParams params)` Return an `Encoder` 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, getSourceId, 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`

### getEncoder

    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`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD