com.rapidminer.operator.meta
Class ParameterSet

java.lang.Object
  com.rapidminer.operator.AbstractIOObject
      com.rapidminer.operator.ResultObjectAdapter
          com.rapidminer.operator.meta.ParameterSet

All Implemented Interfaces:

IOObject, ResultObject, LoggingHandler, java.io.Serializable

public class ParameterSet
extends ResultObjectAdapter

A set of parameters generated by a ParameterOptimizationOperator.

Author:

Simon Fischer, Ingo Mierswa

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.rapidminer.operator.AbstractIOObject

AbstractIOObject.InputStreamProvider

Constructor Summary

ParameterSet(Operator[] operators, java.lang.String[] parameters, java.lang.String[] values, PerformanceVector value)
Constructs a new ParameterSet.

Method Summary

void	applyAll(Process process, java.util.Map<java.lang.String,java.lang.String> nameTranslation) Applies all parameters in the set to their operators.
java.lang.String	getExtension()
java.lang.String	getFileDescription()
java.lang.String	getName() The default implementation returns the classname without package.
java.util.Iterator<ParameterValue>	getParameterValues()
PerformanceVector	getPerformance() Returns the performance of this parameter set.
static ParameterSet	readParameterSet(java.io.InputStream in) Reads a parameter set from a file.
void	save(java.io.File file)
java.lang.String	toString()
void	writeParameterSet(java.io.PrintWriter out, java.nio.charset.Charset encoding)

Methods inherited from class com.rapidminer.operator.ResultObjectAdapter

addAction, getActions, getAnnotations, getResultIcon, log, log, logError, logNote, logWarning, toHTML, toResultString

Methods inherited from class com.rapidminer.operator.AbstractIOObject

appendOperatorToHistory, copy, getLog, getProcessingHistory, getSource, initWriting, read, read, read, read, setLoggingHandler, setSource, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.rapidminer.operator.IOObject

appendOperatorToHistory, copy, getLog, getProcessingHistory, getSource, setLoggingHandler, setSource, write

Constructor Detail

ParameterSet

public ParameterSet(Operator[] operators,
                    java.lang.String[] parameters,
                    java.lang.String[] values,
                    PerformanceVector value)

Constructs a new ParameterSet. The three arrays must have equal length. For each i, the ParameterSet specifies the value values[i] for the parameter parameters[i] of the operator named operators[i].

Method Detail

getName

public java.lang.String getName()

Description copied from class: ResultObjectAdapter

The default implementation returns the classname without package.

Specified by:

getName in interface ResultObject

Overrides:

getName in class ResultObjectAdapter

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getPerformance

public PerformanceVector getPerformance()

Returns the performance of this parameter set. Attension: This may be null if the ParameterSet was read from a file.

applyAll

public void applyAll(Process process,
                     java.util.Map<java.lang.String,java.lang.String> nameTranslation)

Applies all parameters in the set to their operators. The entries in the nameMap can be used if the names of the operators in two processes (one parameter optimization process and one application process) are not the same. Each entry in nameMap maps the name read from the file to the name of the operator in the process definition.

save

public void save(java.io.File file)
          throws java.io.IOException

Throws:

java.io.IOException

getExtension

public java.lang.String getExtension()

getFileDescription

public java.lang.String getFileDescription()

getParameterValues

public java.util.Iterator<ParameterValue> getParameterValues()

writeParameterSet

public void writeParameterSet(java.io.PrintWriter out,
                              java.nio.charset.Charset encoding)

readParameterSet

public static ParameterSet readParameterSet(java.io.InputStream in)
                                     throws java.io.IOException

Reads a parameter set from a file.

Throws:

java.io.IOException