com.rapidminer.parameter
Class ParameterTypeBoolean

java.lang.Object
  com.rapidminer.parameter.ParameterType
      com.rapidminer.parameter.ParameterTypeSingle
          com.rapidminer.parameter.ParameterTypeBoolean

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

public class ParameterTypeBoolean
extends ParameterTypeSingle

A parameter type for boolean parameters. Operators ask for the boolean value with Operator.getParameterAsBoolean(String).

Author:

Ingo Mierswa, Simon Fischer Exp $

See Also:

Serialized Form

Constructor Summary

ParameterTypeBoolean(java.lang.String key, java.lang.String description, boolean defaultValue)

Method Summary

boolean	getDefault()
java.lang.Object	getDefaultValue() Returns a value that can be used if the parameter is not set.
java.lang.String	getRange() Returns a human readable description of the range.
boolean	isNumerical() Returns false.
void	setDefaultValue(java.lang.Object defaultValue) 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, isOptional, 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

ParameterTypeBoolean

public ParameterTypeBoolean(java.lang.String key,
                            java.lang.String description,
                            boolean defaultValue)

Method Detail

getDefault

public boolean getDefault()

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 defaultValue)

Description copied from class: ParameterType

Sets the default value.

Specified by:

setDefaultValue in class ParameterType

isNumerical

public boolean isNumerical()

Returns false.

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