weka.knowledgeflow.steps

Class Job

java.lang.Object

weka.knowledgeflow.steps.BaseStep

weka.knowledgeflow.steps.Job

All Implemented Interfaces:

java.io.Serializable, BaseStepExtender, Step

@KFStep(name="Job",
        category="Flow",
        toolTipText="Execute a flow as a \'job\' and wait for it to finish",
        iconPath="weka/gui/knowledgeflow/icons/Job.gif")
public class Job
extends BaseStep

Step that executes another flow as a "job". Typically, you would parameterize the flow to be executed with variables (in steps that support variables) and then use a a data source connected to a SetVariables step to change the values of the variables dynamically at runtime. For example, a DataGrid could be used to define a set of instances with a string variable containing paths to ARFF files to process; SetVariables can be used to transfer these file paths from the incoming instances generated by DataGrid to the values of variables; then the Job step can execute it's sub-flow for each configuration of variables received, thus processing a different ARFF file (if the subflow uses an ArffLoader step).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected FlowExecutor	m_flowExecutor
protected java.io.File	m_flowToRun
protected LoggingLevel	m_logLevel

Fields inherited from class weka.knowledgeflow.steps.BaseStep

m_stepIsResourceIntensive, m_stepManager, m_stepName

Constructor Summary

Constructors

Constructor and Description
Job()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCustomEditorForStep() Get the custom editor for this step
java.io.File	getFlowFile()
java.util.List<java.lang.String>	getIncomingConnectionTypes() Get a list of incoming connection types that this step can accept.
java.util.List<java.lang.String>	getOutgoingConnectionTypes() Get a list of outgoing connection types that this step can produce.
void	processIncoming(Data data) Process an incoming data payload (if the step accepts incoming connections)
protected void	runFlow(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) Run the sub-flow using the supplied environment variables (if any)
void	setFlowFile(java.io.File flowFile)
void	start() Start processing.
void	stepInit() Initialize the step.

Methods inherited from class weka.knowledgeflow.steps.BaseStep

environmentSubstitute, getDefaultSettings, getInteractiveViewers, getInteractiveViewersImpls, getName, getStepManager, globalInfo, isResourceIntensive, isStopRequested, outputStructureForConnectionType, 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_flowToRun

protected java.io.File m_flowToRun

m_flowExecutor

protected transient FlowExecutor m_flowExecutor

m_logLevel

protected LoggingLevel m_logLevel

Constructor Detail

Job

public Job()

Method Detail

setFlowFile

@FilePropertyMetadata(fileChooserDialogType=0,
                      directoriesOnly=false)
 @OptionMetadata(displayName="Flow file",
                description="The flow to execute",
                displayOrder=0)
public void setFlowFile(java.io.File flowFile)

getFlowFile

public java.io.File getFlowFile()

stepInit

public void stepInit()
              throws WekaException

Description copied from interface: Step

Initialize the step.

Throws:

WekaException - if a problem occurs during initialization

start

public void start()
           throws WekaException

Description copied from class: BaseStep

Start processing. Subclasses should override this method if they can act 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

processIncoming

public void processIncoming(Data data)
                     throws WekaException

Description copied from class: BaseStep

Process an incoming data payload (if the step accepts incoming connections)

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

runFlow

protected void runFlow(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 WekaException

Run the sub-flow using the supplied environment variables (if any)

Parameters:

varsToSet - variables to set before executing the sub-flow. Can be null.

propsToSet - property values for target steps (only scheme-based steps can be targets)

results - results (if any) to pass in to the sub-flow

Throws:

WekaException - if a problem occurs

getIncomingConnectionTypes

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

Description copied from interface: Step

Get a list of incoming connection types that this step can accept. Ideally (and if appropriate), this should take into account the state of the step and any existing incoming connections. E.g. a step might be able to accept one (and only one) incoming batch data connection.

Returns:

a list of incoming connections that this step can accept given its current state

getOutgoingConnectionTypes

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

Description copied from interface: Step

Get a list of outgoing connection types that this step can produce. Ideally (and if appropriate), this should take into account the state of the step and the incoming connections. E.g. depending on what incoming connection is present, a step might be able to produce a trainingSet output, a testSet output or neither, but not both.

Returns:

a list of outgoing connections that this step can produce

getCustomEditorForStep

public java.lang.String getCustomEditorForStep()

Get the custom editor for this step

Specified by:

getCustomEditorForStep in interface Step

Overrides:

getCustomEditorForStep in class BaseStep

Returns:

the fully qualified class name of the clustom editor for this step