org.apache.solr.handler.component

Class TermsComponent

java.lang.Object

org.apache.solr.handler.component.SearchComponent

org.apache.solr.handler.component.TermsComponent

All Implemented Interfaces:

SolrInfoMBean, NamedListInitializedPlugin

public class TermsComponent
extends SearchComponent

Return TermEnum information, useful for things like auto suggest.

 <searchComponent name="termsComponent" class="solr.TermsComponent"/>
 
 <requestHandler name="/terms" class="solr.SearchHandler">
   <lst name="defaults">
     <bool name="terms">true</bool>
   </lst>
   <arr name="components">
     <str>termsComponent</str>
   </arr>
 </requestHandler>

Version:

$Id: TermsComponent.java 1067552 2011-02-05 23:52:42Z koji $

See Also:

See Lucene's TermEnum class

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TermsComponent.TermsHelper

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
static int	UNLIMITED_MAX_COUNT

Constructor Summary

Constructors

Constructor and Description
TermsComponent()

Method Summary

Modifier and Type	Method and Description
private ShardRequest	createShardQuery(SolrParams params)
int	distributedProcess(ResponseBuilder rb) Process for a distributed search.
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.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	prepare(ResponseBuilder rb) Prepare the response.
void	process(ResponseBuilder rb) Process the request for this component
(package private) int	resolveRegexpFlags(SolrParams params)

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

getCategory, getDocs, getName, getStatistics, init, modifyRequest

Methods inherited from class java.lang.Object

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

Field Detail

UNLIMITED_MAX_COUNT

public static final int UNLIMITED_MAX_COUNT

See Also:

Constant Field Values

COMPONENT_NAME

public static final java.lang.String COMPONENT_NAME

See Also:

Constant Field Values

Constructor Detail

TermsComponent

public TermsComponent()

Method Detail

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

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

resolveRegexpFlags

int resolveRegexpFlags(SolrParams params)

distributedProcess

public int distributedProcess(ResponseBuilder rb)
                       throws java.io.IOException

Description copied from class: SearchComponent

Process for a distributed search.

Overrides:

distributedProcess in class SearchComponent

Returns:

the next stage for this component

Throws:

java.io.IOException

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

createShardQuery

private ShardRequest createShardQuery(SolrParams params)

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

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