biz.sc.mm.dm

Class UsageOption

java.lang.Object

biz.sc.mm.dm.Enum

biz.sc.mm.dm.UsageOption

All Implemented Interfaces:

java.io.Serializable

public class UsageOption
extends Enum

Defines how given attribute should be used.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static UsageOption	active Indicates that the attribute is used for the mining function.
static UsageOption	inactive Indicates that the attribute is not used for the mining function in any way.
static UsageOption	obligatory Indicates that the attribute has to be in the model, it can not be removed by variable selection algorithm.
static UsageOption	supplementary Indicates that the attribute is not used for the mining function.
static UsageOption	target Indicates that the attribute is active and used as a target for supervised model.
static UsageOption	weight Attribute indicates influence of given observation.

Method Summary

Methods

Modifier and Type	Method and Description
static UsageOption	getInstance(int id) Returns an instance of UsageOption corresponding to the specified ID.
static UsageOption	getInstance(java.lang.String name) Returns an instance of UsageOption corresponding to the specified name.
static UsageOption[]	list() Returns a list of all UsageOption enumerations defined.
static java.lang.String[]	listNames() Returns the names of all UsageOption enumerations defined.

Methods inherited from class biz.sc.mm.dm.Enum

equals, getDefaultValue, getEnum, getID, getInstance, hashCode, isEqual, list, listNames, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

active

public static final UsageOption active

Indicates that the attribute is used for the mining function. This is the default for a mining attribute.

target

public static final UsageOption target

Indicates that the attribute is active and used as a target for supervised model.

inactive

public static final UsageOption inactive

Indicates that the attribute is not used for the mining function in any way.

supplementary

public static final UsageOption supplementary

Indicates that the attribute is not used for the mining function. It can be used to provide additional information used, e.g., for visualization or providing key attributes on apply output.

weight

public static final UsageOption weight

Attribute indicates influence of given observation.

obligatory

public static final UsageOption obligatory

Indicates that the attribute has to be in the model, it can not be removed by variable selection algorithm.

Method Detail

listNames

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

Returns the names of all UsageOption enumerations defined.

Returns:

String[] names of all UsageOption enumerations

list

public static UsageOption[] list()

Returns a list of all UsageOption enumerations defined.

Returns:

UsageOption[] list of all UsageOption enumerations

getInstance

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

Returns an instance of UsageOption corresponding to the specified name.

Parameters:

name - - The name of the enumeration value

Returns:

UsageOption - The instance of the specified enumeration.

getInstance

public static UsageOption getInstance(int id)

Returns an instance of UsageOption corresponding to the specified ID.

Parameters:

id - - The identifier of the enumeration value

Returns:

UsageOption - The instance of the specified enumeration.