javax.datamining.supervised.regression
Interface RegressionApplySettingsFactory

All Superinterfaces:

Factory

public interface RegressionApplySettingsFactory

extends Factory

A factory class that creates instances of RegressionApplySettings.

Author:

JSR-73 Java Data Mining Expert Group

See Also:

Factory

Method Summary

RegressionApplySettings	create() Creates an instance of RegressionApplySettings initialized to vendor-specific default values.
RegressionApplySettings	getDefaultApplySettings() Returns the default apply output specification for regression model.
RegressionApplyContent[]	getSupportedApplyContents(MiningAlgorithm algorithm) Returns an array of RegressionApplyContent that are supported by the specified algorithm.
boolean	supportsCapability(MiningAlgorithm algorithm, RegressionApplyContent content) Returns true if the specified content is supported by the specified regression algorithm.

Method Detail

create

public RegressionApplySettings create()
                               throws JDMException

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

Returns:

RegressionApplySettings

Throws:

JDMException

getDefaultApplySettings

public RegressionApplySettings getDefaultApplySettings()

Returns the default apply output specification for regression model. The predicted value with the highest confidence is included in the output with the destination name 'Predicted_Value' and with the data type 'double'.

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:

RegressionApplySettings

getSupportedApplyContents

public RegressionApplyContent[] getSupportedApplyContents(MiningAlgorithm algorithm)
                                                   throws JDMException

Returns an array of RegressionApplyContent that are supported by the specified algorithm. The parameter algorithm may be null if the regression function does not support a specific algorithm.

An exception is thrown if algorithm is not an regression algorithm.

Parameters:

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

Returns:

RegressionApplyContent[]

Throws:

JDMException

supportsCapability

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

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

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

Must return true if content is predictedValue for a supported regression algorithm.

Parameters:

algorithm -

content -

Returns:

boolean

Throws:

JDMException