com.rapidminer.parameter
Class ParameterTypeChar

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

public class ParameterTypeChar
extends ParameterTypeSingle

A parameter type for char values. Operators ask for the value with Operator.getParameterAsChar(String).

Author:

Tobias Malbrecht

See Also:

Serialized Form

Constructor Summary

ParameterTypeChar(java.lang.String key, java.lang.String description)

ParameterTypeChar(java.lang.String key, java.lang.String description, boolean optional)

ParameterTypeChar(java.lang.String key, java.lang.String description, boolean optional, boolean expert)

ParameterTypeChar(java.lang.String key, java.lang.String description, char defaultValue)

ParameterTypeChar(java.lang.String key, java.lang.String description, char defaultValue, boolean expert)

Method Summary

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.
boolean	isOptional() Returns true if this parameter is optional.
void	setDefaultValue(java.lang.Object defaultValue) Sets the default value.
void	setOptional(boolean optional)

Methods inherited from class com.rapidminer.parameter.ParameterTypeSingle

getXML, getXML, substituteMacros, toXMLString

Methods inherited from class com.rapidminer.parameter.ParameterType

compareTo, getConditions, getDefaultValueAsString, getDependencyConditions, getDescription, getKey, illegalValue, isExpert, isHidden, notifyOperatorRenaming, registerDependencyCondition, setDeprecated, 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

ParameterTypeChar

public ParameterTypeChar(java.lang.String key,
                         java.lang.String description,
                         boolean optional,
                         boolean expert)

ParameterTypeChar

public ParameterTypeChar(java.lang.String key,
                         java.lang.String description,
                         boolean optional)

ParameterTypeChar

public ParameterTypeChar(java.lang.String key,
                         java.lang.String description)

ParameterTypeChar

public ParameterTypeChar(java.lang.String key,
                         java.lang.String description,
                         char defaultValue,
                         boolean expert)

ParameterTypeChar

public ParameterTypeChar(java.lang.String key,
                         java.lang.String description,
                         char defaultValue)

Method Detail

setOptional

public void setOptional(boolean optional)

isOptional

public boolean isOptional()

Description copied from class: ParameterType

Returns true if this parameter is optional. The default implementation returns true. Please note that this method cannot be accessed during getParameterTypes() method invocations, because it relies on getting the Parameters object, which is then not created.

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