org.kepler.loader.util

Class Screenshot

java.lang.Object

org.kepler.loader.util.Screenshot

public class Screenshot
extends java.lang.Object

A class to automate taking screenshots of Kepler workflows.

Author:

Daniel Crawl

Method Summary

Modifier and Type	Method and Description
static void	closeAll() Close all tableaux, which will shutdown Kepler.
static void	closeAllWhenDone(boolean close) Set if should close all tableaux and shutdown after last screenshot.
static java.util.List<java.io.File>	makeScreenshot(java.util.List<java.lang.String> workflows, java.lang.String type, java.util.List<java.lang.String> outputs, java.lang.String outputDir, boolean force) Create screenshots of workflows.

Methods inherited from class java.lang.Object

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

Method Detail

makeScreenshot

public static java.util.List<java.io.File> makeScreenshot(java.util.List<java.lang.String> workflows,
                                                          java.lang.String type,
                                                          java.util.List<java.lang.String> outputs,
                                                          java.lang.String outputDir,
                                                          boolean force)
                                                   throws java.lang.Exception

Create screenshots of workflows. There are three possible ways to specify the name and location of the output images:

• If outputDir is not null, then the images are all written to this directory with the same name as the workflow.
• If outputs is not null, then the outputs are written to the files specified in outputs. There must be a file name in outputs for each workflow.
• If both outputDir and outputs is null, the outputs are written to the same directory as the workflow, with the same name as the workflow.

Parameters:

workflows - the set of workflow filenames of which to create screenshots

type - the screenshot image type. If a set of output filenames are specified, this parameter must be null since the output filename extensions specify the image type.

outputs - A set of output filenames. If this is null, then the output directory and type must be specified. If this is not null, it must contain an output image name for each workflow.

outputDir - The output directory in which to write the screenshot images. If this is null, then the outputs must specify the output file names. Otherwise, outputs must be null.

force - If true, always create screenshot images. Otherwise, the screenshot images are only created if the output image does not exist or was last modified before the workflow file was last modified.

Returns:

A list of files containing the screenshots.

Throws:

java.lang.Exception

closeAllWhenDone

public static void closeAllWhenDone(boolean close)

Set if should close all tableaux and shutdown after last screenshot.

closeAll

public static void closeAll()
                     throws IllegalActionException

Close all tableaux, which will shutdown Kepler.

Throws:

IllegalActionException