com.rapidminer.operator
Class IOStorageOperator

java.lang.Object
  com.rapidminer.tools.AbstractObservable<Operator>
      com.rapidminer.operator.Operator
          com.rapidminer.operator.IOStorageOperator

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ResourceConsumer, ParameterHandler, LoggingHandler, Observable<Operator>

public class IOStorageOperator
extends Operator

This operator can be used to store the given IOObject into the process under the specified name (the IOObject will be "hidden" and can not be directly accessed by following operators. In order to retrieve the stored object and make it again accessible, you can use the operator IORetrievalOperator. The combination of those two operators can be used to build complex processes where an input object is used in completely different parts or loops of processes.

Author:

Ingo Mierswa

Field Summary

static java.lang.String	PARAMETER_IO_OBJECT
static java.lang.String	PARAMETER_NAME
static java.lang.String	PARAMETER_REMOVE_FROM_PROCESS
static java.lang.String	PARAMETER_STORE_WHICH

Constructor Summary

IOStorageOperator(OperatorDescription description)

Method Summary

void	doWork() Performs the actual work of the operator and must be implemented by subclasses.
java.util.List<ParameterType>	getParameterTypes() Returns a list of ParameterTypes describing the parameters of this operator.
java.util.LinkedList<OutputPort>	preAutoWire(java.util.LinkedList<OutputPort> ports) This method is called before auto-wiring an operator.
boolean	shouldAutoConnect(OutputPort port) By default, all ports will be auto-connected by ExecutionUnit.autoWire(CompatibilityLevel, boolean, boolean).

Methods inherited from class com.rapidminer.operator.Operator

acceptsInput, addError, addError, addValue, addWarning, apply, apply, assumePreconditionsSatisfied, checkAll, checkAllExcludingMetaData, checkDeprecations, checkForStop, checkIO, checkProperties, clear, clearErrorList, cloneOperator, collectErrors, createExperimentTree, createExperimentTree, createFromXML, createFromXML, createFromXML, createMarkedExperimentTree, createMarkedProcessTree, createProcessTree, createProcessTree, disconnectPorts, execute, fireUpdate, freeMemory, getAddOnlyAdditionalOutput, getApplyCount, getCompatibilityLevel, getDeliveredOutputClasses, getDeprecationInfo, getDesiredInputClasses, getDOMRepresentation, getEncoding, getErrorList, getExecutionUnit, getExperiment, getIncompatibleVersionChanges, getInput, getInput, getInput, getInputClasses, getInputDescription, getInputPorts, getIODescription, getLog, getLogger, getName, getNumberOfBreakpoints, getOperatorClassName, getOperatorDescription, getOutputClasses, getOutputPorts, getParameter, getParameterAsBoolean, getParameterAsChar, getParameterAsColor, getParameterAsDouble, getParameterAsFile, getParameterAsFile, getParameterAsInputStream, getParameterAsInt, getParameterAsMatrix, getParameterAsRepositoryLocation, getParameterAsString, getParameterHandler, getParameterList, getParameters, getParameterTupel, getParameterType, getParent, getPortOwner, getProcess, getResourceConsumptionEstimator, getRoot, getStartTime, getTransformer, getUserDescription, getValue, getValues, getXML, getXML, getXML, hasBreakpoint, hasBreakpoint, hasInput, inApplyLoop, isDebugMode, isDirty, isEnabled, isExpanded, isParallel, isParameterSet, isRunning, log, log, logError, logNote, logWarning, lookupOperator, makeDirty, makeDirtyOnUpdate, notifyRenaming, performAdditionalChecks, processFinished, processStarts, producesOutput, propagateDirtyness, register, registerOperator, remove, removeAndKeepConnections, rename, resume, setBreakpoint, setCompatibilityLevel, setEnabled, setEnclosingProcess, setExpanded, setInput, setListParameter, setPairParameter, setParameter, setParameters, setUserDescription, shouldAutoConnect, shouldStopStandaloneExecution, toString, transformMetaData, unregisterOperator, updateExecutionOrder, walk, writeXML, writeXML

Methods inherited from class com.rapidminer.tools.AbstractObservable

addObserver, addObserverAsFirst, fireUpdate, removeObserver

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_NAME

public static final java.lang.String PARAMETER_NAME

See Also:

Constant Field Values

PARAMETER_IO_OBJECT

public static final java.lang.String PARAMETER_IO_OBJECT

See Also:

Constant Field Values

PARAMETER_STORE_WHICH

public static final java.lang.String PARAMETER_STORE_WHICH

See Also:

Constant Field Values

PARAMETER_REMOVE_FROM_PROCESS

public static final java.lang.String PARAMETER_REMOVE_FROM_PROCESS

See Also:

Constant Field Values

Constructor Detail

IOStorageOperator

public IOStorageOperator(OperatorDescription description)

Method Detail

doWork

public void doWork()
            throws OperatorException

Description copied from class: Operator

Performs the actual work of the operator and must be implemented by subclasses. Replaces the old method apply().

Overrides:

doWork in class Operator

Throws:

OperatorException

shouldAutoConnect

public boolean shouldAutoConnect(OutputPort port)

Description copied from class: Operator

By default, all ports will be auto-connected by ExecutionUnit.autoWire(CompatibilityLevel, boolean, boolean). Optional outputs were handled up to version 4.4 by parameters. From 5.0 on, optional outputs are computed iff the corresponding port is connected. For backward compatibility, operators can check if we should auto-connect a port by overriding this method (e.g. by checking a deprecated parameter). TODO: Remove in later versions

Overrides:

shouldAutoConnect in class Operator

preAutoWire

public java.util.LinkedList<OutputPort> preAutoWire(java.util.LinkedList<OutputPort> ports)
                                             throws UndefinedParameterError

Description copied from class: Operator

This method is called before auto-wiring an operator. Operators can reorder outputs in order to influence how subsequent operators are wired. This is only necessary for legacy operators like IOConsumer or IOSelector. Don't override this method for new operators.

Overrides:

preAutoWire in class Operator

Throws:

UndefinedParameterError

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. ATTENTION! This will create new parameterTypes. For calling already existing parameter types use getParameters().getParameterTypes();

Specified by:

getParameterTypes in interface ParameterHandler

Overrides:

getParameterTypes in class Operator