weka.gui.beans

Class RScriptExecutor

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

weka.gui.beans.RScriptExecutor

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, EnvironmentHandler, JavaGDListener, BeanCommon, DataSourceListener, EventConstraints, Startable, TestSetListener, TrainingSetListener, Visible

public class RScriptExecutor
extends javax.swing.JPanel
implements BeanCommon, Visible, EventConstraints, java.io.Serializable, TrainingSetListener, TestSetListener, DataSourceListener, EnvironmentHandler, Startable, JavaGDListener

A Knowledge Flow component that executes a user-supplied R script. The script may be supplied via the GUI editor for the component or loaded from a file at run time. Incoming instances will be transfered to a data frame in the R environment and can be accessed from the user script by referencing the variable "rdata". Console output in R can be forwarded to a TextViewer by using "print" statements in R. E.g.

 data(iris)
 print(iris)
 

Data frames in R can be extracted, converted to Weka Instances and passed on via dataSet connections by simply stating the name of the data frame in the user's R script. This must be the last command in the script. E.g:

 data(iris)
 iris
 

Graphics in R can be captured by making use of the JavaGD graphics device for R (http://stats.math.uni-augsburg.de/R/JavaGD/). The Weka RPlugin will attempt to install this package for the user automatically - if this fails for some reason then the package should be installed by the user from R via install.packages("JavaGD"). The default size for graphics created in R via JavaGD is 800x600. The user can alter this in their R scripts by executing the following command:

 JavaGD(width = w, height = h)
 

where "w" and "h" are the new width and height in pixels. Note that this setting stays in effect until another "JavaGD()" command is executed.

The RScriptExecutor can be connected to an ImageSaver component in order to save any graphics generated to a file. If running within the graphical Knowledge Flow UI any generated images will also be sent to the R Console/Visualize perspective.

Version:

$Revision: 11975 $

Author:

Mark Hall (mhall{[at]}pentaho{[dot]}com)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.BaselineResizeBehavior

Field Summary

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
RScriptExecutor() Constructor

Method Summary

Modifier and Type	Method and Description
void	acceptDataSet(DataSetEvent e) Accept a data set and convert it into a data frame in R
void	acceptTestSet(TestSetEvent e) Accept a test set and convert it into a data frame in R
void	acceptTrainingSet(TrainingSetEvent e) Accept a training set and convert it into a data frame in R
void	addDataSourceListener(DataSourceListener dl) Add a data source listener
void	addImageListener(ImageListener i) Add an image listener
void	addTextListener(TextListener cl) Add a text listener
boolean	connectionAllowed(java.beans.EventSetDescriptor esd) Returns true if, at this time, the object will accept a connection via the named event
boolean	connectionAllowed(java.lang.String eventName) Returns true if a connection can be made to this step using the named connection type
void	connectionNotification(java.lang.String eventName, java.lang.Object source) Notification of a particular connection made to us
void	disconnectionNotification(java.lang.String eventName, java.lang.Object source) Notification of disconnection from us
boolean	eventGeneratable(java.lang.String eventName) Returns true if, at this time, the named event can be generated
java.lang.String	getCustomName() Get the custom (descriptive) name for this bean (if one has been set)
java.lang.String	getRScript() Get the script to execute
java.lang.String	getScriptFile() Get the filename of the script to load at runtime
java.lang.String	getStartMessage() Get the start message string (no longer used in Weka 3.7).
BeanVisual	getVisual() Get the visual representation of this step
java.lang.String	globalInfo() Get about information to display in the GUI
void	imageGenerated(java.awt.image.BufferedImage image) Called when a graphics image has been generated
boolean	isBusy() Returns true if.
void	removeDataSourceListener(DataSourceListener dl) Remove a data source listener
void	removeImageListener(ImageListener i) Remove an data image listener
void	removeTextListener(TextListener cl) Remove a text listener
void	setCustomName(java.lang.String name) Set a custom (descriptive) name for this bean
void	setEnvironment(Environment env) Set environment variables to use
void	setLog(Logger logger) Set a logger
void	setRScript(java.lang.String script) Set the script to execute
void	setScriptFile(java.lang.String scriptFile) Set the filename containing the script to be loaded at runtime
void	setVisual(BeanVisual newVisual) Set the visual for this step
void	start() Start this step executing.
void	stop() Stop any processing that the bean might be doing.
void	useDefaultVisual() Use the default icon for this step

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RScriptExecutor

public RScriptExecutor()

Constructor

Method Detail

globalInfo

public java.lang.String globalInfo()

Get about information to display in the GUI

Returns:

Textual about information

setRScript

public void setRScript(java.lang.String script)

Set the script to execute

Parameters:

script - the R script to execute

getRScript

public java.lang.String getRScript()

Get the script to execute

Returns:

the R script to execute

setScriptFile

public void setScriptFile(java.lang.String scriptFile)

Set the filename containing the script to be loaded at runtime

Parameters:

scriptFile - the name of the script file to load at runtime

getScriptFile

public java.lang.String getScriptFile()

Get the filename of the script to load at runtime

Returns:

the filename of the script to load at runtime

setEnvironment

public void setEnvironment(Environment env)

Set environment variables to use

Specified by:

setEnvironment in interface EnvironmentHandler

Parameters:

env - the environment variables to use

acceptTestSet

public void acceptTestSet(TestSetEvent e)

Accept a test set and convert it into a data frame in R

Specified by:

acceptTestSet in interface TestSetListener

Parameters:

e - the test set event

acceptTrainingSet

public void acceptTrainingSet(TrainingSetEvent e)

Accept a training set and convert it into a data frame in R

Specified by:

acceptTrainingSet in interface TrainingSetListener

Parameters:

e - the training set event

acceptDataSet

public void acceptDataSet(DataSetEvent e)

Accept a data set and convert it into a data frame in R

Specified by:

acceptDataSet in interface DataSourceListener

Parameters:

e - the data set event

eventGeneratable

public boolean eventGeneratable(java.lang.String eventName)

Returns true if, at this time, the named event can be generated

Specified by:

eventGeneratable in interface EventConstraints

Parameters:

eventName - the event to check

setCustomName

public void setCustomName(java.lang.String name)

Set a custom (descriptive) name for this bean

Specified by:

setCustomName in interface BeanCommon

Parameters:

name - the name to use

getCustomName

public java.lang.String getCustomName()

Get the custom (descriptive) name for this bean (if one has been set)

Specified by:

getCustomName in interface BeanCommon

Returns:

the custom name (or the default name)

stop

public void stop()

Stop any processing that the bean might be doing.

Specified by:

stop in interface BeanCommon

isBusy

public boolean isBusy()

Returns true if. at this time, the bean is busy with some (i.e. perhaps a worker thread is performing some calculation).

Specified by:

isBusy in interface BeanCommon

Returns:

true if the bean is busy.

setLog

public void setLog(Logger logger)

Set a logger

Specified by:

setLog in interface BeanCommon

Parameters:

logger - a weka.gui.Logger value

connectionAllowed

public boolean connectionAllowed(java.beans.EventSetDescriptor esd)

Returns true if, at this time, the object will accept a connection via the named event

Specified by:

connectionAllowed in interface BeanCommon

Parameters:

esd - the EventSetDescriptor for the event in question

Returns:

true if the object will accept a connection

connectionAllowed

public boolean connectionAllowed(java.lang.String eventName)

Returns true if a connection can be made to this step using the named connection type

Specified by:

connectionAllowed in interface BeanCommon

Parameters:

eventName - the connection type

connectionNotification

public void connectionNotification(java.lang.String eventName,
                                   java.lang.Object source)

Notification of a particular connection made to us

Specified by:

connectionNotification in interface BeanCommon

Parameters:

eventName - the connection type

source - the source step connecting to us

disconnectionNotification

public void disconnectionNotification(java.lang.String eventName,
                                      java.lang.Object source)

Notification of disconnection from us

Specified by:

disconnectionNotification in interface BeanCommon

Parameters:

eventName - the connection type being removed

source - the step disconnecting from us

useDefaultVisual

public void useDefaultVisual()

Use the default icon for this step

Specified by:

useDefaultVisual in interface Visible

setVisual

public void setVisual(BeanVisual newVisual)

Set the visual for this step

Specified by:

setVisual in interface Visible

Parameters:

newVisual - the visual representation to use

getVisual

public BeanVisual getVisual()

Get the visual representation of this step

Specified by:

getVisual in interface Visible

Returns:

the visual representation of this step

addTextListener

public void addTextListener(TextListener cl)

Add a text listener

Parameters:

cl - a TextListener value

removeTextListener

public void removeTextListener(TextListener cl)

Remove a text listener

Parameters:

cl - a TextListener value

addDataSourceListener

public void addDataSourceListener(DataSourceListener dl)

Add a data source listener

Parameters:

dl - a DataSourceListener value

removeDataSourceListener

public void removeDataSourceListener(DataSourceListener dl)

Remove a data source listener

Parameters:

dl - a DataSourceListener value

addImageListener

public void addImageListener(ImageListener i)

Add an image listener

Parameters:

i - a ImageListener value

removeImageListener

public void removeImageListener(ImageListener i)

Remove an data image listener

Parameters:

i - a ImageListener value

start

public void start()

Start this step executing.

Specified by:

start in interface Startable

getStartMessage

public java.lang.String getStartMessage()

Get the start message string (no longer used in Weka 3.7). Also indicates when this step can't be the start point in flow.

Specified by:

getStartMessage in interface Startable

Returns:

the start message string

imageGenerated

public void imageGenerated(java.awt.image.BufferedImage image)

Description copied from interface: JavaGDListener

Called when a graphics image has been generated

Specified by:

imageGenerated in interface JavaGDListener

Parameters:

image - the image generated