Constructor Detail

• UserSettingsPlugin

  public UserSettingsPlugin()

Method Detail

• setConfig

  public void setConfig(Map<String,String> config)

  Let's you set the config this object should use.

  Specified by:

  setConfig in interface PluginInterface

  Overrides:

  setConfig in class Plugin

  Parameters:

  config -

• setParams

  public void setParams(List<String> params)

  Lets you set a List of params so the plugin can deal with parameters

  Specified by:

  setParams in interface PluginInterface

  Overrides:

  setParams in class Plugin

  Parameters:

  params -

• setMetadata

  public void setMetadata(Metadata metadata)

  Lets you set the metadata object

  Specified by:

  setMetadata in interface PluginInterface

  Overrides:

  setMetadata in class Plugin

  Parameters:

  metadata -

• get_syntax

  public String get_syntax()

  Generates a "help" message for the user of the plugin. This will be called by the PluginRunner to provide information about using the plugin. It is up to the implementation to defined the format for the returned message. This is triggered if no options are provided to the PluginRunner.

  Specified by:

  get_syntax in interface PluginInterface

  Overrides:

  get_syntax in class Plugin

  Returns:

• parse_parameters

  public ReturnValue parse_parameters()

  Parameter validation code goes here. Use to make sure all required parameters are available, that parameters are known, that they have reasonable values, etc. Validation involving multiple options happens here where the existence and content of input data files will be checked.

  Specified by:

  parse_parameters in interface PluginInterface

  Overrides:

  parse_parameters in class Plugin

  Returns:

• 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.

• main

  public static void main(String[] args)