Constructor Detail

• FileProvenanceReporter

  public FileProvenanceReporter()

Method Detail

• get_description

  public String get_description()

  Description copied from class: Plugin
  Generates a short description of the plugin, preferably one line.

  Specified by:

  get_description in interface PluginInterface

  Overrides:

  get_description in class Plugin

  Returns:

  Description of the plugin.

• init

  public ReturnValue init()

  Description copied from interface: PluginInterface
  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:

  Success or failure info from this phase, along with any console output.

• do_test

  public ReturnValue do_test()

  Description copied from interface: PluginInterface
  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:

  Success or failure info from this phase, along with any console output.

• do_run

  public ReturnValue do_run()

  Description copied from interface: PluginInterface
  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:

  Success or failure info from this phase, along with any console output.

• clean_up

  public ReturnValue clean_up()

  Description copied from interface: PluginInterface
  Perform post-task clean-up here. Use to remove temporary files and directories, flush buffers and close db connections, etc.

  Returns:

  Success or failure info from this phase, along with any console output.