Package org.apache.solr.handler.component

Class TermVectorComponent

java.lang.Object

org.apache.solr.handler.component.SearchComponent

org.apache.solr.handler.component.TermVectorComponent

All Implemented Interfaces:

AutoCloseable, SolrInfoBean, SolrMetricProducer, NamedListInitializedPlugin

public class TermVectorComponent
extends SearchComponent

Return term vectors for the documents in a query result set.

Info available: term, frequency, position, offset, payloads, IDF.

Note Returning IDF can be expensive.

 <searchComponent name="tvComponent" class="solr.TermVectorComponent"/>

 <requestHandler name="/terms" class="solr.SearchHandler">
   <lst name="defaults">
     <bool name="tv">true</bool>
   </lst>
   <arr name="last-component">
     <str>tvComponent</str>
   </arr>
 </requestHandler>

Nested Class Summary

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

SolrInfoBean.Category, SolrInfoBean.Group

Field Summary

Fields

Modifier and Type	Field	Description
static String	COMPONENT_NAME
protected org.apache.solr.common.util.NamedList<?>	initParams
static String	TERM_VECTORS

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

solrMetricsContext, standard_components

Constructor Summary

Constructors

Constructor	Description
TermVectorComponent()

Method Summary

Modifier and Type	Method	Description
void	finishStage(ResponseBuilder rb)	Called after all responses have been received for this stage.
SolrInfoBean.Category	getCategory()	Category of this component
String	getDescription()	Simple one or two line description
void	init(org.apache.solr.common.util.NamedList<?> args)	init will be called just once, immediately after creation.
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

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

distributedProcess, getName, getSolrMetricsContext, handleResponses, 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.metrics.SolrMetricProducer

close

Field Detail

COMPONENT_NAME

public static final String COMPONENT_NAME

See Also:

Constant Field Values

TERM_VECTORS

public static final String TERM_VECTORS

See Also:

Constant Field Values

initParams

protected org.apache.solr.common.util.NamedList<?> initParams

Constructor Detail

TermVectorComponent

public TermVectorComponent()

Method Detail

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.

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.

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

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

init

public void init(org.apache.solr.common.util.NamedList<?> args)

Description copied from interface: NamedListInitializedPlugin

init will be called just once, immediately after creation.

Source of the initialization arguments will typically be solrconfig.xml, but will ultimately depends on the plugin itself

Parameters:

args - non-null list of initialization parameters (may be empty)

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

getCategory

public SolrInfoBean.Category getCategory()

Description copied from interface: SolrInfoBean

Category of this component

Specified by:

getCategory in interface SolrInfoBean

Overrides:

getCategory in class SearchComponent