com.rapidminer.parameter
Class ParameterTypeStringCategory

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

public class ParameterTypeStringCategory
extends ParameterTypeSingle

A parameter type for categories. These are several Strings and one of these is the default value. Additionally users can define other strings than these given in as pre-defined categories. Operators ask for the defined String with the method Operator.getParameterAsString(String).

Author:

Ingo Mierswa, Simon Fischer ingomierswa Exp $

See Also:

Serialized Form

Constructor Summary

ParameterTypeStringCategory(java.lang.String key, java.lang.String description, java.lang.String[] categories)

ParameterTypeStringCategory(java.lang.String key, java.lang.String description, java.lang.String[] categories, 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.
java.lang.String[]	getValues()
boolean	isEditable()
boolean	isNumerical() Returns false.
boolean	isOptional() Returns true if this parameter is optional.
void	setDefaultValue(java.lang.Object defaultValue) Sets the default value.
void	setEditable(boolean editable)
java.lang.String	toString(java.lang.Object value) Returns a string representation of this 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, toXMLString, transformNewValue

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterTypeStringCategory

public ParameterTypeStringCategory(java.lang.String key,
                                   java.lang.String description,
                                   java.lang.String[] categories)

ParameterTypeStringCategory

public ParameterTypeStringCategory(java.lang.String key,
                                   java.lang.String description,
                                   java.lang.String[] categories,
                                   java.lang.String defaultValue)

Method Detail

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

setEditable

public void setEditable(boolean editable)

isEditable

public boolean isEditable()

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

toString

public java.lang.String toString(java.lang.Object value)

Description copied from class: ParameterType

Returns a string representation of this value.

Overrides:

toString in class ParameterType

getValues

public java.lang.String[] getValues()

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