javax.datamining.data
Class PhysicalAttributeRole

java.lang.Object
  |
  +--javax.datamining.Enum
        |
        +--javax.datamining.data.PhysicalAttributeRole

All Implemented Interfaces:

java.lang.Comparable, java.io.Serializable

public class PhysicalAttributeRole

extends Enum

The enumeration PhysicalAttributeRole determines the role of a PhysicalAttribute. A role defines how an algorithm or mining operation will interpret the data in that attribute.

The values defined in JDM are:

• data - The associated PhysicalAttribute represents plain data containing actual values for a logical attribute.
• caseId - The associated PhysicalAttribute represents an attribute that contains identifiers relating multiple records in the multi-record case, i.e., transactional data format.
• attributeName - The associated PhysicalAttribute represents a column of data that contains attribute names of the data values in the multi-record case, i.e., transactional data, format.
• attributeValue - The associated PhysicalAttribute represents a column of data that contains attribute values of the the multi-record case, i.e., transactional data, format.
• taxonomyChildId - The PhysicalAttribute represents a column of data that contains the child identifiers for a taxonomy.
• taxonomyParentId - The associated PhysicalAttribute represents a column of data that contains the parent identifiers for a taxonomy.

Author:

JSR-73 Java Data Mining Expert Group

See Also:

Serialized Form

Field Summary

static PhysicalAttributeRole	attributeName
static PhysicalAttributeRole	attributeValue
static PhysicalAttributeRole	caseId
static PhysicalAttributeRole	data
static PhysicalAttributeRole	taxonomyChildId
static PhysicalAttributeRole	taxonomyParentId

Method Summary

static void	addExtension(java.lang.String name) Adds a vendor extension name to PhysicalAttributeRole.
static PhysicalAttributeRole	valueOf(java.lang.String name) Returns an instance of PhysicalAttributeRole corresponding to the specified name.
static PhysicalAttributeRole[]	values() Returns a list of all PhysicalAttributeRole 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

attributeName

public static final PhysicalAttributeRole attributeName

attributeValue

public static final PhysicalAttributeRole attributeValue

caseId

public static final PhysicalAttributeRole caseId

data

public static final PhysicalAttributeRole data

taxonomyChildId

public static final PhysicalAttributeRole taxonomyChildId

taxonomyParentId

public static final PhysicalAttributeRole taxonomyParentId

Method Detail

addExtension

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

Adds a vendor extension name to PhysicalAttributeRole.

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 PhysicalAttributeRole valueOf(java.lang.String name)
                                     throws JDMException

Returns an instance of PhysicalAttributeRole corresponding to the specified name.

Parameters:

name - The name of the enumeration value

Returns:

PhysicalAttributeRole - The instance of the specified enumeration.

Throws:

JDMException - When name is not valid.

values

public static PhysicalAttributeRole[] values()

Returns a list of all PhysicalAttributeRole enumerations defined.

Returns:

PhysicalAttributeRole[]