oracle.dmt.odm
Class AttributeUsage

java.lang.Object
  |
  +--oracle.dmt.odm.Enum
        |
        +--oracle.dmt.odm.AttributeUsage

All Implemented Interfaces:

java.io.Serializable

public class AttributeUsage

extends Enum

The enumeration class AttributeUsage is used to specify how an attribute is used for a mining operation.

For supervised mining, the values active, predictor, target, inactive and supplemetal are used. For unsupervised mining, the values active, inactive and supplemental are used.

The semantics of the value are as follows:

• active or predictor: The attribute is loaded into memory and used for mining operations.
• target:The attribute is active and used as a target for supervised mining operations.
• supplemental: The attribute is not used for mining operations, but is made available, for example, for inert pass-through during apply.
• inactive: The attribute is not used for any mining operation and should not be made available for other mining operations.

Since:

ODM 9.0.1

See Also:

Serialized Form

Field Summary

static AttributeUsage	active
static AttributeUsage	inactive
static AttributeUsage	predictor
static AttributeUsage	supplementary
static AttributeUsage	target

Method Summary

static AttributeUsage	getInstance(int id) Returns AttributeUsage enumeration object corresponding to the specified ID.
static AttributeUsage	getInstance(java.lang.String name) Returns AttributeUsage enumeration object corresponding to the specified name.
static AttributeUsage[]	list() Returns the list of all AttributeUsage enumerations defined.
static java.lang.String[]	listNames() Returns the list of names of all AttributeUsage enumerations defined.

Methods inherited from class oracle.dmt.odm.Enum

getEnum, getID, isEqual

Methods inherited from class java.lang.Object

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

Field Detail

active

public static final AttributeUsage active

inactive

public static final AttributeUsage inactive

supplementary

public static final AttributeUsage supplementary

target

public static final AttributeUsage target

predictor

public static final AttributeUsage predictor

Method Detail

listNames

public static java.lang.String[] listNames()

Returns the list of names of all AttributeUsage enumerations defined.

Returns:

array of names for the AttributeUsage enumeration

list

public static AttributeUsage[] list()

Returns the list of all AttributeUsage enumerations defined.

Returns:

array of enumeration values for the AttributeUsage enumeration

getInstance

public static AttributeUsage getInstance(java.lang.String name)

Returns AttributeUsage enumeration object corresponding to the specified name.

Parameters:

name - name of the attribute usage enumeration

Returns:

instance of the AttributeUsage enumeration object corresponding to the given name, null if there is no enumeration for this name.

getInstance

public static AttributeUsage getInstance(int id)

Returns AttributeUsage enumeration object corresponding to the specified ID.

Parameters:

id - of the attribute usage enumeration

Returns:

instance of the AttributeUsage enumeration object corresponding to the given id, null if there is no enumeration for id.