org.apache.solr.handler.clustering

## Class ClusteringEngine

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

- Direct Known Subclasses:
    DocumentClusteringEngine, SearchClusteringEngine

      public abstract class ClusteringEngine
      extends Object

  A base class for `SearchClusteringEngine` and `DocumentClusteringEngine`.
  WARNING: This API is experimental and might change in incompatible ways in the next release.

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static String` | `DEFAULT_ENGINE_NAME`
    `static String` | `ENGINE_NAME`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `ClusteringEngine()`

  - ### Method Summary

    All Methods Instance Methods Abstract Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `String` | `getName()`
    `String` | `init(NamedList<?> config, SolrCore core)`
    `abstract boolean` | `isAvailable()`

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

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

- - ### Field Detail

    - #### ENGINE_NAME

          public static final String ENGINE_NAME

      See Also:
        Constant Field Values

    - #### DEFAULT_ENGINE_NAME

          public static final String DEFAULT_ENGINE_NAME

      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### ClusteringEngine

          public ClusteringEngine()

  - ### Method Detail

    - #### init

          public String init(NamedList<?> config,
                             SolrCore core)

    - #### getName

          public String getName()

    - #### isAvailable

          public abstract boolean isAvailable()

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