Package 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:

AutoCloseable, SolrInfoBean, SolrMetricProducer, NamedListInitializedPlugin, PluginInfoInitialized, SolrCoreAware

public class HighlightComponent
extends SearchComponent
implements PluginInfoInitialized, SolrCoreAware

Highlights query words in the search results. See the ref guide.

Since:

solr 1.3

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	HighlightComponent.HighlightMethod

Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoBean

SolrInfoBean.Category, SolrInfoBean.Group

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT_NAME
protected PluginInfo	info
protected SolrHighlighter	solrConfigHighlighter

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

solrMetricsContext, standard_components

Fields inherited from interface org.apache.solr.metrics.SolrMetricProducer

CATEGORY_ATTR, HANDLER_ATTR, NAME_ATTR, OPERATION_ATTR, PLUGIN_NAME_ATTR, RESULT_ATTR, TYPE_ATTR

Constructor Summary

Constructors

Constructor	Description
HighlightComponent()

Method Summary

Modifier and Type	Method	Description
protected void	addHighlights(Object[] objArr, Object obj, Map<Object,ShardDoc> resultIds)
protected Object	convertHighlights(org.apache.solr.common.util.NamedList<Object> hl)
void	finishStage(ResponseBuilder rb)	Called after all responses have been received for this stage.
protected Object	getAllHighlights(Object[] objArr)
String	getDescription()	Simple one or two line description
SolrHighlighter	getHighlighter(org.apache.solr.common.params.SolrParams params)	The highlighter given the param HighlightParams.METHOD.
void	handleResponses(ResponseBuilder rb, ShardRequest sreq)	Called after all responses for a single request were received
protected String	highlightingResponseField()
void	inform(SolrCore core)
void	init(PluginInfo info)
void	modifyRequest(ResponseBuilder rb, SearchComponent who, ShardRequest sreq)	Called after another component adds a request
protected Object[]	newHighlightsArray(int size)
void	prepare(ResponseBuilder rb)	Prepare the response.
void	process(ResponseBuilder rb)	Process the request for this component

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

distributedProcess, getCategory, getName, getSolrMetricsContext, initializeMetrics, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.solr.util.plugin.NamedListInitializedPlugin

init

Methods inherited from interface org.apache.solr.metrics.SolrMetricProducer

close

Field Details

COMPONENT_NAME

public static final String COMPONENT_NAME

See Also:

• Constant Field Values

info

protected PluginInfo info

solrConfigHighlighter

protected SolrHighlighter solrConfigHighlighter

Constructor Details

HighlightComponent

public HighlightComponent()

Method Details

init

public void init(PluginInfo info)

Specified by:

init in interface PluginInfoInitialized

prepare

public void prepare(ResponseBuilder rb)
             throws 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:

IOException - If there is a low-level I/O error.

inform

public void inform(SolrCore core)

Specified by:

inform in interface SolrCoreAware

process

public void process(ResponseBuilder rb)
             throws IOException

Description copied from class: SearchComponent

Process the request for this component

Specified by:

process in class SearchComponent

Parameters:

rb - The ResponseBuilder

Throws:

IOException - If there is a low-level I/O error.

getHighlighter

public SolrHighlighter getHighlighter(org.apache.solr.common.params.SolrParams params)

The highlighter given the param HighlightParams.METHOD. Never returns null.

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

getDescription

public String getDescription()

Description copied from interface: SolrInfoBean

Simple one or two line description

Specified by:

getDescription in interface SolrInfoBean

Specified by:

getDescription in class SearchComponent

highlightingResponseField

protected String highlightingResponseField()

convertHighlights

protected Object convertHighlights(org.apache.solr.common.util.NamedList<Object> hl)

newHighlightsArray

protected Object[] newHighlightsArray(int size)

addHighlights

protected void addHighlights(Object[] objArr,
 Object obj,
 Map<Object,ShardDoc> resultIds)

getAllHighlights

protected Object getAllHighlights(Object[] objArr)