com.rapidminer.operator.meta
Class ProcessEmbeddingOperator

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

All Implemented Interfaces:

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

public class ProcessEmbeddingOperator
extends Operator

This operator can be used to embed a complete process definition into the current process definition. The process must have been written into a file before and will be loaded and executed when the current process reaches this operator. Optionally, the input of this operator can be used as input for the embedded process. In both cases, the output of the process will be delivered as output of this operator. Please note that validation checks will not work for process containing an operator of this type since the check cannot be performed without actually loading the process.

Author:

Ingo Mierswa

Field Summary

static java.lang.String	PARAMETER_MACRO_NAME
static java.lang.String	PARAMETER_MACRO_VALUE
static java.lang.String	PARAMETER_MACROS
static java.lang.String	PARAMETER_PROCESS_FILE The parameter name for "The process file which should be encapsulated by this operator"
static java.lang.String	PARAMETER_PROPAGATE_METADATA_RECURSIVELY Determines whether meta data is propagated through the included process.
static java.lang.String	PARAMETER_USE_INPUT The parameter name for "Indicates if the operator input should be used as input of the process"

Constructor Summary

ProcessEmbeddingOperator(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.
protected void	performAdditionalChecks() This method is invoked during the validation checks.

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, preAutoWire, processFinished, processStarts, producesOutput, propagateDirtyness, register, registerOperator, remove, removeAndKeepConnections, rename, resume, setBreakpoint, setCompatibilityLevel, setEnabled, setEnclosingProcess, setExpanded, setInput, setListParameter, setPairParameter, setParameter, setParameters, setUserDescription, shouldAutoConnect, 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_PROCESS_FILE

public static final java.lang.String PARAMETER_PROCESS_FILE

The parameter name for "The process file which should be encapsulated by this operator"

See Also:

Constant Field Values

PARAMETER_USE_INPUT

public static final java.lang.String PARAMETER_USE_INPUT

The parameter name for "Indicates if the operator input should be used as input of the process"

See Also:

Constant Field Values

PARAMETER_PROPAGATE_METADATA_RECURSIVELY

public static final java.lang.String PARAMETER_PROPAGATE_METADATA_RECURSIVELY

Determines whether meta data is propagated through the included process.

See Also:

Constant Field Values

PARAMETER_MACROS

public static final java.lang.String PARAMETER_MACROS

See Also:

Constant Field Values

PARAMETER_MACRO_NAME

public static final java.lang.String PARAMETER_MACRO_NAME

See Also:

Constant Field Values

PARAMETER_MACRO_VALUE

public static final java.lang.String PARAMETER_MACRO_VALUE

See Also:

Constant Field Values

Constructor Detail

ProcessEmbeddingOperator

public ProcessEmbeddingOperator(OperatorDescription description)

Method Detail

performAdditionalChecks

protected void performAdditionalChecks()

Description copied from class: Operator

This method is invoked during the validation checks. It is invoked as a last check. The default implementation does nothing. Subclasses might want to override this method to perform some specialized checks, e.g. if an inner operator is of a specific class.

Overrides:

performAdditionalChecks in class Operator

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

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