org.apache.solr.handler.clustering
Class ClusteringComponent

java.lang.Object
  org.apache.solr.handler.component.SearchComponent
      org.apache.solr.handler.clustering.ClusteringComponent

All Implemented Interfaces:

SolrInfoMBean, NamedListInitializedPlugin, SolrCoreAware

public class ClusteringComponent
extends SearchComponent
implements SolrCoreAware

Provide a plugin for clustering results. Can either be for search results (i.e. via Carrot2) or for clustering documents (i.e. via Mahout)

This engine is experimental. Output from this engine is subject to change in future releases.

 <searchComponent class="org.apache.solr.handler.clustering.ClusteringComponent" name="clustering">
   <lst name="engine">
     <str name="name">default</str>
     <str name="carrot.algorithm">org.carrot2.clustering.lingo.LingoClusteringAlgorithm</str>
   </lst>
 </searchComponent>

Nested Class Summary

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

SolrInfoMBean.Category

Field Summary

static String

COMPONENT_NAME Base name for all spell checker query parameters.

Constructor Summary

ClusteringComponent()

Method Summary

void	finishStage(ResponseBuilder rb)
String	getDescription()
Map<String,SearchClusteringEngine>	getSearchClusteringEngines()
String	getSource()
void	inform(SolrCore core)
void	init(NamedList args)
void	modifyRequest(ResponseBuilder rb, SearchComponent who, ShardRequest sreq)
void	prepare(ResponseBuilder rb)
void	process(ResponseBuilder rb)

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

distributedProcess, getCategory, getDocs, getName, getStatistics, getVersion, handleResponses, setName

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 String COMPONENT_NAME

Base name for all spell checker query parameters. This name is also used to register this component with SearchHandler.

See Also:

Constant Field Values

Constructor Detail

ClusteringComponent

public ClusteringComponent()

Method Detail

prepare

public void prepare(ResponseBuilder rb)
             throws IOException

Specified by:

prepare in class SearchComponent

Throws:

IOException

process

public void process(ResponseBuilder rb)
             throws IOException

Specified by:

process in class SearchComponent

Throws:

IOException

modifyRequest

public void modifyRequest(ResponseBuilder rb,
                          SearchComponent who,
                          ShardRequest sreq)

Overrides:

modifyRequest in class SearchComponent

finishStage

public void finishStage(ResponseBuilder rb)

Overrides:

finishStage in class SearchComponent

init

public void init(NamedList args)

Specified by:

init in interface NamedListInitializedPlugin

Overrides:

init in class SearchComponent

inform

public void inform(SolrCore core)

Specified by:

inform in interface SolrCoreAware

getSearchClusteringEngines

public Map<String,SearchClusteringEngine> getSearchClusteringEngines()

getDescription

public String getDescription()

Specified by:

getDescription in interface SolrInfoMBean

Specified by:

getDescription in class SearchComponent

getSource

public String getSource()

Specified by:

getSource in interface SolrInfoMBean

Specified by:

getSource in class SearchComponent