HighlightingPluginBase (Solr 3.6.2 API)
Keywords: org.apache.solr.highlight.HighlightingPluginBase class

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
Class HighlightingPluginBase

    java.lang.Object
      org.apache.solr.highlight.HighlightingPluginBase

All Implemented Interfaces:
  SolrInfoMBean

Direct Known Subclasses:
  DefaultEncoder, GapFragmenter, HtmlEncoder, HtmlFormatter, RegexFragmenter, SimpleFragListBuilder, SingleFragListBuilder, SolrBoundaryScanner, SolrFragmentsBuilder

    public abstract class HighlightingPluginBase

extends Object
implements SolrInfoMBean

Since:
  solr 1.3

Nested Class Summary

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

Field Summary
`protected SolrParams` | `defaults`
`protected long` | `numRequests`

Constructor Summary
`HighlightingPluginBase()`

Method Summary
`SolrInfoMBean.Category` | `getCategory()` Purpose of this Class
`abstract String` | `getDescription()` Simple one or two line description
`URL[]` | `getDocs()` Documentation URL list.
`String` | `getName()` Simple common usage name, e.g.
`abstract String` | `getSource()` CVS Source, SVN Source, etc
`abstract String` | `getSourceId()` CVS Id, SVN Id, etc
`NamedList` | `getStatistics()` Any statistics this instance would like to be publicly available via the Solr Administration interface.
`abstract String` | `getVersion()` Simple common usage version, e.g.
`void` | `init(NamedList args)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### numRequests

    protected long numRequests

### defaults

    protected SolrParams defaults

Constructor Detail

### HighlightingPluginBase

    public HighlightingPluginBase()

Method Detail

### init

    public void init(NamedList args)

### getName

    public String getName()

  Description copied from interface: `SolrInfoMBean`
  Simple common usage name, e.g. BasicQueryHandler, or fully qualified clas name.

  Specified by:
    `getName` in interface `SolrInfoMBean`

### getDescription

    public abstract String getDescription()

  Description copied from interface: `SolrInfoMBean`
  Simple one or two line description

  Specified by:
    `getDescription` in interface `SolrInfoMBean`

### getSourceId

    public abstract String getSourceId()

  Description copied from interface: `SolrInfoMBean`
  CVS Id, SVN Id, etc

  Specified by:
    `getSourceId` in interface `SolrInfoMBean`

### getSource

    public abstract String getSource()

  Description copied from interface: `SolrInfoMBean`
  CVS Source, SVN Source, etc

  Specified by:
    `getSource` in interface `SolrInfoMBean`

### getVersion

    public abstract String getVersion()

  Description copied from interface: `SolrInfoMBean`
  Simple common usage version, e.g. 2.0

  Specified by:
    `getVersion` in interface `SolrInfoMBean`

### getCategory

    public SolrInfoMBean.Category getCategory()

  Description copied from interface: `SolrInfoMBean`
  Purpose of this Class

  Specified by:
    `getCategory` in interface `SolrInfoMBean`

### getDocs

    public URL[] getDocs()

  Description copied from interface: `SolrInfoMBean`
  Documentation URL list.

  Suggested documentation URLs: Homepage for sponsoring project, FAQ on class usage, Design doc for class, Wiki, bug reporting URL, etc...

  Specified by:
    `getDocs` in interface `SolrInfoMBean`

### getStatistics

    public NamedList getStatistics()

  Description copied from interface: `SolrInfoMBean`
  Any statistics this instance would like to be publicly available via the Solr Administration interface.

  Any Object type may be stored in the list, but only the `toString()` representation will be used.

  Specified by:
    `getStatistics` in interface `SolrInfoMBean`

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