Class BasicUI

  • All Implemented Interfaces:
    StepObserver, UI

    public class BasicUI
    extends Object
    This class define a basic UI for Eoulsan.
    Since:
    2.0
    Author:
    Laurent Jourdren
    • Constructor Detail

      • BasicUI

        public BasicUI()
    • Method Detail

      • getName

        public String getName()
        Description copied from interface: UI
        Get the name of the UI.
        Returns:
        the name of the UI
      • init

        public void init​(Workflow workflow)
        Description copied from interface: UI
        Initialize the UI.
        Parameters:
        workflow - the worflow
      • notifyStepState

        public void notifyStepState​(Step step,
                                    Step.StepState stepState)
        Description copied from interface: StepObserver
        The status of the step has been changed.
        Parameters:
        step - step that the status has been changed
        stepState - state the step state
      • notifyStepState

        public void notifyStepState​(Step step,
                                    int contextId,
                                    String contextName,
                                    double progress)
        Description copied from interface: StepObserver
        The progress of the step for a sample has been changed.
        Parameters:
        step - step that the progress has been changed
        contextId - id of the context
        contextName - name of the context that has been changed
      • notifyStepState

        public void notifyStepState​(Step step,
                                    int terminatedTasks,
                                    int submittedTasks,
                                    double progress)
        Description copied from interface: StepObserver
        The progress of the step has been changed.
        Parameters:
        step - step that the progress has been changed
        terminatedTasks - the terminated tasks count
        submittedTasks - the submitted tasks count
        progress - the progress of the step
      • notifyStepState

        public void notifyStepState​(Step step,
                                    String note)
        Description copied from interface: StepObserver
        The note of the step has been changed.
        Parameters:
        step - step that the note has been changed
      • notifyWorkflowSuccess

        public void notifyWorkflowSuccess​(boolean success,
                                          String message)
        Description copied from interface: StepObserver
        Notify the success of the workflow.
        Parameters:
        success - the success of the workflow
        message - success message
      • notifyTaskSubmitted

        public void notifyTaskSubmitted​(Step step,
                                        int contextId)
        Description copied from interface: StepObserver
        Notify that a task has been submitted.
        Parameters:
        step - the step of the submitted task
        contextId - id of the context
      • notifyTaskRunning

        public void notifyTaskRunning​(Step step,
                                      int contextId)
        Description copied from interface: StepObserver
        Notify that a task is running.
        Parameters:
        step - the step of the submitted task
        contextId - id of the context
      • notifyTaskDone

        public void notifyTaskDone​(Step step,
                                   int contextId)
        Description copied from interface: StepObserver
        Notify that a task has been done.
        Parameters:
        step - the step of the submitted task
        contextId - id of the context
      • isInteractiveMode

        protected boolean isInteractiveMode()
        Test if Eoulsan is running in an interactive mode.
        Returns:
        true if Eoulsan is running in an interactive mode