com.rapidminer.parameter
Class ParameterTypePreview

java.lang.Object
  com.rapidminer.parameter.ParameterType
      com.rapidminer.parameter.ParameterTypePreview

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

public class ParameterTypePreview
extends ParameterType

This parameter type will lead to a GUI element which can be used as initialization for a results preview. This might be practical especially for complex operators which often also provide a configuration wizard.

Author:

Ingo Mierswa

See Also:

Serialized Form

Constructor Summary

ParameterTypePreview(java.lang.Class<? extends PreviewCreator> previewCreatorClass, PreviewListener previewListener)

Method Summary

java.lang.Object	getDefaultValue() Returns null.
PreviewCreator	getPreviewCreator() Returns a new instance of the wizard creator.
PreviewListener	getPreviewListener()
java.lang.String	getRange() Returns null.
java.lang.String	getXML(java.lang.String indent, java.lang.String key, java.lang.String value, boolean hideDefault) Returns an empty string since this parameter cannot be used in XML description but is only used for GUI purposes.
boolean	isNumerical() Returns true if the values of this parameter type are numerical, i.e. might be parsed by Double.parseDouble(String).
void	setDefaultValue(java.lang.Object defaultValue) Does nothing.

Methods inherited from class com.rapidminer.parameter.ParameterType

compareTo, getDescription, getKey, illegalValue, isExpert, isHidden, isOptional, 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

ParameterTypePreview

public ParameterTypePreview(java.lang.Class<? extends PreviewCreator> previewCreatorClass,
                            PreviewListener previewListener)

Method Detail

getPreviewCreator

public PreviewCreator getPreviewCreator()

Returns a new instance of the wizard creator. If anything does not work this method will return null.

getPreviewListener

public PreviewListener getPreviewListener()

getDefaultValue

public java.lang.Object getDefaultValue()

Returns null.

Specified by:

getDefaultValue in class ParameterType

setDefaultValue

public void setDefaultValue(java.lang.Object defaultValue)

Does nothing.

Specified by:

setDefaultValue in class ParameterType

getRange

public java.lang.String getRange()

Returns null.

Specified by:

getRange in class ParameterType

getXML

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

Returns an empty string since this parameter cannot be used in XML description but is only used for GUI purposes.

Specified by:

getXML in class ParameterType

isNumerical

public boolean isNumerical()

Description copied from class: ParameterType

Returns true if the values of this parameter type are numerical, i.e. might be parsed by Double.parseDouble(String). Otherwise false should be returned. This method might be used by parameter logging operators.

Specified by:

isNumerical in class ParameterType