com.raritantechnologies.concept.clustering
Interface IClusterer

All Superinterfaces:

IConfigurable

All Known Implementing Classes:

FieldValueClusterer, ResultKeywordClusterer, TemisClusterer, VivisimoClusterer

public interface IClusterer

extends IConfigurable

Basic interface for clustering engines.

Developed by Raritan Technologies .

Author:

Ted Sullivan

Method Summary

void	dataComplete() called by cluster input source when all results to be clustered have been added to the clustering engine.
QueryResultBean	getCluster(java.lang.String clusterName) returns a set of clustered results as a QueryResultBean for a given key.
IResultSet	getCluster(java.lang.String clusterName, int startRec, int pageSize) returns a set of clustered results for a given key.
java.util.Set	getClusterNames() returns the names of the clusters created.
QueryResultBeanSet	getClusterSet() returns the set of clusters as a QueryResultBeanSet.
int	getClusterSize(java.lang.String clusterName) returns the number of results for a given key.
java.util.List	getMatchingClusters(IResult result) Returns the set of cluster names that a document matches.
QueryResultBeanSet	getSubCluster(java.lang.String clusterName)
java.util.Iterator	getSubClusterNames() if clusterer supports hierarchical clustering.
void	processResultSet(IResultSet resultSet) called by cluster input to add results to the clustering engine.

Methods inherited from interface com.raritantechnologies.searchApp.IConfigurable

initialize

Method Detail

processResultSet

public void processResultSet(IResultSet resultSet)

called by cluster input to add results to the clustering engine.

dataComplete

public void dataComplete()

called by cluster input source when all results to be clustered have been added to the clustering engine.

getClusterNames

public java.util.Set getClusterNames()

returns the names of the clusters created.

getClusterSize

public int getClusterSize(java.lang.String clusterName)

returns the number of results for a given key.

getClusterSet

public QueryResultBeanSet getClusterSet()

returns the set of clusters as a QueryResultBeanSet.

getCluster

public QueryResultBean getCluster(java.lang.String clusterName)

returns a set of clustered results as a QueryResultBean for a given key.

getCluster

public IResultSet getCluster(java.lang.String clusterName,
                             int startRec,
                             int pageSize)

returns a set of clustered results for a given key.

getSubClusterNames

public java.util.Iterator getSubClusterNames()

if clusterer supports hierarchical clustering. Returns names of child cluster sets.

getSubCluster

public QueryResultBeanSet getSubCluster(java.lang.String clusterName)

getMatchingClusters

public java.util.List getMatchingClusters(IResult result)

Returns the set of cluster names that a document matches.