Skip to content

create progress module interface #331

@IvoryC

Description

@IvoryC

Think about this....

When you get this far, do this thing so that I know you got that far.
Modules implementing ProgressModule would be handled differently in that they would be allowed to fail without that impacting the pipeline. They are also not permitted to produce outputs. modules that beep, or send notifications, or .... maybe should be called NotificationModule (?).
The Email module would become one.

/**

  • Modules whose entire purpose is to inform the user of pipeline progress.
  • These always run on the head node. They do not produce output files.
  • They can write to the Log.
  • They are assumed to be so tiny and trivial as to finish in just a few seconds and take only kb of memory.
  • @author Ivory Blakley

*/
public interface ProgressModule extends BioModule {

/**
 * This is the main method called when it is time for the BioModule to complete its task.
 *
 * @throws Exception thrown if the module is unable to complete is task
 */
public void executeTask() throws Exception;

}

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions