javax.datamining.clustering
Class AttributeComparisonFunction

java.lang.Object
  |
  +--javax.datamining.Enum
        |
        +--javax.datamining.clustering.AttributeComparisonFunction

All Implemented Interfaces:

java.lang.Comparable, java.io.Serializable

public class AttributeComparisonFunction

extends Enum

The enumeration AttributeComparisonFunction describes the comparison function to be used to determine the similarity between two values of an attribute (inner comparison function). If a similarity matrix is provided for comparison, similarityMatrixis recommended which corresponds to table in PMML 2.0.

Author:

JSR-73 Java Data Mining Expert Group

See Also:

Serialized Form

Field Summary

static AttributeComparisonFunction	absDiff
static AttributeComparisonFunction	delta
static AttributeComparisonFunction	equal
static AttributeComparisonFunction	gaussSim
static AttributeComparisonFunction	similarityMatrix
static AttributeComparisonFunction	systemDefault
static AttributeComparisonFunction	systemDetermined

Method Summary

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

absDiff

public static final AttributeComparisonFunction absDiff

delta

public static final AttributeComparisonFunction delta

equal

public static final AttributeComparisonFunction equal

gaussSim

public static final AttributeComparisonFunction gaussSim

similarityMatrix

public static final AttributeComparisonFunction similarityMatrix

systemDefault

public static final AttributeComparisonFunction systemDefault

systemDetermined

public static final AttributeComparisonFunction systemDetermined

Method Detail

addExtension

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

Adds a vendor extension name to AttributeComparisonFunction.

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

Returns an instance of AttributeComparisonFunction corresponding to the specified name.

Parameters:

name - The name of the enumeration value

Returns:

AttributeComparisonFunction - The instance of the specified enumeration.

Throws:

JDMException - When name is not valid.

values

public static AttributeComparisonFunction[] values()

Returns a list of all AttributeComparisonFunction enumerations defined.

Returns:

AttributeComparisonFunction[]