weka.knowledgeflow.steps

Class ExecuteProcess

java.lang.Object

weka.knowledgeflow.steps.BaseStep

weka.knowledgeflow.steps.ExecuteProcess

All Implemented Interfaces:

java.io.Serializable, BaseStepExtender, Step

@KFStep(name="ExecuteProcess",
        category="Tools",
        toolTipText="Execute either static or dynamic processes. Dynamic processes can have commands, arguments and working directories specified in the values of incoming string/nominal attributes in data-based or environment connections.",
        iconPath="weka/gui/knowledgeflow/icons/ExecuteProcess.gif")
public class ExecuteProcess
extends BaseStep

Knowledge Flow step that can execute static system commands or commands that are dynamically defined by the values of attributes in incoming instance or environment connections.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	m_argsFieldIndex Resolved attribute index of dynamic arguments
protected int	m_cmdFieldIndex Resolved attribute index of dynamic command
protected java.lang.String	m_fieldArgs Name of attribute that will hold optional arguments for dynamic command
protected java.lang.String	m_fieldCmd Name of attribute that will hold dynamic command to be executed
protected java.lang.String	m_fieldWorkingDir Name of attribute that will hold optional working directory for dynamic command
protected Instances	m_instanceOutHeader Structure of output for outgoing instance connections
protected boolean	m_raiseAnExceptionOnCommandFailure Whether to raise an exception when a command fails completely (i.e. doesn't exist or something) vs the case of a non-zero exit status.
protected java.lang.Process	m_runningProcess The process that is used to execute the user's command(s)
protected java.lang.String	m_staticArgs Arguments (if necessary) for single static command
protected java.lang.String	m_staticExecCmd Single static command (may use env vars)
protected java.lang.String	m_staticWorkingDir Optional working directory for single static command
protected java.lang.StringBuffer	m_stdErrBuffer Std err from process
protected java.lang.StringBuffer	m_stdOutbuffer Std out from process
protected boolean	m_structureCheckComplete True if the structure has been checked
protected boolean	m_useDynamic True to execute commands specified in incoming instance fields
protected int	m_workingDirFieldIndex Resolved attribute index of dynamic working directory

Fields inherited from class weka.knowledgeflow.steps.BaseStep

m_stepIsResourceIntensive, m_stepManager, m_stepName

Constructor Summary

Constructors

Constructor and Description
ExecuteProcess()

Method Summary

Modifier and Type	Method and Description
protected void	addAuxToData(Data data, java.util.Map<java.lang.String,java.lang.String> varsToSet, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> propsToSet, java.util.Map<java.lang.String,java.util.LinkedHashSet<Data>> results) Adds auxilliary information to a Data object
protected void	checkStructure(Instances structure) Check the incoming instance structure with respect to the attribute names specified by the user for the command, args and working directory.
protected static void	copy(java.io.InputStream input, java.io.Writer out) Copy an input stream to a writer
java.lang.String	getCustomEditorForStep() Get the name of the editor dialog for this step
java.lang.String	getDynamicArgsField() Get the name of the attribute in the incoming instance structure that contains the arguments to the command to execute
java.lang.String	getDynamicCmdField() Get the name of the attribute in the incoming instance structure that contains the command to execute
java.lang.String	getDynamicWorkingDirField() Get the name of the attribute in the incoming instance structure that containst the working directory for the command to execute
java.util.List<java.lang.String>	getIncomingConnectionTypes() Get the acceptable incoming connection types at this point in time
java.util.List<java.lang.String>	getOutgoingConnectionTypes() Get a list of possible outgoing connection types at this point in time
boolean	getRaiseExceptionOnCommandFailure() Get to raise an exception when a command fails completely (i.e. doesn't exist or something) vs the case of a non-zero exit status.
java.lang.String	getStaticArgs() Get the arguments for the static command
java.lang.String	getStaticCmd() Get the static command to be executed
java.lang.String	getStaticWorkingDir() Get the working directory for the static command
boolean	getUseDynamic() Get whether to execute dynamic commands
protected void	handleOutputFailure(int returnCode, java.util.Map<java.lang.String,java.lang.String> varsToSet, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> propsToSet, java.util.Map<java.lang.String,java.util.LinkedHashSet<Data>> results, java.lang.String command) Output data relating to an unsuccessful execution of a command
protected void	handleOutputSuccess(java.util.Map<java.lang.String,java.lang.String> varsToSet, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> propsToSet, java.util.Map<java.lang.String,java.util.LinkedHashSet<Data>> results, java.lang.String command) Output data relating to successful execution of a command
protected java.lang.ProcessBuilder	makeDynamicProcess(Instance incoming) Construct a ProcessBuilder instance for executing a dynamic command
protected java.lang.ProcessBuilder	makeStaticProcess() Construct a ProcessBuilder instance for executing a static command
Instances	outputStructureForConnectionType(java.lang.String connectionName) Get, if possible, the outgoing instance structure for the supplied incoming connection type
void	processIncoming(Data data) Process an incoming Data object
protected void	runProcess(java.lang.ProcessBuilder builder, java.util.Map<java.lang.String,java.lang.String> varsToSet, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> propsToSet, java.util.Map<java.lang.String,java.util.LinkedHashSet<Data>> results) Execute a configured process
void	setDynamicArgsField(java.lang.String argsField) Set the name of the attribute in the incoming instance structure that contains the arguments to the command to execute
void	setDynamicCmdField(java.lang.String cmdField) Set the name of the attribute in the incoming instance structure that contains the command to execute
void	setDynamicWorkingDirField(java.lang.String workingDirField) Set the name of the attribute in the incoming instance structure that containst the working directory for the command to execute
void	setRaiseExceptionOnCommandFailure(boolean raiseExceptionOnCommandFailure) Set to raise an exception when a command fails completely (i.e. doesn't exist or something) vs the case of a non-zero exit status.
void	setStaticArgs(java.lang.String args) Set the arguments for the static command
void	setStaticCmd(java.lang.String cmd) Set the static command to be executed
void	setStaticWorkingDir(java.lang.String workingDir) Set the working directory for the static command
void	setUseDynamic(boolean useDynamic) Set whether to execute dynamic commands
void	start() Start processing if operating as a start point in a flow
void	stepInit() Initialize the step

Methods inherited from class weka.knowledgeflow.steps.BaseStep

environmentSubstitute, getDefaultSettings, getInteractiveViewers, getInteractiveViewersImpls, getName, getStepManager, globalInfo, isResourceIntensive, isStopRequested, setName, setStepIsResourceIntensive, setStepManager, setStepMustRunSingleThreaded, stepMustRunSingleThreaded, stop

Methods inherited from class java.lang.Object

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

Field Detail

m_runningProcess

protected java.lang.Process m_runningProcess

The process that is used to execute the user's command(s)

m_staticExecCmd

protected java.lang.String m_staticExecCmd

Single static command (may use env vars)

m_staticArgs

protected java.lang.String m_staticArgs

Arguments (if necessary) for single static command

m_staticWorkingDir

protected java.lang.String m_staticWorkingDir

Optional working directory for single static command

m_useDynamic

protected boolean m_useDynamic

True to execute commands specified in incoming instance fields

m_raiseAnExceptionOnCommandFailure

protected boolean m_raiseAnExceptionOnCommandFailure

Whether to raise an exception when a command fails completely (i.e. doesn't exist or something) vs the case of a non-zero exit status. If not raising an exception, then output indicating failure (with exist status = 1 in the case of instance connections) will be generated

m_fieldCmd

protected java.lang.String m_fieldCmd

Name of attribute that will hold dynamic command to be executed

m_fieldArgs

protected java.lang.String m_fieldArgs

Name of attribute that will hold optional arguments for dynamic command

m_fieldWorkingDir

protected java.lang.String m_fieldWorkingDir

Name of attribute that will hold optional working directory for dynamic command

m_cmdFieldIndex

protected int m_cmdFieldIndex

Resolved attribute index of dynamic command

m_argsFieldIndex

protected int m_argsFieldIndex

Resolved attribute index of dynamic arguments

m_workingDirFieldIndex

protected int m_workingDirFieldIndex

Resolved attribute index of dynamic working directory

m_stdOutbuffer

protected java.lang.StringBuffer m_stdOutbuffer

Std out from process

m_stdErrBuffer

protected java.lang.StringBuffer m_stdErrBuffer

Std err from process

m_instanceOutHeader

protected Instances m_instanceOutHeader

Structure of output for outgoing instance connections

m_structureCheckComplete

protected boolean m_structureCheckComplete

True if the structure has been checked

Constructor Detail

ExecuteProcess

public ExecuteProcess()

Method Detail

getRaiseExceptionOnCommandFailure

public boolean getRaiseExceptionOnCommandFailure()

Get to raise an exception when a command fails completely (i.e. doesn't exist or something) vs the case of a non-zero exit status. If not raising an exception, then output indicating failure (with exist status = 1 in the case of instance connections) will be generated.

Returns:

true if an exception is to be generated on catastrophic command failure

setRaiseExceptionOnCommandFailure

public void setRaiseExceptionOnCommandFailure(boolean raiseExceptionOnCommandFailure)

Set to raise an exception when a command fails completely (i.e. doesn't exist or something) vs the case of a non-zero exit status. If not raising an exception, then output indicating failure (with exist status = 1 in the case of instance connections) will be generated.

Parameters:

raiseExceptionOnCommandFailure - if an exception is to be generated on catastrophic command failure

getUseDynamic

public boolean getUseDynamic()

Get whether to execute dynamic commands

Returns:

true if dynamic commands are to be executed

setUseDynamic

public void setUseDynamic(boolean useDynamic)

Set whether to execute dynamic commands

Parameters:

useDynamic - true if dynamic commands are to be executed

getStaticCmd

public java.lang.String getStaticCmd()

Get the static command to be executed

Returns:

the static command to be executed

setStaticCmd

public void setStaticCmd(java.lang.String cmd)

Set the static command to be executed

Parameters:

cmd - the static command to be executed

getStaticArgs

public java.lang.String getStaticArgs()

Get the arguments for the static command

Returns:

the arguments for the static command

setStaticArgs

public void setStaticArgs(java.lang.String args)

Set the arguments for the static command

Parameters:

args - the arguments for the static command

getStaticWorkingDir

public java.lang.String getStaticWorkingDir()

Get the working directory for the static command

Returns:

the working directory for the static command

setStaticWorkingDir

public void setStaticWorkingDir(java.lang.String workingDir)

Set the working directory for the static command

Parameters:

workingDir - the working directory for the static command

getDynamicCmdField

public java.lang.String getDynamicCmdField()

Get the name of the attribute in the incoming instance structure that contains the command to execute

Returns:

the name of the attribute containing the command to execute

setDynamicCmdField

public void setDynamicCmdField(java.lang.String cmdField)

Set the name of the attribute in the incoming instance structure that contains the command to execute

Parameters:

cmdField - the name of the attribute containing the command to execute

getDynamicArgsField

public java.lang.String getDynamicArgsField()

Get the name of the attribute in the incoming instance structure that contains the arguments to the command to execute

Returns:

the name of the attribute containing the command's arguments

setDynamicArgsField

public void setDynamicArgsField(java.lang.String argsField)

Set the name of the attribute in the incoming instance structure that contains the arguments to the command to execute

Parameters:

argsField - the name of the attribute containing the command's arguments

getDynamicWorkingDirField

public java.lang.String getDynamicWorkingDirField()

Get the name of the attribute in the incoming instance structure that containst the working directory for the command to execute

Returns:

the name of the attribute containing the command's working directory

setDynamicWorkingDirField

public void setDynamicWorkingDirField(java.lang.String workingDirField)

Set the name of the attribute in the incoming instance structure that containst the working directory for the command to execute

Parameters:

workingDirField - the name of the attribute containing the command's working directory

stepInit

public void stepInit()
              throws WekaException

Initialize the step

Throws:

WekaException - if a problem occurs

start

public void start()
           throws WekaException

Start processing if operating as a start point in a flow

Specified by:

start in interface BaseStepExtender

Specified by:

start in interface Step

Overrides:

start in class BaseStep

Throws:

WekaException - if a problem occurs

makeStaticProcess

protected java.lang.ProcessBuilder makeStaticProcess()
                                              throws java.lang.Exception

Construct a ProcessBuilder instance for executing a static command

Returns:

a ProcessBuilder instance

Throws:

java.lang.Exception - if a problem occurs

makeDynamicProcess

protected java.lang.ProcessBuilder makeDynamicProcess(Instance incoming)
                                               throws java.lang.Exception

Construct a ProcessBuilder instance for executing a dynamic command

Parameters:

incoming - the incoming instance containing the command details

Returns:

a ProcessBuilder instance

Throws:

java.lang.Exception - if a problem occurs

runProcess

protected void runProcess(java.lang.ProcessBuilder builder,
                          java.util.Map<java.lang.String,java.lang.String> varsToSet,
                          java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> propsToSet,
                          java.util.Map<java.lang.String,java.util.LinkedHashSet<Data>> results)
                   throws java.io.IOException,
                          java.lang.InterruptedException,
                          WekaException

Execute a configured process

Parameters:

builder - the ProcessBuilder to execute

varsToSet - environment variables to pass on to the ProcessBuilder

propsToSet - properties to pass on downstream

results - results to pass on downstream

Throws:

java.io.IOException - if a problem occurs

java.lang.InterruptedException - if a problem occurs

WekaException - if a problem occurs

handleOutputSuccess

protected void handleOutputSuccess(java.util.Map<java.lang.String,java.lang.String> varsToSet,
                                   java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> propsToSet,
                                   java.util.Map<java.lang.String,java.util.LinkedHashSet<Data>> results,
                                   java.lang.String command)
                            throws WekaException

Output data relating to successful execution of a command

Parameters:

varsToSet - environment variables to pass on downstream

propsToSet - properties to pass on downstream

results - results to pass on downstream

command - the actual command that was executed

Throws:

WekaException - if a problem occurs

handleOutputFailure

protected void handleOutputFailure(int returnCode,
                                   java.util.Map<java.lang.String,java.lang.String> varsToSet,
                                   java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> propsToSet,
                                   java.util.Map<java.lang.String,java.util.LinkedHashSet<Data>> results,
                                   java.lang.String command)
                            throws WekaException

Output data relating to an unsuccessful execution of a command

Parameters:

returnCode - the return code generated by the process

varsToSet - environment variables to pass on downstream

propsToSet - properties to pass on downstream

results - results to pass on downstream

command - the command that was executed

Throws:

WekaException - if a problem occurs

addAuxToData

protected void addAuxToData(Data data,
                            java.util.Map<java.lang.String,java.lang.String> varsToSet,
                            java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> propsToSet,
                            java.util.Map<java.lang.String,java.util.LinkedHashSet<Data>> results)

Adds auxilliary information to a Data object

Parameters:

data - the Data object to add to

varsToSet - environment variables to add

propsToSet - properties to add

results - results to add

processIncoming

public void processIncoming(Data data)
                     throws WekaException

Process an incoming Data object

Specified by:

processIncoming in interface BaseStepExtender

Specified by:

processIncoming in interface Step

Overrides:

processIncoming in class BaseStep

Parameters:

data - the payload to process

Throws:

WekaException - if a problem occurs

checkStructure

protected void checkStructure(Instances structure)
                       throws WekaException

Check the incoming instance structure with respect to the attribute names specified by the user for the command, args and working directory.

Parameters:

structure - the incoming instance structure

Throws:

WekaException - if a problem occurs

getIncomingConnectionTypes

public java.util.List<java.lang.String> getIncomingConnectionTypes()

Get the acceptable incoming connection types at this point in time

Returns:

a list of acceptable incoming connection types

getOutgoingConnectionTypes

public java.util.List<java.lang.String> getOutgoingConnectionTypes()

Get a list of possible outgoing connection types at this point in time

Returns:

a list of possible outgoing connection types

outputStructureForConnectionType

public Instances outputStructureForConnectionType(java.lang.String connectionName)
                                           throws WekaException

Get, if possible, the outgoing instance structure for the supplied incoming connection type

Specified by:

outputStructureForConnectionType in interface Step

Overrides:

outputStructureForConnectionType in class BaseStep

Parameters:

connectionName - the name of the connection type to get the output structure for

Returns:

an Instances object or null if outgoing structure is not applicable or cannot be determined

Throws:

WekaException - if a problem occurs

getCustomEditorForStep

public java.lang.String getCustomEditorForStep()

Get the name of the editor dialog for this step

Specified by:

getCustomEditorForStep in interface Step

Overrides:

getCustomEditorForStep in class BaseStep

Returns:

the name of the editor dialog for this step

copy

protected static void copy(java.io.InputStream input,
                           java.io.Writer out)
                    throws java.io.IOException

Copy an input stream to a writer

Parameters:

input - the input stream to copy from

out - the writer to write to

Throws:

java.io.IOException - if a problem occurs