Package fr.ens.biologie.genomique.eoulsan.core.workflow

Class StepStatus

java.lang.Object

fr.ens.biologie.genomique.eoulsan.core.workflow.StepStatus

public class StepStatus
extends Object

This class define a step status.

Since:

2.0

Author:

Laurent Jourdren

Constructor Summary

Constructors

Constructor	Description
StepStatus(AbstractStep step)

Method Summary

Modifier and Type	Method	Description
String	getNote()	Get the note.
double	getProgress()	Get the progress of the step.
int	getSubmittedTasks()	Get the number of submitted tasks.
String	getTaskName(int contextId)	Get the name of a task.
double	getTaskProgress(int contextId)	Get the progress of a task.
int	getTerminatedTasks()	Get the number of terminated tasks.
void	setNote(String note)	Set the note.
void	setProgress(double progress)	Set the progress of a step.
void	setProgress(int min, int max, int value)	Set the progress of a step.
void	setTaskDone(int contextId)	Set task done.
void	setTaskProgress(int contextId, String contextName, double progress)	Set the progress of a task.
void	setTaskProgress(int contextId, String contextName, int min, int max, int value)	Set the progress of a task.
void	setTaskRunning(int contextId)	Set task running.
void	setTaskSubmitted(int contextId)	Set task submitted.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StepStatus

public StepStatus(AbstractStep step)

Method Detail

getNote

public String getNote()

Get the note.

Returns:

the note

getProgress

public double getProgress()

Get the progress of the step.

Returns:

a double between O and 1

getTaskName

public String getTaskName(int contextId)

Get the name of a task.

Parameters:

contextId - the id of the task

Returns:

a String with the name of the context or null if the context not exists

getTaskProgress

public double getTaskProgress(int contextId)

Get the progress of a task.

Parameters:

contextId - the id of the task

Returns:

a double between O and 1

getSubmittedTasks

public int getSubmittedTasks()

Get the number of submitted tasks.

Returns:

the number of submitted tasks

getTerminatedTasks

public int getTerminatedTasks()

Get the number of terminated tasks.

Returns:

the number of terminated tasks

setNote

public void setNote(String note)

Set the note.

Parameters:

note - the note to set

setProgress

public void setProgress(int min,
                        int max,
                        int value)

Set the progress of a step.

Parameters:

min - minimal value

max - maximal value

value - value to set

setProgress

public void setProgress(double progress)

Set the progress of a step.

Parameters:

progress - value to set

setTaskProgress

public void setTaskProgress(int contextId,
                            String contextName,
                            int min,
                            int max,
                            int value)

Set the progress of a task.

Parameters:

contextId - id of the context

contextName - name of the context

min - minimal value

max - maximal value

value - value to set

setTaskProgress

public void setTaskProgress(int contextId,
                            String contextName,
                            double progress)

Set the progress of a task.

Parameters:

contextId - id of the context

contextName - name of the context

progress - progress value to set

setTaskSubmitted

public void setTaskSubmitted(int contextId)

Set task submitted.

Parameters:

contextId - id of the context

setTaskRunning

public void setTaskRunning(int contextId)

Set task running.

Parameters:

contextId - id of the context

setTaskDone

public void setTaskDone(int contextId)

Set task done.

Parameters:

contextId - id of the context