Class DocumentClusteringEngine
- java.lang.Object
-
- org.apache.solr.handler.clustering.ClusteringEngine
-
- org.apache.solr.handler.clustering.DocumentClusteringEngine
-
public abstract class DocumentClusteringEngine extends ClusteringEngine
- 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 Description DocumentClusteringEngine()
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description abstract NamedList<?>
cluster(SolrParams solrParams)
Experimental.abstract NamedList<?>
cluster(DocSet docs, SolrParams solrParams)
Experimental.-
Methods inherited from class org.apache.solr.handler.clustering.ClusteringEngine
getName, init, isAvailable
-
-
-
-
Method Detail
-
cluster
public abstract NamedList<?> cluster(SolrParams solrParams)
Experimental. Subject to change before the next release Cluster all the documents in the index. Clustering is often an expensive task that can take a long time.- Parameters:
solrParams
- The params controlling clustering- Returns:
- The clustering results
-
cluster
public abstract NamedList<?> cluster(DocSet docs, SolrParams solrParams)
Experimental. Subject to change before the next release Cluster the set of docs. Clustering of documents is often an expensive task that can take a long time.- Parameters:
docs
- The docs to cluster. If null, cluster all docs as incluster(org.apache.solr.common.params.SolrParams)
solrParams
- The params controlling the clustering- Returns:
- The results.
-
-