org.hobbit.controller.queue

Interface ExperimentQueue

All Known Implementing Classes:

ExperimentQueueImpl, InMemoryQueue

public interface ExperimentQueue

This is the interface of a queue containing experiment configurations that should be executed.

Author:

Michael Röder (roeder@informatik.uni-leipzig.de)

Method Summary

Modifier and Type	Method and Description
void	add(ExperimentConfiguration experiment) Adds the given experiment to the queue.
ExperimentConfiguration	getExperiment(String experimentId) Retrieves the experiment configuration with the given experiment id.
ExperimentConfiguration	getNextExperiment() Returns the experiment that should be executed next.
List<ExperimentConfiguration>	listAll() Returns the list of all experiments waiting in this queue.
boolean	remove(ExperimentConfiguration experiment) Removes the experiment from the queue.

Method Detail

getNextExperiment

ExperimentConfiguration getNextExperiment()

Returns the experiment that should be executed next.

Returns:

the experiment that should be executed next

add

void add(ExperimentConfiguration experiment)

Adds the given experiment to the queue.

Parameters:

experiment - the experiment that should be added

remove

boolean remove(ExperimentConfiguration experiment)

Removes the experiment from the queue.

Parameters:

experiment - the experiment that should be removed from the queue

Returns:

true if the given experiment has been removed

listAll

List<ExperimentConfiguration> listAll()

Returns the list of all experiments waiting in this queue.

Returns:

the list of all experiments waiting in this queue

getExperiment

ExperimentConfiguration getExperiment(String experimentId)

Retrieves the experiment configuration with the given experiment id.

Parameters:

experimentId - the id of the experiment that should be retrieved

Returns:

the experiment configuration or null if such an experiment can not be found