oracle.dmt.odm.settings.function
Class DataUsageEntry

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

All Implemented Interfaces:

java.io.Serializable

public class DataUsageEntry

extends MiningObject

An instance of DataUsageEntry specifies how to use a particular mining attribute in the LogicalDataSpecification of a given MiningFunctionSettings

Since:

ODM 9.0.1

See Also:

LogicalDataSpecification, Serialized Form

Constructor Summary

DataUsageEntry(MiningAttribute attribute, AttributeUsage usage)
Creates a DataUsageEntry for the mining attribute with the specified usage type.

DataUsageEntry(MiningAttribute attribute, AttributeUsage usage, DataPreparationStatus preparationStatus)
Creates a DataUsageEntry for the mining attribute with the specified usage type and preparation status.

Method Summary

MiningAttribute	getAttribute() Returns the mining attribute instance associated with this DataUsageEntry.
DataPreparationStatus	getDataPreparationStatus() Returns the DataPreparationStatus enum value of the DataUsageEntry.
java.lang.String	getMiningAttributeName() Returns the name of the mining attribute.
AttributeUsage	getUsage() Returns the AttributeUsage enum value used for the mining attribute.
void	setPreparationStatus(DataPreparationStatus prepStatus) Sets the DataPreparationStatus enum value for the mining attribute.
void	setUsage(AttributeUsage aus) Sets the AttributeUsage enum value for the mining attribute.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataUsageEntry

public DataUsageEntry(MiningAttribute attribute,
AttributeUsage usage)
               throws InvalidArgumentException

Creates a DataUsageEntry for the mining attribute with the specified usage type. Preparation status is set to unprepared.

Parameters:

attribute - MiningAttribute instance(required).

usage - AttributeUsage enum to specify the usage type of the mining attribute (required).

Throws:

InvalidArfumentException - when attribute or usage is null.

InvalidArgumentException

DataUsageEntry

public DataUsageEntry(MiningAttribute attribute,
AttributeUsage usage,
DataPreparationStatus preparationStatus)
               throws InvalidArgumentException

Creates a DataUsageEntry for the mining attribute with the specified usage type and preparation status.

Parameters:

attribute - MiningAttribute instance (required).

usage - AttributeUsage enum specifing the usage type of the mining attribute (required).

preparationStatus - DataPreperationSatus specifying the status of the data for building the model.

Throws:

InvalidArgumentException - when attribute or usage or preparationStatus is null.

InvalidArgumentException

Method Detail

getUsage

public AttributeUsage getUsage()

Returns the AttributeUsage enum value used for the mining attribute.

Returns:

AttributeUsage enum value.

setUsage

public void setUsage(AttributeUsage aus)

Sets the AttributeUsage enum value for the mining attribute.

Parameters:

aus - AttributeUsage enumeration

setPreparationStatus

public void setPreparationStatus(DataPreparationStatus prepStatus)

Sets the DataPreparationStatus enum value for the mining attribute.

getAttribute

public MiningAttribute getAttribute()

Returns the mining attribute instance associated with this DataUsageEntry.

Returns:

The mining attribute instance

getDataPreparationStatus

public DataPreparationStatus getDataPreparationStatus()

Returns the DataPreparationStatus enum value of the DataUsageEntry.

Returns:

The enum value of the DataUsageEntry

getMiningAttributeName

public java.lang.String getMiningAttributeName()

Returns the name of the mining attribute.

Returns:

The name of the mining attribute