X-Git-Url: http://git.osdn.net/view?a=blobdiff_plain;f=solr-4.6.0%2Fdocs%2Fsolr-clustering%2Forg%2Fapache%2Fsolr%2Fhandler%2Fclustering%2FSearchClusteringEngine.html;fp=solr-4.6.0%2Fdocs%2Fsolr-clustering%2Forg%2Fapache%2Fsolr%2Fhandler%2Fclustering%2FSearchClusteringEngine.html;h=28172ab07d15d15ddefe20543c5f233bb1b8b1b7;hb=984cb2d01d9df08990e216e765a0cd5f2724cff6;hp=0000000000000000000000000000000000000000;hpb=0a506fa4326a039654939ad76e2201a7e4885dbf;p=libre10%2Flibre10.git diff --git a/solr-4.6.0/docs/solr-clustering/org/apache/solr/handler/clustering/SearchClusteringEngine.html b/solr-4.6.0/docs/solr-clustering/org/apache/solr/handler/clustering/SearchClusteringEngine.html new file mode 100644 index 0000000..28172ab --- /dev/null +++ b/solr-4.6.0/docs/solr-clustering/org/apache/solr/handler/clustering/SearchClusteringEngine.html @@ -0,0 +1,341 @@ + + + + + + + +SearchClusteringEngine (Solr 4.6.0 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.apache.solr.handler.clustering +
+Class SearchClusteringEngine

+
+java.lang.Object
+  extended by org.apache.solr.handler.clustering.ClusteringEngine
+      extended by 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
SearchClusteringEngine() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+abstract  Objectcluster(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
+  + + + + + + + +
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.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved. + + + + +