bar

Class Runner

java.lang.Object

bar.Runner

public class Runner
extends Object

Runs a JARified script

Constructor Summary

Constructors

Constructor and Description
Runner(boolean silent) Constructor relying on IJ1.
Runner(Context context) Default constructor-based dependency injection

Method Summary

Modifier and Type	Method and Description
File	getLastLoadedResource()
String	getStatus()
void	installIJ1Macro(String path)
void	installIJ1Macro(String path, boolean singleTool)
Boolean	isSilent() return true if the LogService is not logging errors.
static void	main(String... args) Debug method
void	openLastLoadedResource()
String	readContents(String resourcePath)
String	readContents(URL url, boolean setGlobalFlags)
void	runBARMacro(String path, String arg) Legacy method that supports IJ1 macros that do not use script parameters.
void	runIJ1Macro(String path, String arg) Legacy method that supports IJ1 macros that do not use script parameters.
void	runScript(InputStream in, String filename) Runs a script from an InputStream.
void	runScript(InputStream in, String filename, Map<String,Object> inputMap) Runs a script from a jar file.
void	runScript(String path) Runs a (JARified) BAR script.
void	runScript(String path, Map<String,Object> inputMap) Runs a (JARified) BAR script.
void	runScript(String dir, String file) Runs a (JARified) BAR script.
void	runScript(String dir, String file, Map<String,Object> inputMap) Runs a (JARified) BAR script.
boolean	scriptLoaded() Assesses if last script was loaded successfully
void	setSilent(Boolean silent) Should LogService display errors?

Methods inherited from class java.lang.Object

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

Constructor Detail

Runner

public Runner(Context context)

Default constructor-based dependency injection

Runner

public Runner(boolean silent)

Constructor relying on IJ1.

Parameters:

silent - if errors should be ignored by the LogService

Method Detail

main

public static void main(String... args)
                 throws Exception

Debug method

Throws:

Exception

runScript

public void runScript(InputStream in,
                      String filename)

Runs a script from an InputStream.

Parameters:

in - the InputStream loading the script to be executed

filename - the script filename (or at least its extension)

runScript

public void runScript(String path)

Runs a (JARified) BAR script.

Parameters:

path - the path of the BAR script to be executed, e.g, scripts/BAR/Data_Analysis/Distribution_Plotter.ijm;

runScript

public void runScript(String path,
                      Map<String,Object> inputMap)

Runs a (JARified) BAR script.

Parameters:

path - the path of the BAR script to be executed, e.g, /scripts/BAR/Data_Analysis/Distribution_Plotter.ijm;

inputMap - see ScriptService.run(String, Reader, boolean, Map)

runScript

public void runScript(String dir,
                      String file,
                      Map<String,Object> inputMap)

Runs a (JARified) BAR script.

Parameters:

dir - the script directory, i.e., the subdirectory in the BAR jar relative to scripts/BAR/

file - the script filename (or at least its extension)

inputMap - see ScriptService.run(String, Reader, boolean, Map)

runScript

public void runScript(String dir,
                      String file)

Runs a (JARified) BAR script.

Parameters:

dir - the script directory, i.e., the subdirectory in the BAR jar relative to scripts/BAR/

file - the script filename

runScript

public void runScript(InputStream in,
                      String filename,
                      Map<String,Object> inputMap)

Runs a script from a jar file.

Parameters:

in - the InputStream loading the script to be executed

filename - the script filename (or at least its extension)

inputMap - see ScriptService.run(String, Reader, boolean, Map)

runBARMacro

public void runBARMacro(String path,
                        String arg)

Legacy method that supports IJ1 macros that do not use script parameters. Ported from Macro_Runner.runMacroFromJar(String, String).

Parameters:

path - the path to the IJ1 macro in the BAR jar file relative to scripts/

arg - the argument string to be retrieved through the IJ1 built-in macro function getArgument()

runIJ1Macro

public void runIJ1Macro(String path,
                        String arg)

Legacy method that supports IJ1 macros that do not use script parameters. Ported from Macro_Runner.runMacroFromJar(String, String).

Parameters:

path - the path to the IJ1 macro in the BAR jar file

arg - the argument string to be retrieved through the IJ1 built-in macro function getArgument()

installIJ1Macro

public void installIJ1Macro(String path)

installIJ1Macro

public void installIJ1Macro(String path,
                            boolean singleTool)

readContents

public String readContents(String resourcePath)

readContents

public String readContents(URL url,
                           boolean setGlobalFlags)

isSilent

public Boolean isSilent()

return true if the LogService is not logging errors. Note that passing invalid parameters to scripts may still trigger Console warnings.

setSilent

public void setSilent(Boolean silent)

Should LogService display errors?

Parameters:

silent - if true errors are ignored silently. Note that passing invalid parameters to scripts may still trigger Console warnings.

scriptLoaded

public boolean scriptLoaded()

Assesses if last script was loaded successfully

Returns:

true if the last run script could not be loaded otherwise false

getStatus

public String getStatus()

Returns:

the exit status: cancelled, done, exception, loaded, io error, or in the case of IJ1 macros loaded through legacy mechanisms the String value returned by the Macro_Runner.runMacro(String, String)

openLastLoadedResource

public void openLastLoadedResource()

getLastLoadedResource

public File getLastLoadedResource()