com.rapidminer.parameter
Class ParameterTypeDouble

java.lang.Object
  com.rapidminer.parameter.ParameterType
      com.rapidminer.parameter.ParameterTypeSingle
          com.rapidminer.parameter.ParameterTypeNumber
              com.rapidminer.parameter.ParameterTypeDouble

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

public class ParameterTypeDouble
extends ParameterTypeNumber

A parameter type for double values. Operators ask for the double value with Operator.getParameterAsDouble(String). For infinite ranges Double.POSITIVE_INFINITY and Double.NEGATIVE_INFINITY should be used.

Author:

Ingo Mierswa, Simon Fischer Exp $

See Also:

Serialized Form

Constructor Summary

ParameterTypeDouble(java.lang.String key, java.lang.String description, double min, double max)

ParameterTypeDouble(java.lang.String key, java.lang.String description, double min, double max, boolean optional)

ParameterTypeDouble(java.lang.String key, java.lang.String description, double min, double max, double defaultValue)

Method Summary

java.lang.Object	getDefaultValue() Returns a value that can be used if the parameter is not set.
double	getMaxValue()
double	getMinValue()
java.lang.String	getRange() Returns a human readable description of the range.
boolean	isNumerical() Returns true.
boolean	isOptional() Returns true if this parameter is optional.
void	setDefaultValue(java.lang.Object object) Sets the default value.

Methods inherited from class com.rapidminer.parameter.ParameterTypeSingle

getXML

Methods inherited from class com.rapidminer.parameter.ParameterType

compareTo, getDescription, getKey, illegalValue, isExpert, isHidden, registerDependencyCondition, setDescription, setExpert, setHidden, setKey, setShowRange, showRange, toString, toString, toXMLString, transformNewValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ParameterTypeDouble

public ParameterTypeDouble(java.lang.String key,
                           java.lang.String description,
                           double min,
                           double max)

ParameterTypeDouble

public ParameterTypeDouble(java.lang.String key,
                           java.lang.String description,
                           double min,
                           double max,
                           boolean optional)

ParameterTypeDouble

public ParameterTypeDouble(java.lang.String key,
                           java.lang.String description,
                           double min,
                           double max,
                           double defaultValue)

Method Detail

getMinValue

public double getMinValue()

Specified by:

getMinValue in class ParameterTypeNumber

getMaxValue

public double getMaxValue()

Specified by:

getMaxValue in class ParameterTypeNumber

isOptional

public boolean isOptional()

Description copied from class: ParameterType

Returns true if this parameter is optional. The default implementation returns true.

Overrides:

isOptional in class ParameterType

getDefaultValue

public java.lang.Object getDefaultValue()

Description copied from class: ParameterType

Returns a value that can be used if the parameter is not set.

Specified by:

getDefaultValue in class ParameterType

setDefaultValue

public void setDefaultValue(java.lang.Object object)

Description copied from class: ParameterType

Sets the default value.

Specified by:

setDefaultValue in class ParameterType

isNumerical

public boolean isNumerical()

Returns true.

Specified by:

isNumerical in class ParameterType

getRange

public java.lang.String getRange()

Description copied from class: ParameterType

Returns a human readable description of the range.

Specified by:

getRange in class ParameterType