com.rapidminer.parameter
Class ParameterTypeList

java.lang.Object
  com.rapidminer.parameter.ParameterType
      com.rapidminer.parameter.CombinedParameterType
          com.rapidminer.parameter.ParameterTypeList

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

public class ParameterTypeList
extends CombinedParameterType

A parameter type for parameter lists. Operators ask for the list of the specified values with Operator.getParameterList(String). Please note that in principle arbitrary parameter types can be used for the list values. Internally, however, all values are transformed to strings. Therefore, operators retrieving values from non-string lists (for example for a parameter type category) have to transform the values themself, e.g. with the following code:

int index = ((ParameterTypeCategory)((ParameterTypeList)getParameters().getParameterType(PARAMETER_LIST)).getValueType()).getIndex(pair[1]);

Author:

Ingo Mierswa, Simon Fischer

See Also:

Serialized Form

Constructor Summary

ParameterTypeList(java.lang.String key, java.lang.String description, ParameterType valueType)
Deprecated.

ParameterTypeList(java.lang.String key, java.lang.String description, ParameterType valueType, java.util.List<java.lang.String[]> defaultList)
Deprecated.

ParameterTypeList(java.lang.String key, java.lang.String description, ParameterType keyType, ParameterType valueType)

ParameterTypeList(java.lang.String key, java.lang.String description, ParameterType keyType, ParameterType valueType, boolean expert)

ParameterTypeList(java.lang.String key, java.lang.String description, ParameterType keyType, ParameterType valueType, java.util.List<java.lang.String[]> defaultList)

ParameterTypeList(java.lang.String key, java.lang.String description, ParameterType keyType, ParameterType valueType, java.util.List<java.lang.String[]> defaultList, boolean expert)

Method Summary

java.lang.Object	getDefaultValue() Returns a value that can be used if the parameter is not set.
ParameterType	getKeyType()
java.lang.String	getRange() Returns a human readable description of the range.
ParameterType	getValueType()
org.w3c.dom.Element	getXML(java.lang.String key, java.lang.String value, boolean hideDefault, org.w3c.dom.Document doc)
java.lang.String	getXML(java.lang.String indent, java.lang.String key, java.lang.String value, boolean hideDefault) Deprecated. Replaced by DOM.
boolean	isNumerical() Returns false.
java.lang.String	notifyOperatorRenaming(java.lang.String oldOperatorName, java.lang.String newOperatorName, java.lang.String parameterValue) This method gives a hook for the parameter type to react on a renaming of an operator.
void	setDefaultValue(java.lang.Object defaultValue) Sets the default value.
java.lang.String	substituteMacros(java.lang.String parameterValue, MacroHandler mh) This method operates on the internal string representation of parameter values and replaces macro expressions of the form %{macroName}.
java.lang.String	toString(java.lang.Object value) Returns a string representation of this value.
static java.lang.String	transformList2String(java.util.List<java.lang.String[]> parameterList)
static java.util.List<java.lang.String[]>	transformString2List(java.lang.String listString)

Methods inherited from class com.rapidminer.parameter.CombinedParameterType

containsType

Methods inherited from class com.rapidminer.parameter.ParameterType

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

ParameterTypeList

@Deprecated
public ParameterTypeList(java.lang.String key,
                                    java.lang.String description,
                                    ParameterType valueType)

Deprecated.

ParameterTypeList

@Deprecated
public ParameterTypeList(java.lang.String key,
                                    java.lang.String description,
                                    ParameterType valueType,
                                    java.util.List<java.lang.String[]> defaultList)

Deprecated.

ParameterTypeList

public ParameterTypeList(java.lang.String key,
                         java.lang.String description,
                         ParameterType keyType,
                         ParameterType valueType,
                         boolean expert)

ParameterTypeList

public ParameterTypeList(java.lang.String key,
                         java.lang.String description,
                         ParameterType keyType,
                         ParameterType valueType)

ParameterTypeList

public ParameterTypeList(java.lang.String key,
                         java.lang.String description,
                         ParameterType keyType,
                         ParameterType valueType,
                         java.util.List<java.lang.String[]> defaultList,
                         boolean expert)

ParameterTypeList

public ParameterTypeList(java.lang.String key,
                         java.lang.String description,
                         ParameterType keyType,
                         ParameterType valueType,
                         java.util.List<java.lang.String[]> defaultList)

Method Detail

getValueType

public ParameterType getValueType()

getKeyType

public ParameterType getKeyType()

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

getXML

public org.w3c.dom.Element getXML(java.lang.String key,
                                  java.lang.String value,
                                  boolean hideDefault,
                                  org.w3c.dom.Document doc)

Specified by:

getXML in class ParameterType

getXML

@Deprecated
public java.lang.String getXML(java.lang.String indent,
                                          java.lang.String key,
                                          java.lang.String value,
                                          boolean hideDefault)

Deprecated. Replaced by DOM.

Description copied from class: ParameterType

Writes an xml representation of the given key-value pair.

Specified by:

getXML 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

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

transformList2String

public static java.lang.String transformList2String(java.util.List<java.lang.String[]> parameterList)

transformString2List

public static java.util.List<java.lang.String[]> transformString2List(java.lang.String listString)

notifyOperatorRenaming

public java.lang.String notifyOperatorRenaming(java.lang.String oldOperatorName,
                                               java.lang.String newOperatorName,
                                               java.lang.String parameterValue)

Description copied from class: ParameterType

This method gives a hook for the parameter type to react on a renaming of an operator. It must return the correctly modified String value. The default implementation does nothing.

Overrides:

notifyOperatorRenaming in class ParameterType

substituteMacros

public java.lang.String substituteMacros(java.lang.String parameterValue,
                                         MacroHandler mh)

Description copied from class: ParameterType

This method operates on the internal string representation of parameter values and replaces macro expressions of the form %{macroName}. NOTE: This method will soon be removed or changed again since the internal representation of parameter values will no longer be strings. Then, this method will accept an Object, (possibly using generics) as input.

Specified by:

substituteMacros in class ParameterType