Constructor Detail

• ModuleRunner

  public ModuleRunner()

  Constructor for ModuleRunner.

Method Detail

• parse_parameters

  public ReturnValue parse_parameters()

  parse_parameters.

  Specified by:

  parse_parameters in interface PluginInterface

  Overrides:

  parse_parameters in class Plugin

  Returns:

  a ReturnValue object.

• init

  public ReturnValue init()

  Plugin initialization code goes here. This is the first phase of the plugin lifecycle run. Might do things here like set up database access, create temp files, define defaults, etc. Preprocessing can be done here, although normally processing should be done by/during do_run(). The SEQWARE_SETTINGS file contents is passed in here.

  Returns:

• do_test

  public ReturnValue do_test()

  Perform any active system testing here. Use to make sure a DB is available, that a command line tools can be run, etc. You can even write functional tests that run the program you're wrapping on a small known good and then verify the output.

  Returns:

• do_run

  public ReturnValue do_run()

  Performs the main tasks for the plugin. This is where you actually execute your task and where the bulk of your implementation will go.

  Returns:

• clean_up

  public ReturnValue clean_up()

  Perform post-task clean-up here. Use to remove temporary files and directories, flush buffers and close db connections, etc.

  Returns:

• get_description

  public String get_description()

  get_description.

  Specified by:

  get_description in interface PluginInterface

  Overrides:

  get_description in class Plugin

  Returns:

  a String object.