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

Version:

$Id: FacetComponent.java 1232359 2012-01-17 09:33:46Z simonw $

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
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

Fields

Modifier and Type	Field and Description
private static java.lang.String	commandPrefix
static java.lang.String	COMPONENT_NAME

Constructor Summary

Constructors

Constructor and Description
FacetComponent()

Method Summary

Modifier and Type	Method and Description
private void	countFacets(ResponseBuilder rb, ShardRequest sreq)
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.net.URL[]	getDocs() Documentation URL list.
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	modifyRequest(ResponseBuilder rb, SearchComponent who, ShardRequest sreq) Called after another component adds a request
private java.lang.Number	num(long val)
private java.lang.Number	num(java.lang.Long val)
void	prepare(ResponseBuilder rb) Prepare the response.
void	process(ResponseBuilder rb) Actually run the query
private void	refineFacets(ResponseBuilder rb, ShardRequest sreq)

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

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

commandPrefix

private static final java.lang.String commandPrefix

See Also:

Constant Field Values

Constructor Detail

FacetComponent

public FacetComponent()

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

Actually run the query

Specified by:

process in class SearchComponent

Parameters:

rb -

Throws:

java.io.IOException

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

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

countFacets

private void countFacets(ResponseBuilder rb,
                         ShardRequest sreq)

refineFacets

private void refineFacets(ResponseBuilder rb,
                          ShardRequest sreq)

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

num

private java.lang.Number num(long val)

num

private java.lang.Number num(java.lang.Long val)

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