org.apache.solr.handler.clustering

## Class SearchClusteringEngine

- java.lang.Object
- - org.apache.solr.handler.clustering.ClusteringEngine
  - - org.apache.solr.handler.clustering.SearchClusteringEngine

- Direct Known Subclasses:
    CarrotClusteringEngine

      public abstract class SearchClusteringEngine
      extends ClusteringEngine

  Base class for clustering engines performing cluster analysis on search results.
  WARNING: This API is experimental and might change in incompatible ways in the next release.

- - ### Field Summary

    - ### Fields inherited from class org.apache.solr.handler.clustering.ClusteringEngine

      `DEFAULT_ENGINE_NAME, ENGINE_NAME`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `SearchClusteringEngine()`

  - ### Method Summary

    All Methods Instance Methods Abstract Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `abstract Object` | `cluster(Query query, SolrDocumentList solrDocumentList, Map<SolrDocument,Integer> docIds, SolrQueryRequest sreq)` Do the clustering, return a clusters structure to be appended to `SolrQueryResponse`.
    `protected Set<String>` | `getFieldsToLoad(SolrQueryRequest sreq)` Returns the set of field names to load.

    - ### Methods inherited from class org.apache.solr.handler.clustering.ClusteringEngine

      `getName, init, isAvailable`

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### SearchClusteringEngine

          public SearchClusteringEngine()

  - ### Method Detail

    - #### cluster

          public abstract Object cluster(Query query,
                                         SolrDocumentList solrDocumentList,
                                         Map<SolrDocument,Integer> docIds,
                                         SolrQueryRequest sreq)

      Do the clustering, return a clusters structure to be appended to `SolrQueryResponse`.

    - #### getFieldsToLoad

          protected Set<String> getFieldsToLoad(SolrQueryRequest sreq)

      Returns the set of field names to load. Concrete classes can override this method if needed. Default implementation returns null, that is, all stored fields are loaded.
      Returns:
        The set of field names to load.

Copyright © 2000-2016 Apache Software Foundation. All Rights Reserved.