com.rapidminer.parameter
Class ParameterTypeInt

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

public class ParameterTypeInt
extends ParameterTypeNumber

A parameter type for integer values. Operators ask for the integer value with Operator.getParameterAsInt(String). For infinite ranges Integer.MIN_VALUE and Integer.MAX_VALUE should be used.

Author:

Ingo Mierswa, Simon Fischer Exp $

See Also:

Serialized Form

Constructor Summary

ParameterTypeInt(java.lang.String key, java.lang.String description, int min, int max)

ParameterTypeInt(java.lang.String key, java.lang.String description, int min, int max, boolean optional)

ParameterTypeInt(java.lang.String key, java.lang.String description, int min, int max, int defaultValue)

Method Summary

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

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

ParameterTypeInt

public ParameterTypeInt(java.lang.String key,
                        java.lang.String description,
                        int min,
                        int max)

ParameterTypeInt

public ParameterTypeInt(java.lang.String key,
                        java.lang.String description,
                        int min,
                        int max,
                        boolean optional)

ParameterTypeInt

public ParameterTypeInt(java.lang.String key,
                        java.lang.String description,
                        int min,
                        int max,
                        int defaultValue)

Method Detail

setMinValue

public void setMinValue(int min)

getMaxValue

public void getMaxValue(int max)

getMinValue

public double getMinValue()

Specified by:

getMinValue in class ParameterTypeNumber

getMaxValue

public double getMaxValue()

Specified by:

getMaxValue in class ParameterTypeNumber

getMinValueInt

public int getMinValueInt()

getMaxValueInt

public int getMaxValueInt()

getDefaultInt

public int getDefaultInt()

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

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

getStringRepresentation

public java.lang.String getStringRepresentation(int value)