javax.datamining.task
Class SettingsInclusionOption

java.lang.Object
  |
  +--javax.datamining.Enum
        |
        +--javax.datamining.task.SettingsInclusionOption

All Implemented Interfaces:

java.lang.Comparable, java.io.Serializable

public class SettingsInclusionOption

extends Enum

The enumeration SettingsOption lists the options of how to include the settings objects contained in a model.

Author:

JSR-73 Java Data Mining Expert Group

See Also:

Serialized Form

Field Summary

static SettingsInclusionOption	all
static SettingsInclusionOption	allSettingsOnly
static SettingsInclusionOption	effectiveSettings
static SettingsInclusionOption	effectiveSettingsOnly
static SettingsInclusionOption	none
static SettingsInclusionOption	settings
static SettingsInclusionOption	settingsOnly
static SettingsInclusionOption	systemDefault

Method Summary

static void	addExtension(java.lang.String name) Adds a vendor extension name to SettingsInclusionOption.
static SettingsInclusionOption	valueOf(java.lang.String name) Returns an instance of SettingsInclusionOption corresponding to the specified name.
static SettingsInclusionOption[]	values() Returns a list of all SettingsInclusionOption enumerations defined.

Methods inherited from class javax.datamining.Enum

compareTo, equals, name

Methods inherited from class java.lang.Object

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

Field Detail

all

public static final SettingsInclusionOption all

allSettingsOnly

public static final SettingsInclusionOption allSettingsOnly

effectiveSettings

public static final SettingsInclusionOption effectiveSettings

effectiveSettingsOnly

public static final SettingsInclusionOption effectiveSettingsOnly

none

public static final SettingsInclusionOption none

settings

public static final SettingsInclusionOption settings

settingsOnly

public static final SettingsInclusionOption settingsOnly

systemDefault

public static final SettingsInclusionOption systemDefault

Method Detail

addExtension

public static void addExtension(java.lang.String name)
                         throws JDMException

Adds a vendor extension name to SettingsInclusionOption.

Parameters:

name - The name of the unique vendor extension

Throws:

JDMException - When name is an invalid string or redundant to existing standard enums.

valueOf

public static SettingsInclusionOption valueOf(java.lang.String name)
                                       throws JDMException

Returns an instance of SettingsInclusionOption corresponding to the specified name.

Parameters:

name - The name of the enumeration value

Returns:

SettingsInclusionOption - The instance of the specified enumeration.

Throws:

JDMException - When name is not valid.

values

public static SettingsInclusionOption[] values()

Returns a list of all SettingsInclusionOption enumerations defined.

Returns:

SettingsInclusionOption[]