ClusteringComponent (Apache Solr and Lucene - Javadoc and Source (6.4.0))

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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
```
Provides a plugin for performing cluster analysis. This can either be applied to search results (e.g., via Carrot²) or for clustering documents (e.g., via Mahout).
See Solr example for configuration examples.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoMBean
  SolrInfoMBean.Category, SolrInfoMBean.Group

Field Summary

Fields
Modifier and Type Field and Description

static String COMPONENT_NAME
Base name for all component parameters.
- Fields inherited from class org.apache.solr.handler.component.SearchComponent
  standard_components

Fields
Modifier and Type	Field and Description
`static String`	`COMPONENT_NAME` Base name for all component parameters.

Constructor Summary

Constructors
Constructor and Description

ClusteringComponent()

Constructors
Constructor and Description
`ClusteringComponent()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`finishStage(ResponseBuilder rb)` Called after all responses have been received for this stage.
`String`	`getDescription()` Simple one or two line description
`void`	`inform(SolrCore core)`
`void`	`init(NamedList args)`
`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, getCategory, getDocs, getName, getSource, 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 component parameters. This name is also used to register this component with SearchHandler.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ClusteringComponent
```
public ClusteringComponent()
```
- Method Detail
  - 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
  - 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
```
    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.
  - 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
  - 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

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Class ClusteringComponent

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

COMPONENT_NAME

Constructor Detail

ClusteringComponent

Method Detail

init

inform

prepare

process

modifyRequest

finishStage

getDescription