javax.datamining.clustering
Interface ClusteringModel

All Superinterfaces:

MiningObject, Model

public interface ClusteringModel

extends Model

A ClusteringModel object holds the metadata of the result of a trained clustering model. This information is sufficient to describe the data clusters uncovered during model building as well as to assign new data points to clusters.

Author:

JSR-73 Java Data Mining Expert Group

See Also:

MiningObject, Model

Method Summary

Cluster	getCluster(int identifier) Returns the Cluster object in the model with the specified identifier.
java.util.Collection	getClusters() Returns the collection of Cluster objects in the clustering model.
java.util.Collection	getLeafClusters() Returns the collection of leaf Cluster objects in the clustering model.
int	getNumberOfClusters() Returns the number of clusters in the model.
int	getNumberOfLevels() Returns the number of levels in the ClusteringModel.
java.util.Collection	getRootClusters() Returns a collection of the root clusters of the ClusteringModel.
java.util.Collection	getRules() Returns a collection of the rules from the clustering model.
java.lang.Double	getSimilarity(int clusterIdentifier1, int clusterIdentifier2) Returns the similarity of two clusters represented as a value between 0 and 1.
boolean	hasProperty(ClusteringModelProperty property) Returns true if the specified property is supported by the clustering model.

Methods inherited from interface javax.datamining.base.Model

getApplicationName, getAttributeStatistics, getBuildDuration, getBuildSettings, getEffectiveBuildSettings, getMajorVersion, getMiningAlgorithm, getMiningFunction, getMinorVersion, getModelDetail, getProviderName, getProviderVersion, getSignature, getTaskIdentifier, getUniqueIdentifier, getVersion

Methods inherited from interface javax.datamining.MiningObject

getCreationDate, getCreatorInfo, getDescription, getName, getObjectIdentifier, getObjectType, setDescription

Method Detail

getCluster

public Cluster getCluster(int identifier)
                   throws JDMException

Returns the Cluster object in the model with the specified identifier. Cluster identifier is a positive integer.

Parameters:

identifier - The identifier of the cluster.

Returns:

Cluster

Throws:

JDMException

getClusters

public java.util.Collection getClusters()
                                 throws JDMException

Returns the collection of Cluster objects in the clustering model.

Returns:

Collection

Throws:

JDMException

getLeafClusters

public java.util.Collection getLeafClusters()
                                     throws JDMException

Returns the collection of leaf Cluster objects in the clustering model. There must be no fewer leaf clusters than root clusters. The total number of clusters must be greater than or equal to the number of leaf clusters.

Returns:

Collection

Throws:

JDMException

getNumberOfClusters

public int getNumberOfClusters()

Returns the number of clusters in the model. Result must be non-negative.

Returns:

int

getNumberOfLevels

public int getNumberOfLevels()

Returns the number of levels in the ClusteringModel. Result must be 1 if hierarchical is not supported and always greater than zero. Number of levels cannot exceed the number of clusters.

Returns:

int

getRootClusters

public java.util.Collection getRootClusters()
                                     throws JDMException

Returns a collection of the root clusters of the ClusteringModel. If not hierarchical, then must be equal to the result from getClusters.

Returns:

Collection

Throws:

JDMException

getRules

public java.util.Collection getRules()
                              throws JDMException

Returns a collection of the rules from the clustering model.

Returns:

Collection

Throws:

JDMException

getSimilarity

public java.lang.Double getSimilarity(int clusterIdentifier1,
                                      int clusterIdentifier2)
                               throws JDMException

Returns the similarity of two clusters represented as a value between 0 and 1. It may return null.

Clusters can be compared within the same model.

Parameters:

clusterIdentifier1 -

clusterIdentifier2 -

Returns:

Double

Throws:

JDMException

hasProperty

public boolean hasProperty(ClusteringModelProperty property)

Returns true if the specified property is supported by the clustering model. Returns false otherwise.

Parameters:

property -

Returns:

boolean