javax.datamining.clustering
Interface ClusteringApplySettingsFactory

All Superinterfaces:

Factory

public interface ClusteringApplySettingsFactory

extends Factory

A factory class that creates instances of ClusteringApplySettings.

Author:

JSR-73 Java Data Mining Expert Group

See Also:

Factory

Method Summary

ClusteringApplySettings	create() Creates an empty instance of ClusteringApplySettings.
ClusteringApplySettings	getDefaultApplySettings() Returns the default apply output specification for clustering model.
ClusteringApplyContent[]	getSupportedApplyContents(MiningAlgorithm algorithm) Returns an array of ClusteringApplyContent that are supported by the specified algorithm.
boolean	supportsCapability(MiningAlgorithm algorithm, ClusteringApplyCapability mappingType) Returns true if the specified capability is supported by the specified clustering algorithm.
boolean	supportsCapability(MiningAlgorithm algorithm, ClusteringApplyContent content) Returns true if the specified content is supported by the specified clustering algorithm.

Method Detail

create

public ClusteringApplySettings create()
                               throws JDMException

Creates an empty instance of ClusteringApplySettings.

Returns:

ClusteringApplySettings

Throws:

JDMException

getDefaultApplySettings

public ClusteringApplySettings getDefaultApplySettings()

Returns the default apply output specification for clustering model. The cluster identifier with the highest probability is included in the output with the destination name 'Cluster_Identifier' and with the data type int. Vendors may choose to add different options, and user may add more attributes such as key. The vendor must document what are included in the default apply output specification returned.

Returns:

ClusteringApplySettings

getSupportedApplyContents

public ClusteringApplyContent[] getSupportedApplyContents(MiningAlgorithm algorithm)
                                                   throws JDMException

Returns an array of ClusteringApplyContent that are supported by the specified algorithm. The parameter algorithm may be null if the clustering function does not support a specific algorithm. If algorithm is null, then this method returns an array of ClusteringApplyContent that are supported by clustering function.

An exception is thrown if algorithm is not a supported clustering algorithm.

Parameters:

algorithm - A type of clustering algorithm whose supported apply contents are to be returned.

Returns:

ClusteringApplyContent[]

Throws:

JDMException

supportsCapability

public boolean supportsCapability(MiningAlgorithm algorithm,
                                  ClusteringApplyCapability mappingType)
                           throws JDMException

Returns true if the specified capability is supported by the specified clustering algorithm. Returns false if not supported.

The parameter algorithm may be null if the clustering function does not support a specific algorithm. Throws an exception if the algorithm is not supported.

Parameters:

algorithm -

mappingType -

Returns:

boolean

Throws:

JDMException

supportsCapability

public boolean supportsCapability(MiningAlgorithm algorithm,
                                  ClusteringApplyContent content)
                           throws JDMException

Returns true if the specified content is supported by the specified clustering algorithm. Returns false if not supported.

The parameter algorithm may be null if the clustering function does not support a specific algorithm. Throws an exception if the algorithm is not supported.

Must return true if content is clusterIdentifier for a supported clustering algorithm.

Parameters:

algorithm -

content -

Returns:

boolean

Throws:

JDMException