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 java.lang.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

Fields

Modifier and Type	Field and Description
protected SolrParams	defaults
protected long	numRequests

Constructor Summary

Constructors

Constructor and Description
HighlightingPluginBase()

Method Summary

Modifier and Type	Method and Description
SolrInfoMBean.Category	getCategory() Purpose of this Class
abstract java.lang.String	getDescription() Simple one or two line description
java.net.URL[]	getDocs() Documentation URL list.
java.lang.String	getName() Simple common usage name, e.g.
abstract java.lang.String	getSource() CVS Source, SVN Source, etc
abstract java.lang.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 java.lang.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 java.lang.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 java.lang.String getDescription()

Description copied from interface: SolrInfoMBean

Simple one or two line description

Specified by:

getDescription in interface SolrInfoMBean

getSourceId

public abstract java.lang.String getSourceId()

Description copied from interface: SolrInfoMBean

CVS Id, SVN Id, etc

Specified by:

getSourceId in interface SolrInfoMBean

getSource

public abstract java.lang.String getSource()

Description copied from interface: SolrInfoMBean

CVS Source, SVN Source, etc

Specified by:

getSource in interface SolrInfoMBean

getVersion

public abstract java.lang.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 java.net.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