org.expasy.mzjava.script

Class ScriptConfiguredToolRunner

java.lang.Object

org.expasy.mzjava.script.ScriptConfiguredToolRunner

public class ScriptConfiguredToolRunner
extends Object

A utility to help run ScriptConfiguredTools.

ScriptRunner can be used to run classes implementing ScriptConfiguredRunner interface. It works in conjunction with jsr-223 to allow a script to be used to configure the ScriptConfiguredTool.

By default java has a scripting engine for javascript. Groovy script can be added by using the following maven dependency.

 <dependency>
     <groupId>org.codehaus.groovy</groupId>
     <artifactId>groovy-jsr223</artifactId>
     <version>2.3.7</version>
 </dependency>
 

And python support can be added using the following maven dependency.

 <dependency>
     <groupId>org.python</groupId>
     <artifactId>jython</artifactId>
     <version>2.5.3</version>
 </dependency>
 

Version:

sqrt -1

Author:

Oliver Horlacher

See Also:

ScriptConfiguredTool

Method Summary

Methods

Modifier and Type	Method and Description
static <C> int	run(File scriptFile, ScriptConfiguredTool<C> tool) Runs the given ScriptedTool by calling ScriptConfiguredTool#run(C), after creating the configuration from the script in the scriptFile.
static <C> int	run(File scriptFile, ScriptConfiguredTool<C> tool, String[] args) Runs the given ScriptedTool by calling ScriptConfiguredTool#run(C), after creating the configuration from the script in the scriptFile.
static <C> int	run(String[] args, ScriptConfiguredTool<C> tool) Runs the given ScriptedTool by calling ScriptConfiguredTool#run(C), after creating the configuration from the script in the scriptFile.

Methods inherited from class java.lang.Object

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

Method Detail

run

public static <C> int run(String[] args,
          ScriptConfiguredTool<C> tool)
               throws Exception

Runs the given ScriptedTool by calling ScriptConfiguredTool#run(C), after creating the configuration from the script in the scriptFile. The args are set as a script variable called args.

Parameters:

args - the arguments. the first argument has to contains the path to the script file. The remaining arguments are passed to the scrip as the args scripting variable

tool - ScriptTool to run

Returns:

exit code of the ScriptConfiguredTool.run(Object) method.

Throws:

FileNotFoundException - if the script file cannot be found

ScriptException - if the script cannot be compiled

Exception

run

public static <C> int run(File scriptFile,
          ScriptConfiguredTool<C> tool)
               throws Exception

Runs the given ScriptedTool by calling ScriptConfiguredTool#run(C), after creating the configuration from the script in the scriptFile.

Parameters:

scriptFile - the file containing the script

tool - ScriptTool to run

Returns:

exit code of the ScriptConfiguredTool.run(Object) method.

Throws:

FileNotFoundException - if the script file cannot be found

ScriptException - if the script cannot be compiled

Exception

run

public static <C> int run(File scriptFile,
          ScriptConfiguredTool<C> tool,
          String[] args)
               throws Exception

Runs the given ScriptedTool by calling ScriptConfiguredTool#run(C), after creating the configuration from the script in the scriptFile. The args are set as a script variable called args.

Parameters:

scriptFile - the file containing the script

tool - ScriptTool to run

args - the arguments to set as the args script variable

Returns:

exit code of the ScriptConfiguredTool.run(Object) method.

Throws:

FileNotFoundException - if the script file cannot be found

ScriptException - if the script cannot be compiled

Exception