com.rapidminer.parameter
Class ParameterTypeString

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

Direct Known Subclasses:

ParameterTypeColor, ParameterTypeFile, ParameterTypeMatrix, ParameterTypePassword, ParameterTypeText

public class ParameterTypeString
extends ParameterTypeSingle

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

Author:

Ingo Mierswa, Simon Fischer Exp $

See Also:

Serialized Form

Constructor Summary

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

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

ParameterTypeString(java.lang.String key, java.lang.String description, java.lang.String defaultValue)

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

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

ParameterTypeString

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

ParameterTypeString

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

ParameterTypeString

public ParameterTypeString(java.lang.String key,
                           java.lang.String description,
                           java.lang.String 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.

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