org.apache.solr.handler.component
Class FacetComponent

java.lang.Object
  org.apache.solr.handler.component.SearchComponent
      org.apache.solr.handler.component.FacetComponent

All Implemented Interfaces:

SolrInfoMBean, NamedListInitializedPlugin

public class FacetComponent
extends SearchComponent

TODO!

Since:

solr 1.3

Nested Class Summary

static class	FacetComponent.DistribFieldFacet This API is experimental and subject to change
static class	FacetComponent.FacetBase This API is experimental and subject to change
static class	FacetComponent.FacetInfo This API is experimental and subject to change
static class	FacetComponent.FieldFacet This API is experimental and subject to change
static class	FacetComponent.QueryFacet This API is experimental and subject to change
static class	FacetComponent.ShardFacetCount This API is experimental and subject to change

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

SolrInfoMBean.Category

Field Summary

static String	COMPONENT_NAME
static org.slf4j.Logger	log

Constructor Summary

FacetComponent()

Method Summary

int	distributedProcess(ResponseBuilder rb) Process for a distributed search.
void	finishStage(ResponseBuilder rb) Called after all responses have been received for this stage.
String	getDescription() Simple one or two line description
URL[]	getDocs() Documentation URL list.
String	getSource() CVS Source, SVN Source, etc
void	handleResponses(ResponseBuilder rb, ShardRequest sreq) Called after all responses for a single request were received
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) Actually run the query

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

getCategory, getName, getStatistics, getVersion, init, setName

Methods inherited from class java.lang.Object

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

Field Detail

log

public static org.slf4j.Logger log

COMPONENT_NAME

public static final String COMPONENT_NAME

See Also:

Constant Field Values

Constructor Detail

FacetComponent

public FacetComponent()

Method Detail

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.

process

public void process(ResponseBuilder rb)
             throws IOException

Actually run the query

Specified by:

process in class SearchComponent

Parameters:

rb - The ResponseBuilder

Throws:

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

distributedProcess

public int distributedProcess(ResponseBuilder rb)
                       throws IOException

Description copied from class: SearchComponent

Process for a distributed search.

Overrides:

distributedProcess in class SearchComponent

Returns:

the next stage for this component

Throws:

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

getDescription

public 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

getSource

public 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 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