javax.datamining.supervised.classification
Interface ClassificationApplySettingsFactory

All Superinterfaces:

Factory

public interface ClassificationApplySettingsFactory

extends Factory

A factory class that creates instances of ClassificationSettingsOutput.

Author:

JSR-73 Java Data Mining Expert Group

See Also:

Factory

Method Summary

ClassificationApplySettings	create() Creates an instance of ClassificationApplySettings initialized to vendor-specific default values.
ClassificationApplySettings	getDefaultApplySettings() Returns the default apply settings specification for a classification model.
ClassificationApplyContent[]	getSupportedApplyContents(MiningAlgorithm algorithm) Returns an array of ClassificationApplyContent that are supported by the specified algorithm.
boolean	supportsCapability(MiningAlgorithm algorithm, ClassificationApplyCapability capability) Returns true if the specified capability is supported by the specified classification algorithm.
boolean	supportsCapability(MiningAlgorithm algorithm, ClassificationApplyContent content) Returns true if the specified content is supported by the specified classification algorithm.

Method Detail

create

public ClassificationApplySettings create()
                                   throws JDMException

Creates an instance of ClassificationApplySettings initialized to vendor-specific default values.

Returns:

ClassificationApplySettings

Throws:

JDMException

getDefaultApplySettings

public ClassificationApplySettings getDefaultApplySettings()

Returns the default apply settings specification for a classification model. The predicted category with the highest probability is included in the output with the destination name Predicted_Category and with the data type String. Vendors may choose to add different options, and user may add more attributes such as a key. The vendor must document what is included in the default apply output specification returned.

Returns:

ClassificationApplySettings

getSupportedApplyContents

public ClassificationApplyContent[] getSupportedApplyContents(MiningAlgorithm algorithm)
                                                       throws JDMException

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

An exception is thrown if algorithm is not a classification algorithm.

Parameters:

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

Returns:

ClassificationApplyContent[]

Throws:

JDMException

supportsCapability

public boolean supportsCapability(MiningAlgorithm algorithm,
                                  ClassificationApplyCapability capability)
                           throws JDMException

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

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

Parameters:

algorithm -

capability -

Returns:

boolean

Throws:

JDMException

supportsCapability

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

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

The parameter algorithm may be null if the classification function does not support a specific algorithm. Throws an exception if the algorithm is not supported. Must return true if content is predictedCategory for a supported classification algorithm.

Parameters:

algorithm -

content -

Returns:

boolean

Throws:

JDMException