com.rapidminer.gui.renderer
Class AbstractRenderer

java.lang.Object
  com.rapidminer.gui.renderer.AbstractRenderer

All Implemented Interfaces:

Renderer, ParameterHandler

Direct Known Subclasses:

AbstractDataTablePlotterRenderer, AbstractGraphRenderer, ClusterModelCentroidPlotRenderer, ClusterModelDendogrammRenderer, ClusterModelFolderRenderer, DefaultComponentRenderer, DistributionModelPlotRenderer, LiftChartRenderer, NeuralNetGraphRenderer, NonGraphicalRenderer, PerformanceVectorRenderer, SimilarityHistogramRenderer, SimilarityKDistanceRenderer, SimpleNeuralNetGraphRenderer

public abstract class AbstractRenderer
extends java.lang.Object
implements Renderer

This is the abstract renderer superclass for all renderers which provide some basic methods for parameter handling.

Author:

Ingo Mierswa

Constructor Summary

AbstractRenderer()

Method Summary

java.lang.String	getParameter(java.lang.String key) Returns a single parameter retrieved from the Parameters of this Operator.
boolean	getParameterAsBoolean(java.lang.String key) Returns a single named parameter and casts it to boolean.
java.awt.Color	getParameterAsColor(java.lang.String key) Returns a single named parameter and casts it to Color.
double	getParameterAsDouble(java.lang.String key) Returns a single named parameter and casts it to double.
java.io.File	getParameterAsFile(java.lang.String key) Returns a single named parameter and casts it to File.
java.io.File	getParameterAsFile(java.lang.String key, boolean createMissingDirectories) Returns a single named parameter and casts it to File.
java.io.InputStream	getParameterAsInputStream(java.lang.String key) Returns a single named parameter and tries to handle it as URL.
int	getParameterAsInt(java.lang.String key) Returns a single named parameter and casts it to int.
double[][]	getParameterAsMatrix(java.lang.String key) Returns a single named parameter and casts it to a double matrix.
java.lang.String	getParameterAsString(java.lang.String key) Returns a single named parameter and casts it to String.
java.util.List<java.lang.String[]>	getParameterList(java.lang.String key) Returns a single named parameter and casts it to List.
Parameters	getParameters() Returns null.
java.util.List<ParameterType>	getParameterTypes() Returns a list of all defined parameter types for this handler.
boolean	isParameterSet(java.lang.String key) Returns true iff the parameter with the given name is set.
void	setListParameter(java.lang.String key, java.util.List<java.lang.String[]> list) Sets the given parameter list to the Parameters object of this operator.
void	setParameter(java.lang.String key, java.lang.String value) Sets the given single parameter to the Parameters object of this operator.
void	setParameters(Parameters parameters) Do nothing.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.rapidminer.gui.renderer.Renderer

createReportable, getName, getVisualizationComponent

Constructor Detail

AbstractRenderer

public AbstractRenderer()

Method Detail

getParameterTypes

public java.util.List<ParameterType> getParameterTypes()

Description copied from interface: ParameterHandler

Returns a list of all defined parameter types for this handler.

Specified by:

getParameterTypes in interface ParameterHandler

getParameter

public java.lang.String getParameter(java.lang.String key)
                              throws UndefinedParameterError

Description copied from interface: ParameterHandler

Returns a single parameter retrieved from the Parameters of this Operator.

Specified by:

getParameter in interface ParameterHandler

Throws:

UndefinedParameterError

toString

public java.lang.String toString()

Specified by:

toString in interface Renderer

Overrides:

toString in class java.lang.Object

getParameterAsBoolean

public boolean getParameterAsBoolean(java.lang.String key)

Description copied from interface: ParameterHandler

Returns a single named parameter and casts it to boolean. This method never throws an exception since there are no non-optional boolean parameters.

Specified by:

getParameterAsBoolean in interface ParameterHandler

getParameterAsColor

public java.awt.Color getParameterAsColor(java.lang.String key)
                                   throws UndefinedParameterError

Description copied from interface: ParameterHandler

Returns a single named parameter and casts it to Color.

Specified by:

getParameterAsColor in interface ParameterHandler

Throws:

UndefinedParameterError

getParameterAsDouble

public double getParameterAsDouble(java.lang.String key)
                            throws UndefinedParameterError

Description copied from interface: ParameterHandler

Returns a single named parameter and casts it to double.

Specified by:

getParameterAsDouble in interface ParameterHandler

Throws:

UndefinedParameterError

getParameterAsInputStream

public java.io.InputStream getParameterAsInputStream(java.lang.String key)
                                              throws UndefinedParameterError,
                                                     java.io.IOException

Description copied from interface: ParameterHandler

Returns a single named parameter and tries to handle it as URL. If this works, this method creates an input stream from this URL and delivers it. If not, this method tries to cast the parameter value to a file. This file is already resolved against the process definition file. If the parameter name defines a non-optional parameter which is not set and has no default value, a UndefinedParameterError will be thrown. If the parameter is optional and was not set this method returns null. Operators should always use this method instead of directly using the method Process.resolveFileName(String).

Specified by:

getParameterAsInputStream in interface ParameterHandler

Throws:

UndefinedParameterError

java.io.IOException

getParameterAsFile

public java.io.File getParameterAsFile(java.lang.String key)
                                throws UndefinedParameterError

Description copied from interface: ParameterHandler

Returns a single named parameter and casts it to File. This file is already resolved against the process definition file. If the parameter name defines a non-optional parameter which is not set and has no default value, a UndefinedParameterError will be thrown. If the parameter is optional and was not set this method returns null. Operators should always use this method instead of directly using the method Process.resolveFileName(String).

Specified by:

getParameterAsFile in interface ParameterHandler

Throws:

UndefinedParameterError

getParameterAsFile

public java.io.File getParameterAsFile(java.lang.String key,
                                       boolean createMissingDirectories)
                                throws UndefinedParameterError

Description copied from interface: ParameterHandler

Returns a single named parameter and casts it to File. This file is already resolved against the process definition file. If the parameter name defines a non-optional parameter which is not set and has no default value, a UndefinedParameterError will be thrown. If the parameter is optional and was not set this method returns null. Operators should always use this method instead of directly using the method Process.resolveFileName(String).

Specified by:

getParameterAsFile in interface ParameterHandler

Throws:

UndefinedParameterError

getParameterAsInt

public int getParameterAsInt(java.lang.String key)
                      throws UndefinedParameterError

Description copied from interface: ParameterHandler

Returns a single named parameter and casts it to int.

Specified by:

getParameterAsInt in interface ParameterHandler

Throws:

UndefinedParameterError

getParameterAsMatrix

public double[][] getParameterAsMatrix(java.lang.String key)
                                throws UndefinedParameterError

Description copied from interface: ParameterHandler

Returns a single named parameter and casts it to a double matrix.

Specified by:

getParameterAsMatrix in interface ParameterHandler

Throws:

UndefinedParameterError

getParameterAsString

public java.lang.String getParameterAsString(java.lang.String key)
                                      throws UndefinedParameterError

Description copied from interface: ParameterHandler

Returns a single named parameter and casts it to String.

Specified by:

getParameterAsString in interface ParameterHandler

Throws:

UndefinedParameterError

getParameterList

public java.util.List<java.lang.String[]> getParameterList(java.lang.String key)
                                                    throws UndefinedParameterError

Description copied from interface: ParameterHandler

Returns a single named parameter and casts it to List. The list returned by this method contains the user defined key-value pairs. Each element is an Object array of length 2. The first element is the key (String) the second the parameter value object, e.g. a Double object for ParameterTypeDouble. Since the definition of typed lists for arrays is not possible the caller have to perform the casts to the object arrays and from there to the actual types himself.

Specified by:

getParameterList in interface ParameterHandler

Throws:

UndefinedParameterError

isParameterSet

public boolean isParameterSet(java.lang.String key)
                       throws UndefinedParameterError

Description copied from interface: ParameterHandler

Returns true iff the parameter with the given name is set.

Specified by:

isParameterSet in interface ParameterHandler

Throws:

UndefinedParameterError

setListParameter

public void setListParameter(java.lang.String key,
                             java.util.List<java.lang.String[]> list)

Description copied from interface: ParameterHandler

Sets the given parameter list to the Parameters object of this operator. For single parameters the method ParameterHandler.setParameter(String, String) should be used.

Specified by:

setListParameter in interface ParameterHandler

setParameter

public void setParameter(java.lang.String key,
                         java.lang.String value)

Description copied from interface: ParameterHandler

Sets the given single parameter to the Parameters object of this operator. For parameter list the method ParameterHandler.setListParameter(String, List) should be used.

Specified by:

setParameter in interface ParameterHandler

setParameters

public void setParameters(Parameters parameters)

Do nothing.

Specified by:

setParameters in interface ParameterHandler

getParameters

public Parameters getParameters()

Returns null.

Specified by:

getParameters in interface ParameterHandler