Package jasima.core.expExecution

Class ExperimentExecutor

java.lang.Object

jasima.core.expExecution.ExperimentExecutor

Direct Known Subclasses:

ThreadPoolExecutor

public abstract class ExperimentExecutor
extends Object

Base class for classes executing experiments. This class implements the Abstract Factory pattern, therefore ExperimentExecutor.getExecutor() has to be called to create executor instances. This call is delegated to a non-abstract implementation of ExperimentExecutor. Which ExperimentExecutor to use is determined by a system property " jasima.core.expExecution.ExperimentExecutor". As a default, a ThreadPoolExecutor is used (with a maximum number of threads equal to the number of available processors).

Author:

Torsten Hildebrandt

See Also:

ThreadPoolExecutor, ForkJoinPoolExecutor

Field Summary

Fields

Modifier and Type	Field	Description
static Class<? extends ExperimentExecutor>	execFactoryImpl
static String	EXECUTOR_FACTORY

Constructor Summary

Constructors

Constructor	Description
ExperimentExecutor()	Don't call directly, use getExecutor() instead.

Method Summary

Modifier and Type	Method	Description
abstract ExecutorService	experimentExecutor(Experiment e, Experiment parent)	Returns the ExecutorService that should be used to execute the Experiment.
static ExperimentExecutor	getExecutor()
static Collection<ExperimentCompletableFuture>	runAllExperiments(Collection<? extends Experiment> es, Experiment parent)	Execute many experiments at once.
static ExperimentCompletableFuture	runExperimentAsync(Experiment e, Experiment parent)	Runs an experiment (usually in an asynchronous way).
static ExperimentCompletableFuture	runExperimentAsync(Experiment e, Experiment parent, ExecutorService es)	Runs an experiment (usually in an asynchronous way).
abstract void	shutdownNow()	Shuts down this ExperimentExecutor.

Methods inherited from class java.lang.Object

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

Field Detail

EXECUTOR_FACTORY

public static final String EXECUTOR_FACTORY

execFactoryImpl

public static final Class<? extends ExperimentExecutor> execFactoryImpl

Constructor Detail

ExperimentExecutor

public ExperimentExecutor()

Don't call directly, use getExecutor() instead. Has to be public to be callable by reflection.

Method Detail

getExecutor

public static ExperimentExecutor getExecutor()

shutdownNow

public abstract void shutdownNow()

Shuts down this ExperimentExecutor.

experimentExecutor

public abstract ExecutorService experimentExecutor(Experiment e,
                                                   @Nullable
                                                   Experiment parent)

Returns the ExecutorService that should be used to execute the Experiment.

Parameters:

e - The experiment to be executed.

parent - A parent experiment that is executing e (can be null).

Returns:

The ExecutorService to execute it with.

runAllExperiments

public static Collection<ExperimentCompletableFuture> runAllExperiments(Collection<? extends Experiment> es,
                                                                        Experiment parent)

Execute many experiments at once. The implementation here simply calls runExperimentAsync(Experiment,Experiment) for all experiments in es.

Parameters:

es - A list of Experiments to run.

parent - The parent experiment of "es". This might be null.

Returns:

A Collection of ExperimentCompletableFutures, one for each submitted experiment.

runExperimentAsync

public static ExperimentCompletableFuture runExperimentAsync(Experiment e,
                                                             Experiment parent)

Runs an experiment (usually in an asynchronous way). Therefore an ExperimentCompletableFuture is returned to access results once they become available.

Parameters:

e - The experiment to execute.

parent - The parent experiment of "e". This might be null.

Returns:

An ExperimentCompletableFuture to access experiment results.

runExperimentAsync

public static ExperimentCompletableFuture runExperimentAsync(Experiment e,
                                                             Experiment parent,
                                                             ExecutorService es)

Runs an experiment (usually in an asynchronous way). Therefore an ExperimentCompletableFuture is returned to access results once they become available.

Parameters:

e - The experiment to execute.

parent - The parent experiment of "e". This might be null.

Returns:

An ExperimentCompletableFuture to access experiment results.