com.rapidminer.operator
Class ScriptingOperator

java.lang.Object
  com.rapidminer.operator.Operator
      com.rapidminer.operator.ScriptingOperator

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

public class ScriptingOperator
extends Operator

This operator can be used to execute arbitrary Groovy scripts. This basically means that analysts can write their own operators directly within the process by specifiying Java code and / or a Groovy script which will be interpreted and executed during process runtime. For a complete reference of Groovy scripting please refer to http://groovy.codehaus.org/.

In addition to the usual scripting code elements from Groovy, the RapidMiner scripting operator defines some special scripting elements:

• If you use the standard imports, all important types like Example, ExampleSet, Attribute, Operator etc. as well as the most important Java types like collections etc. are automatically imported and can directly be used within the script. Hence, there is no need for importing them in your script. However, you can of course import any other class you want and use this in your script.
• The current operator (the scripting operator for which you define the script) is referenced by operator.
  Example: operator.log("text")
• All operator methods like log (see above), accessing the input or the complete process can directly be used by writing a preceding operator.
  Example: operator.getProcess()
• Input of the operator can be retrieved via the input method getInput(Class) of the surrounding operator.
  Example: ExampleSet exampleSet = operator.getInput(ExampleSet.class)
• You can iterate over examples with the following construct:
  for (Example example : exampleSet) { ... }
• You can retrieve example values with the shortcut
  String value = example["attribute_name"]; or
  double value = example["attribute_name"];
• You can set example values with example["attribute_name"] = "value"; or
  example["attribute_name"] = 5.7;

Note: Scripts written for this operator may access Java code. Scripts may hence become incompatible in future releases of RapidMiner.

Author:

Simon Fischer, Ingo Mierswa

Field Summary

static java.lang.String	PARAMETER_SCRIPT
static java.lang.String	PARAMETER_STANDARD_IMPORTS

Constructor Summary

ScriptingOperator(OperatorDescription description)

Method Summary

IOObject[]	apply() Implement this method in subclasses.
java.lang.Class<?>[]	getInputClasses() Returns the classes that are needed as input.
java.lang.Class<?>[]	getOutputClasses() Returns the classes that are guaranteed to be returned by apply() as additional output.
java.util.List<ParameterType>	getParameterTypes() Returns a list of ParameterTypes describing the parameters of this operator.

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_SCRIPT

public static final java.lang.String PARAMETER_SCRIPT

See Also:

Constant Field Values

PARAMETER_STANDARD_IMPORTS

public static final java.lang.String PARAMETER_STANDARD_IMPORTS

See Also:

Constant Field Values

Constructor Detail

ScriptingOperator

public ScriptingOperator(OperatorDescription description)

Method Detail

apply

public IOObject[] apply()
                 throws OperatorException

Description copied from class: Operator

Implement this method in subclasses.

Specified by:

apply in class Operator

Throws:

OperatorException

getInputClasses

public java.lang.Class<?>[] getInputClasses()

Description copied from class: Operator

Returns the classes that are needed as input. May be null or an empty (no desired input). As default, all delivered input objects are consumed and must be also delivered as output in both Operator.getOutputClasses() and Operator.apply() if this is necessary. This default behavior can be changed by overriding Operator.getInputDescription(Class). Subclasses which implement this method should not make use of parameters since this method is invoked by getParameterTypes(). Therefore, parameters are not fully available at this point of time and this might lead to exceptions. Please use InputDescriptions instead.

Specified by:

getInputClasses in class Operator

getOutputClasses

public java.lang.Class<?>[] getOutputClasses()

Description copied from class: Operator

Returns the classes that are guaranteed to be returned by apply() as additional output. Please note that input objects which should not be consumed must also be defined by this method (e.g. an example set which is changed but not consumed in the case of a preprocessing operator must be defined in both, the methods Operator.getInputClasses() and Operator.getOutputClasses()). The default behavior for input consumation is defined by Operator.getInputDescription(Class) and can be changed by overwriting this method. Objects which are not consumed (defined by changing the implementation in Operator.getInputDescription(Class)) must not be defined as additional output in this method.

May deliver null or an empy array (no additional output is produced or guaranteed). Must return the class array of delivered output objects otherwise.

Specified by:

getOutputClasses in class Operator

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