org.apache.solr.handler.component

Class HighlightComponent

java.lang.Object

org.apache.solr.handler.component.SearchComponent

org.apache.solr.handler.component.HighlightComponent

All Implemented Interfaces:

SolrInfoMBean, NamedListInitializedPlugin, PluginInfoInitialized, SolrCoreAware

public class HighlightComponent
extends SearchComponent
implements PluginInfoInitialized, SolrCoreAware

TODO!

Since:

solr 1.3

Version:

$Id: HighlightComponent.java 1198785 2011-11-07 15:43:23Z koji $

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
static java.lang.String	COMPONENT_NAME
private SolrHighlighter	highlighter
private PluginInfo	info

Constructor Summary

Constructors

Constructor and Description
HighlightComponent()

Method Summary

Modifier and Type	Method and Description
void	finishStage(ResponseBuilder rb) Called after all responses have been received for this stage.
java.lang.String	getDescription() Simple one or two line description
java.net.URL[]	getDocs() Documentation URL list.
SolrHighlighter	getHighlighter()
java.lang.String	getSource() CVS Source, SVN Source, etc
java.lang.String	getSourceId() CVS Id, SVN Id, etc
java.lang.String	getVersion() Simple common usage version, e.g.
void	handleResponses(ResponseBuilder rb, ShardRequest sreq) Called after all responses for a single request were received
void	inform(SolrCore core)
void	init(PluginInfo info)
void	modifyRequest(ResponseBuilder rb, SearchComponent who, ShardRequest sreq) Called after another component adds a request
void	prepare(ResponseBuilder rb) Prepare the response.
void	process(ResponseBuilder rb) Process the request for this component
(package private) static NamedList	removeNulls(NamedList nl)

Methods inherited from class org.apache.solr.handler.component.SearchComponent

distributedProcess, getCategory, getName, getStatistics, init

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMPONENT_NAME

public static final java.lang.String COMPONENT_NAME

See Also:

Constant Field Values

info

private PluginInfo info

highlighter

private SolrHighlighter highlighter

Constructor Detail

HighlightComponent

public HighlightComponent()

Method Detail

init

public void init(PluginInfo info)

Specified by:

init in interface PluginInfoInitialized

prepare

public void prepare(ResponseBuilder rb)
             throws java.io.IOException

Description copied from class: SearchComponent

Prepare the response. Guaranteed to be called before any SearchComponent SearchComponent.process(org.apache.solr.handler.component.ResponseBuilder) method. Called for every incoming request. The place to do initialization that is request dependent.

Specified by:

prepare in class SearchComponent

Parameters:

rb - The ResponseBuilder

Throws:

java.io.IOException

inform

public void inform(SolrCore core)

Specified by:

inform in interface SolrCoreAware

process

public void process(ResponseBuilder rb)
             throws java.io.IOException

Description copied from class: SearchComponent

Process the request for this component

Specified by:

process in class SearchComponent

Parameters:

rb - The ResponseBuilder

Throws:

java.io.IOException

modifyRequest

public void modifyRequest(ResponseBuilder rb,
                          SearchComponent who,
                          ShardRequest sreq)

Description copied from class: SearchComponent

Called after another component adds a request

Overrides:

modifyRequest in class SearchComponent

handleResponses

public void handleResponses(ResponseBuilder rb,
                            ShardRequest sreq)

Description copied from class: SearchComponent

Called after all responses for a single request were received

Overrides:

handleResponses in class SearchComponent

finishStage

public void finishStage(ResponseBuilder rb)

Description copied from class: SearchComponent

Called after all responses have been received for this stage. Useful when different requests are sent to each shard.

Overrides:

finishStage in class SearchComponent

removeNulls

static NamedList removeNulls(NamedList nl)

getHighlighter

public SolrHighlighter getHighlighter()

getDescription

public java.lang.String getDescription()

Description copied from interface: SolrInfoMBean

Simple one or two line description

Specified by:

getDescription in interface SolrInfoMBean

Specified by:

getDescription in class SearchComponent

getVersion

public java.lang.String getVersion()

Description copied from interface: SolrInfoMBean

Simple common usage version, e.g. 2.0

Specified by:

getVersion in interface SolrInfoMBean

Specified by:

getVersion in class SearchComponent

getSourceId

public java.lang.String getSourceId()

Description copied from interface: SolrInfoMBean

CVS Id, SVN Id, etc

Specified by:

getSourceId in interface SolrInfoMBean

Specified by:

getSourceId in class SearchComponent

getSource

public java.lang.String getSource()

Description copied from interface: SolrInfoMBean

CVS Source, SVN Source, etc

Specified by:

getSource in interface SolrInfoMBean

Specified by:

getSource in class SearchComponent

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

Overrides:

getDocs in class SearchComponent