oracle.dmt.odm.settings.function
Class AttributeImportanceFunctionSettings

java.lang.Object
  |
  +--oracle.dmt.odm.MiningObject
        |
        +--oracle.dmt.odm.LocatableObject
              |
              +--oracle.dmt.odm.settings.function.MiningFunctionSettings
                    |
                    +--oracle.dmt.odm.settings.function.AttributeImportanceFunctionSettings

All Implemented Interfaces:

java.io.Serializable

public class AttributeImportanceFunctionSettings

extends MiningFunctionSettings

An instance of AttributeImportanceFunctionSettings describes the settings for Attribute Importance function that captures the high-level specification for building an attribute importance model. If an algorithm is not specified, the data mining system selects an appropriate algorithm, based on the basic user-provided parameters. The default algorithm for attribute importance is Minimum Description Length.

ODM supports Attribute Importance for supervised mining models only.

See Also:

AttributeImportanceAlgorithmSettings MinimumDescriptionLengthSettings, Serialized Form

Constructor Summary

AttributeImportanceFunctionSettings(LogicalDataSpecification lds, DataUsageSpecification dus)
Creates an instance of attribute importance function settings.

AttributeImportanceFunctionSettings(LogicalDataSpecification lds, DataUsageSpecification dus, AttributeImportanceAlgorithmSettings algorithm)
Creates an instance of attribute importance function settings.

Method Summary

static AttributeImportanceFunctionSettings	create(Connection dmsConn, AttributeImportanceAlgorithmSettings algorithm, PhysicalDataSpecification pdsDataSpec, java.lang.String sTargetAttrName, AttributeType atTargetAttributeType, DataPreparationStatus dpStatus) Creates an instance of AttributeImportanceFunctionSettings from the specified parameters.
MiningAttribute[]	getPredictorAttributes() Returns an array of predictor mining attributes in this function settings.
MiningAttribute[]	getTargetAttributes() Returns the target attribute set in this function settings.
MiningAttribute[]	getUnpreparedPredictorAttributes() Returns an array of unprepared predictor attributes in this functional settings.
void	validate() Validates if this mining function settings is valid.

Methods inherited from class oracle.dmt.odm.settings.function.MiningFunctionSettings

activateAll, adjustAttributesType, adjustAttributeUsage, adjustAttributeUsage, adjustDataPreparationStatus, adjustSparsitySpecification, getDataUsageSpecification, getLogicalDataSpecification, getMiningAlgorithmName, getMiningAlgorithmSettings, getMiningAttributes, getMiningFunction, getName, getSettingsID, getSupplementalAttributes, getValidateBeforeStore, listContents, listContents, listContents, listContents, remove, rename, restore, restore, restorePastVersion, restorePastVersion, setDataUsageSpecification, setLogicalDataSpecification, setMiningAlgorithmName, setMiningAlgorithmSettings, setMiningFunction, setValidateBeforeStore, store

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AttributeImportanceFunctionSettings

public AttributeImportanceFunctionSettings(LogicalDataSpecification lds,
DataUsageSpecification dus,
AttributeImportanceAlgorithmSettings algorithm)
                                    throws InvalidArgumentException

Creates an instance of attribute importance function settings.

Parameters:

lds - An instance of LogicalDataSpecification that specifies the logical representation of the input data

dus - An instance of DataUsageSpecification that specifies how the logical data is to be used to build a model

algorithm - An instance of AttributeImportanceAlgorithmSettings that specifies the kind of algorithm to be used for building the model. If null, the data mining server selects an approptiate attribute importance algorithm.

Throws:

InvalidArgumentException -

• if lds is null,
• if pds is null, or
• if algorithm is invalid.

AttributeImportanceFunctionSettings

public AttributeImportanceFunctionSettings(LogicalDataSpecification lds,
DataUsageSpecification dus)
                                    throws InvalidArgumentException

Creates an instance of attribute importance function settings. The data mining server selects an approptiate attribute importance algorithm.

Parameters:

lds - An instance of LogicalDataSpecification that specifies the logical representation of the input data

dus - An instance of DataUsageSpecification that specifies how the logical data is to be used to build a model

Throws:

InvalidArgumentException -

• if lds is null, or
• if pds is null.

Method Detail

getPredictorAttributes

public MiningAttribute[] getPredictorAttributes()

Returns an array of predictor mining attributes in this function settings.

Returns:

An array of predictor mining attributes

See Also:

AttributeUsage

getTargetAttributes

public MiningAttribute[] getTargetAttributes()

Returns the target attribute set in this function settings. Note that ODM 9.2.0 supports only single-target attribute importance.

Returns:

An array of target mining attributes

See Also:

AttributeUsage

getUnpreparedPredictorAttributes

public MiningAttribute[] getUnpreparedPredictorAttributes()

Returns an array of unprepared predictor attributes in this functional settings.

Returns:

An array of unprepared predictor mining attributes

See Also:

AttributeUsage, DataPreparationStatus

validate

public void validate()
              throws MiningObjectException

Validates if this mining function settings is valid.

Throws:

MiningObjectException - when this function setting is invalid

create

public static AttributeImportanceFunctionSettings create(Connection dmsConn,
AttributeImportanceAlgorithmSettings algorithm,
PhysicalDataSpecification pdsDataSpec,
                                                         java.lang.String sTargetAttrName,
AttributeType atTargetAttributeType,
DataPreparationStatus dpStatus)
                                                                                   throws java.sql.SQLException,
InvalidArgumentException,
ODMException

Creates an instance of AttributeImportanceFunctionSettings from the specified parameters.

Parameters:

dmsConn - A connection to the data mining server

algorithm - An instance of AttributeImportanceAlgorithmSettings

pdsDataSpec - An instance of PhysicalDataSpecification that specifies the input data

sTargetAttrName - - The name of the target attribute

atTargetAttributeType - - The type of the target attribute. Only string or integer type is allowed.

dpStatus - An instance of DataPreparationStatus that indicates whether the data is discretized.

Returns:

AttributeImportanceFunctionSettings - A created instance of AttributeImportanceFunctionSettings

Throws:

InvalidArgumentException - thrown when

• if dmsConn is null,
• if pdsDataSpec is null,
• if sTargetAttrName is null,
• if atTargetAttributeType is null, or
• if atTargetAttributeType is neither string nor integer.

ODMException - when sTargetAttrName is empty or exceeds 30 bytes in length

java.sql.SQLException - when an error occurs during access to the input data