org.knime.core.node.workflow
Class BatchExecutor

java.lang.Object
  org.knime.core.node.workflow.BatchExecutor

public final class BatchExecutor
extends Object

Simple utility class that takes a workflow, either in a directory or zipped into a single file, executes it and saves the results in the end. If the input was a ZIP file the workflow is zipped back into a file.

Author:

Thorsten Meinl, University of Konstanz

Method Summary

static String	getOptionsString()
static String	getPropertiesString()
static void	main(String[] args) Main method.
static int	mainRun(String[] args) Called from main(String[]) method.

Methods inherited from class java.lang.Object

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

Method Detail

getOptionsString

public static String getOptionsString()

Returns:

a string explaining the options available for the batch executor

getPropertiesString

public static String getPropertiesString()

Returns:

a string explaining the usage of Java properties for certain KNIME parameters

main

public static void main(String[] args)
                 throws IOException,
                        InvalidSettingsException,
                        CanceledExecutionException

Main method.

Parameters:

args - a workflow directory or a zip input and output file

Throws:

IOException - Delegated from WFM

CanceledExecutionException - Delegated from WFM

InvalidSettingsException - Delegated from WFM

mainRun

public static int mainRun(String[] args)
                   throws IOException,
                          InvalidSettingsException,
                          CanceledExecutionException

Called from main(String[]) method. It parses the command line and starts up KNIME. It returns 0 if the execution was run (even with errors) and 1 if the command line could not be parsed (e.g. usage was printed).

Parameters:

args - Command line arguments

Returns:

0 if WorkflowManager (WFM) was executed, 1 otherwise.

Throws:

IOException - Delegated from WFM

InvalidSettingsException - Delegated from WFM

CanceledExecutionException - Delegated from WFM