oracle.dmt.odm.settings.function
Class DataUsageSpecification

java.lang.Object
  |
  +--oracle.dmt.odm.MiningObject
        |
        +--oracle.dmt.odm.settings.function.DataUsageSpecification

All Implemented Interfaces:

java.io.Serializable

public class DataUsageSpecification

extends MiningObject

An instance of DataUsageSpecification is used to specify how the attributes in a LogicalDataSpecification instance are used for building a mining model. The specification may contain at most one DataUsageEntry instance for each MiningAttribute in the LogicalDataSpecification.

A mining attribute can be active, inactive, target, or supplemental. The default usage is active for an attribute if no DataUsageEntry is present.

Since:

ODM 9.0.1

See Also:

Serialized Form

Constructor Summary

DataUsageSpecification()
Creates a DataUsageSpecification instance with no data usage entries specified.

Method Summary

void	addUsageEntry(DataUsageEntry entry) Adds a DataUsageEntry to this data usage specification.
static DataUsageSpecification	create(LogicalDataSpecification lds, AttributeUsage defaultAttrUsage, DataPreparationStatus defaultDataPrep) Creates a DataUsageSpecification instance with the specified LogicalDataSpecification, default AttributeUsage, and default DataPreparationStatus for all attributes in the LogicalDataSpecification.
static DataUsageSpecification	create(LogicalDataSpecification lds, AttributeUsage defaultAttrUsage, DataPreparationStatus defaultDataPrep, java.lang.String targetAttrName) Creates a DataUsageSpecification instance with the specified LogicalDataSpecification, default AttributeUsage, default DataPreparationStatus, and the target attribute.
static DataUsageSpecification	create(MiningAttribute[] activeAttributesArray) Deprecated. As of ODM 9.2.0. Use other create methods.
static DataUsageSpecification	createTargetDUS(MiningAttribute targetMiningAttribute) Returns a DataUsageSpecification instance with the specified attribute as a target attribute.
DataUsageEntry[]	getDataUsageEntries() Returns an array of data usage entries contained in this DataUsageSpecification instance.
DataUsageEntry	getDataUsageEntry(java.lang.String attrName) Returns a DataUsageEntry instance associated with specifed named attribute.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataUsageSpecification

public DataUsageSpecification()

Creates a DataUsageSpecification instance with no data usage entries specified.

See Also:

LogicalDataSpecification

Method Detail

addUsageEntry

public void addUsageEntry(DataUsageEntry entry)
                   throws InvalidArgumentException

Adds a DataUsageEntry to this data usage specification.

Parameters:

entry - - The DataUsageEntry

Throws:

InvalidArgumentException - when entry is null

InvalidArgumentException

getDataUsageEntries

public DataUsageEntry[] getDataUsageEntries()

Returns an array of data usage entries contained in this DataUsageSpecification instance.

Returns:

Array of data usage entries

getDataUsageEntry

public DataUsageEntry getDataUsageEntry(java.lang.String attrName)

Returns a DataUsageEntry instance associated with specifed named attribute.

Returns:

DataUsageEntry with the specified attribute name

createTargetDUS

public static DataUsageSpecification createTargetDUS(MiningAttribute targetMiningAttribute)
                                                                               throws InvalidArgumentException

Returns a DataUsageSpecification instance with the specified attribute as a target attribute. This method is useful in supervised model building with one target attribute and remaining all attributes are considered to be active.

Parameters:

targetMiningAttribute - Target MiningAttribute

Returns:

DataUsageSpecification

Throws:

InvalidArgumentException - when targetMiningAttribute is null

InvalidArgumentException

create

public static DataUsageSpecification create(MiningAttribute[] activeAttributesArray)
                                                                      throws InvalidArgumentException

Deprecated. As of ODM 9.2.0. Use other create methods.

Returns an instance of DataUsageSpecification that defines the specified mining attributes as active attributes.

Parameters:

activeAttributesArray - An array of mining attributes

Returns:

DataUsageSpecification - A created instance of data usage specification

Throws:

InvalidArgumentException - inherited exception

See Also:

AttributeUsage

create

public static DataUsageSpecification create(LogicalDataSpecification lds,
AttributeUsage defaultAttrUsage,
DataPreparationStatus defaultDataPrep,
                                            java.lang.String targetAttrName)
                                                                      throws InvalidArgumentException,
MiningObjectException,
ODMException

Creates a DataUsageSpecification instance with the specified LogicalDataSpecification, default AttributeUsage, default DataPreparationStatus, and the target attribute. It is a useful utility method to create a DataUsageSpecification object with the default settings for a SupervisedFunctionSettings

Parameters:

lds - logical data specification

defaultAttrUsage - default attribute usage

defaultDataPrep - default data preparation status

targetAttrName - target attribute name

Returns:

DataUsageSpecification instance

Throws:

InvalidArgumentException - when lds or defaultAttrUsage or defaultDataPrep or targetAttrName is null.

MiningObjectException - when target attribute is of float data type.

InvalidArgumentException

MiningObjectException

ODMException

Since:

ODM 9.2.0

create

public static DataUsageSpecification create(LogicalDataSpecification lds,
AttributeUsage defaultAttrUsage,
DataPreparationStatus defaultDataPrep)
                                                                      throws InvalidArgumentException,
ODMException

Creates a DataUsageSpecification instance with the specified LogicalDataSpecification, default AttributeUsage, and default DataPreparationStatus for all attributes in the LogicalDataSpecification. It is a useful utility method to create a DataUsageSpecification object with the default settings for a SupervisedFunctionSettings

Parameters:

lds - logical data specification

defaultAttrUsage - default attribute usage

defaultDataPrep - default data preparation status

Returns:

DataUsageSpecification instance

Throws:

InvalidArgumentException - when lds or defaultAttrUsage or defaultDataPrep/code> is null.

InvalidArgumentException

ODMException

Since:

ODM 9.2.0