Package org.pentaho.aggdes.algorithm

Enum Algorithm.ParameterEnum

java.lang.Object

java.lang.Enum<Algorithm.ParameterEnum>

org.pentaho.aggdes.algorithm.Algorithm.ParameterEnum

All Implemented Interfaces:

Serializable, Comparable<Algorithm.ParameterEnum>, java.lang.constant.Constable, Parameter

Enclosing interface:

Algorithm

public static enum Algorithm.ParameterEnum
extends Enum<Algorithm.ParameterEnum>
implements Parameter

Enumeration of parameters common to all algorithms.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface org.pentaho.aggdes.model.Parameter

Parameter.Type

Enum Constant Summary

Enum Constants

Enum Constant	Description
AGGREGATE_LIMIT
COST_LIMIT
TIME_LIMIT_SECONDS

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns the description of this Parameter.
String	getName()	Returns the name of this Parameter.
Parameter.Type	getType()	Returns the of this Parameter.
boolean	isRequired()	Returns whether the parameter is required.
static Algorithm.ParameterEnum	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Algorithm.ParameterEnum[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TIME_LIMIT_SECONDS

public static final Algorithm.ParameterEnum TIME_LIMIT_SECONDS

AGGREGATE_LIMIT

public static final Algorithm.ParameterEnum AGGREGATE_LIMIT

COST_LIMIT

public static final Algorithm.ParameterEnum COST_LIMIT

Method Details

values

public static Algorithm.ParameterEnum[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Algorithm.ParameterEnum valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isRequired

public boolean isRequired()

Description copied from interface: Parameter

Returns whether the parameter is required.

Specified by:

isRequired in interface Parameter

Returns:

whether Parameter is required

getType

public Parameter.Type getType()

Description copied from interface: Parameter

Returns the of this Parameter.

Specified by:

getType in interface Parameter

Returns:

type of this parameter.

getDescription

public String getDescription()

Description copied from interface: Parameter

Returns the description of this Parameter.

Specified by:

getDescription in interface Parameter

Returns:

description of Parameter

getName

public String getName()

Description copied from interface: Parameter

Returns the name of this Parameter.

Specified by:

getName in interface Parameter

Returns:

name of this Parameter