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:

ParameterTypeAttribute, ParameterTypeColor, ParameterTypeExpression, ParameterTypeFile, ParameterTypeMatrix, ParameterTypePassword, ParameterTypeRegexp, ParameterTypeRepositoryLocation, 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

See Also:

Serialized Form

Field Summary

Fields inherited from class com.rapidminer.parameter.ParameterType

ELEMENT_PARAMETER_TYPE

Constructor Summary

ParameterTypeString(org.w3c.dom.Element element)

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, boolean optional, boolean expert)

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

ParameterTypeString(java.lang.String key, java.lang.String description, java.lang.String 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.
void	setDefaultValue(java.lang.Object defaultValue) Sets the default value.
protected void	writeDefinitionToXML(org.w3c.dom.Element typeElement) Subclasses must store all their properties inside the typeElement and must be able to reload it from their using the constructor (Operator operator, Element element).

Methods inherited from class com.rapidminer.parameter.ParameterTypeSingle

getXML, getXML, substituteMacros, toXMLString

Methods inherited from class com.rapidminer.parameter.ParameterType

compareTo, createType, getConditions, getDefaultValueAsString, getDefinitionAsXML, getDependencyConditions, getDescription, getKey, illegalValue, isDeprecated, isExpert, isHidden, isOptional, notifyOperatorRenaming, registerDependencyCondition, setDeprecated, setDescription, setExpert, setHidden, setKey, setOptional, 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(org.w3c.dom.Element element)
                    throws XMLException

Throws:

XMLException

ParameterTypeString

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

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,
                           boolean expert)

ParameterTypeString

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

Method Detail

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

writeDefinitionToXML

protected void writeDefinitionToXML(org.w3c.dom.Element typeElement)

Description copied from class: ParameterType

Subclasses must store all their properties inside the typeElement and must be able to reload it from their using the constructor (Operator operator, Element element). This constructor is called via reflection. This method should be abstract, but in order to keep the class compatible with existing extensions, this only throws an unsupported exception.

Overrides:

writeDefinitionToXML in class ParameterType