com.rapidminer.operator.io
Class ParameterSetWriter

java.lang.Object
  extended by com.rapidminer.operator.Operator
      extended by com.rapidminer.operator.io.AbstractWriter<ParameterSet>
          extended by com.rapidminer.operator.io.ParameterSetWriter
All Implemented Interfaces:
ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

public class ParameterSetWriter
extends AbstractWriter<ParameterSet>

Writes a parameter set into a file. This can be created by one of the parameter optimization operators, e.g. GridSearchParameterOptimizationOperator. It can then be applied to the operators of the process using a ParameterSetter.

Author:
Simon Fischer, Ingo Mierswa Exp $

Field Summary
static java.lang.String PARAMETER_PARAMETER_FILE
          The parameter name for "A file containing a parameter set.
 
Constructor Summary
ParameterSetWriter(OperatorDescription description)
           
 
Method Summary
 java.util.List<ParameterType> getParameterTypes()
          Returns a list of ParameterTypes describing the parameters of this operator.
 ParameterSet write(ParameterSet parameterSet)
          Creates (or reads) the ExampleSet that will be returned by AbstractWriter.apply().
 
Methods inherited from class com.rapidminer.operator.io.AbstractWriter
apply, getInputClasses, getOutputClasses
 
Methods inherited from class com.rapidminer.operator.Operator
addError, addValue, addWarning, apply, checkDeprecations, checkForStop, checkIO, checkProperties, clearErrorList, cloneOperator, createExperimentTree, createExperimentTree, createFromXML, createMarkedExperimentTree, createMarkedProcessTree, createProcessTree, createProcessTree, getAddOnlyAdditionalOutput, getApplyCount, getDeliveredOutputClasses, getDeprecationInfo, getDesiredInputClasses, getEncoding, getErrorList, getExperiment, getInnerOperatorsXML, getInput, getInput, getInput, getInputDescription, getIOContainerForInApplyLoopBreakpoint, getIODescription, getLog, getName, getOperatorClassName, getOperatorDescription, getParameter, getParameterAsBoolean, getParameterAsColor, getParameterAsDouble, getParameterAsFile, getParameterAsFile, getParameterAsInputStream, getParameterAsInt, getParameterAsMatrix, getParameterAsString, getParameterList, getParameters, getParameterType, getParent, getProcess, getStartTime, getStatus, getUserDescription, getValue, getValues, getXML, hasBreakpoint, hasBreakpoint, hasInput, inApplyLoop, isDebugMode, isEnabled, isExpanded, isParallel, isParameterSet, log, logError, logNote, logWarning, performAdditionalChecks, processFinished, processStarts, register, registerOperator, remove, rename, resume, setApplyCount, setBreakpoint, setEnabled, setExpanded, setInput, setListParameter, setOperatorParameters, setParameter, setParameters, setParent, setUserDescription, toString, unregisterOperator, writeXML
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

PARAMETER_PARAMETER_FILE

public static final java.lang.String PARAMETER_PARAMETER_FILE
The parameter name for "A file containing a parameter set."

See Also:
Constant Field Values
Constructor Detail

ParameterSetWriter

public ParameterSetWriter(OperatorDescription description)
Method Detail

write

public ParameterSet write(ParameterSet parameterSet)
                   throws OperatorException
Description copied from class: AbstractWriter
Creates (or reads) the ExampleSet that will be returned by AbstractWriter.apply().

Specified by:
write in class AbstractWriter<ParameterSet>
Returns:
the written IOObject itself
Throws:
OperatorException

getParameterTypes

public java.util.List<ParameterType> getParameterTypes()
Description copied from class: Operator
Returns a list of ParameterTypes describing the parameters of this operator. The default implementation returns an empty list if no input objects can be retained and special parameters for those input objects which can be prevented from being consumed.

Specified by:
getParameterTypes in interface ParameterHandler
Overrides:
getParameterTypes in class Operator


Copyright © 2001-2009 by Rapid-I