javax.datamining
Class SortOrder

java.lang.Object
  |
  +--javax.datamining.Enum
        |
        +--javax.datamining.SortOrder

All Implemented Interfaces:

java.lang.Comparable, java.io.Serializable

public class SortOrder

extends Enum

The enumeration SortOrder defines sort order options for objects retrieved from the DME.

Author:

JSR-73 Java Data Mining Expert Group

See Also:

Serialized Form

Field Summary

static SortOrder	ascending
static SortOrder	asIs
static SortOrder	descending
static SortOrder	systemDefault

Method Summary

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

ascending

public static final SortOrder ascending

asIs

public static final SortOrder asIs

descending

public static final SortOrder descending

systemDefault

public static final SortOrder systemDefault

Method Detail

addExtension

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

Adds a vendor extension name to SortOrder.

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

Returns an instance of SortOrder corresponding to the specified name.

Parameters:

name - The name of the enumeration value

Returns:

SortOrder - The instance of the specified enumeration.

Throws:

JDMException - When name is not valid.

values

public static SortOrder[] values()

Returns a list of all SortOrder enumerations defined.

Returns:

SortOrder[]