org.hobbit.controller.data

Class ExperimentStatus

java.lang.Object

org.hobbit.controller.data.ExperimentStatus

All Implemented Interfaces:

Closeable, AutoCloseable

public class ExperimentStatus
extends Object
implements Closeable

This class is used to store all the information that are needed to controle a running experiment.

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExperimentStatus.States Typical states of a benchmark.

Field Summary

Fields

Modifier and Type	Field and Description
private long	abortionTimeStamp The timestamp at which the experiment will be aborted by the abortTimer.
private Timer	abortTimer Timer used to abort the experiment if it takes too much time.
private String	benchmarkContainer Container name of the system.
private boolean	benchmarkRunning Flag indicating whether the benchmark is ready.
ExperimentConfiguration	config Config of the current benchmark.
String	experimentUri URI of this experiment.
private static org.slf4j.Logger	LOGGER
private Semaphore	modelMutex Mutex to make the access to the model thread safe.
private org.apache.jena.rdf.model.Model	resultModel The RDF model containing the results.
private long	startTimeStamp The timestamp in which this status object has been created.
private ExperimentStatus.States	state State of the benchmark.
private String	systemContainer Container name of the system.
private boolean	systemRunning Flag indicating whether the benchmark system is ready.

Constructor Summary

Constructors

Constructor and Description
ExperimentStatus(ExperimentConfiguration config, String experimentUri) Creates an experiment status with the given experiment config, the given experiment URI and the current system time as start time.
ExperimentStatus(ExperimentConfiguration config, String experimentUri, ExperimentManager manager, long timeUntilAborting) Creates an experiment status with the given experiment config, the given experiment URI as well as the current system time as start time and starts the abortion timer using the given maximum runtime of the experiment and the experiment manager which will be used to abort the experiment if the time is exceeded.
ExperimentStatus(ExperimentConfiguration config, String experimentUri, ExperimentManager manager, long timeUntilAborting, long startTimeStamp) Creates an experiment status with the given experiment config, the given experiment URI as well as the given starting time and starts the abortion timer using the given maximum runtime of the experiment and the experiment manager which will be used to abort the experiment if the time is exceeded.
ExperimentStatus(ExperimentConfiguration config, String experimentUri, long startTimeStamp) Creates an experiment status with the given experiment config, the given experiment URI as well as the given starting time and starts the abortion timer using the given maximum runtime of the experiment and the experiment manager which will be used to abort the experiment if the time is exceeded.

Method Summary

Modifier and Type	Method and Description
private void	addBasicInformation_Unsecured() Adds basic information to the result model.
private void	addError_Unsecured(org.apache.jena.rdf.model.Resource error) Adds the given error to the result model.
void	addError(org.apache.jena.rdf.model.Resource error) Adds the given error to the result model.
void	addErrorIfNonPresent(org.apache.jena.rdf.model.Resource error) Adds the given error to the result model if it does not already contain an error.
void	addMetaDataToResult(ImageManager imageManager, long endTimeStamp) Uses the given ImageManager instance to add additional meta data regarding the benchmark and the system to the experiment result model.
void	close()
long	getAbortionTimeStamp()
String	getBenchmarkContainer()
ExperimentConfiguration	getConfig()
org.apache.jena.rdf.model.Model	getResultModel()
long	getStartTimeStamp()
ExperimentStatus.States	getState()
String	getSystemContainer()
private void	initModel_Unsecured() Initializes the result model and adds basic information using addBasicInformation_Unsecured().
boolean	isBenchmarkRunning()
boolean	isSystemRunning()
void	setBenchmarkContainer(String benchmarkContainer)
void	setBenchmarkRunning(boolean benchmarkRunning)
void	setOrMergeResultModel(org.apache.jena.rdf.model.Model resultModel) Sets the result model if there is no model present.
boolean	setReadyAndCheck(boolean systemReportedReady) The method sets a flag that (depending on the given flag) the system or the benchmark is ready and returns true if internally both have the state of being ready.
void	setResultModel(org.apache.jena.rdf.model.Model resultModel) Sets the result model.
void	setState(ExperimentStatus.States state)
void	setSystemContainer(String systemContainer)
void	setSystemRunning(boolean systemRunning)
void	startAbortionTimer(ExperimentManager manager, long timeUntilAborting) Starts the abortion timer using the given maximum runtime of the experiment and the experiment manager which will be used to abort the experiment if the time is exceeded.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final org.slf4j.Logger LOGGER

config

public final ExperimentConfiguration config

Config of the current benchmark.

experimentUri

public final String experimentUri

URI of this experiment.

startTimeStamp

private final long startTimeStamp

The timestamp in which this status object has been created.

abortionTimeStamp

private long abortionTimeStamp

The timestamp at which the experiment will be aborted by the abortTimer.

state

private ExperimentStatus.States state

State of the benchmark.

benchmarkRunning

private boolean benchmarkRunning

Flag indicating whether the benchmark is ready.

systemRunning

private boolean systemRunning

Flag indicating whether the benchmark system is ready.

benchmarkContainer

private String benchmarkContainer

Container name of the system.

systemContainer

private String systemContainer

Container name of the system.

resultModel

private org.apache.jena.rdf.model.Model resultModel

The RDF model containing the results.

modelMutex

private Semaphore modelMutex

Mutex to make the access to the model thread safe.

abortTimer

private final Timer abortTimer

Timer used to abort the experiment if it takes too much time.

Constructor Detail

ExperimentStatus

public ExperimentStatus(ExperimentConfiguration config,
                        String experimentUri)

Creates an experiment status with the given experiment config, the given experiment URI and the current system time as start time.

Parameters:

config - the configuration of the experiment

experimentUri - the URI of the experiment

ExperimentStatus

public ExperimentStatus(ExperimentConfiguration config,
                        String experimentUri,
                        long startTimeStamp)

Creates an experiment status with the given experiment config, the given experiment URI as well as the given starting time and starts the abortion timer using the given maximum runtime of the experiment and the experiment manager which will be used to abort the experiment if the time is exceeded.

Parameters:

config - the configuration of the experiment

experimentUri - the URI of the experiment

startTimeStamp - the time stamp at which the experiment is started.

ExperimentStatus

public ExperimentStatus(ExperimentConfiguration config,
                        String experimentUri,
                        ExperimentManager manager,
                        long timeUntilAborting)

Creates an experiment status with the given experiment config, the given experiment URI as well as the current system time as start time and starts the abortion timer using the given maximum runtime of the experiment and the experiment manager which will be used to abort the experiment if the time is exceeded.

Parameters:

config - the configuration of the experiment

experimentUri - the URI of the experiment

manager - experiment manager which is used if the maximum runtime is exceeded

timeUntilAborting - the maximum runtime for this experiment which is used to configure the internal timer.

ExperimentStatus

public ExperimentStatus(ExperimentConfiguration config,
                        String experimentUri,
                        ExperimentManager manager,
                        long timeUntilAborting,
                        long startTimeStamp)

Creates an experiment status with the given experiment config, the given experiment URI as well as the given starting time and starts the abortion timer using the given maximum runtime of the experiment and the experiment manager which will be used to abort the experiment if the time is exceeded.

Parameters:

config - the configuration of the experiment

experimentUri - the URI of the experiment

manager - experiment manager which is used if the maximum runtime is exceeded

timeUntilAborting - the maximum runtime for this experiment which is used to configure the internal timer.

startTimeStamp - the time stamp at which the experiment is started.

Method Detail

getState

public ExperimentStatus.States getState()

setState

public void setState(ExperimentStatus.States state)

getConfig

public ExperimentConfiguration getConfig()

isBenchmarkRunning

public boolean isBenchmarkRunning()

setBenchmarkRunning

public void setBenchmarkRunning(boolean benchmarkRunning)

isSystemRunning

public boolean isSystemRunning()

setSystemRunning

public void setSystemRunning(boolean systemRunning)

getBenchmarkContainer

public String getBenchmarkContainer()

setBenchmarkContainer

public void setBenchmarkContainer(String benchmarkContainer)

getSystemContainer

public String getSystemContainer()

setSystemContainer

public void setSystemContainer(String systemContainer)

getStartTimeStamp

public long getStartTimeStamp()

getAbortionTimeStamp

public long getAbortionTimeStamp()

startAbortionTimer

public void startAbortionTimer(ExperimentManager manager,
                               long timeUntilAborting)

Starts the abortion timer using the given maximum runtime of the experiment and the experiment manager which will be used to abort the experiment if the time is exceeded.

Parameters:

manager - experiment manager which is used if the maximum runtime is exceeded

timeUntilAborting - the maximum runtime for this experiment which is used to configure the internal timer.

setReadyAndCheck

public boolean setReadyAndCheck(boolean systemReportedReady)

The method sets a flag that (depending on the given flag) the system or the benchmark is ready and returns true if internally both have the state of being ready.

Parameters:

systemReportedReady - true if the system is ready or false if the benchmark is ready

Returns:

true if system and benchmark are ready

getResultModel

public org.apache.jena.rdf.model.Model getResultModel()

setOrMergeResultModel

public void setOrMergeResultModel(org.apache.jena.rdf.model.Model resultModel)

Sets the result model if there is no model present. Otherwise, the given model is merged with the existing model.

This method is thread-safe.

Parameters:

resultModel - the new result model

setResultModel

public void setResultModel(org.apache.jena.rdf.model.Model resultModel)

Sets the result model.

This method is thread-safe.

Parameters:

resultModel - the new result model

addErrorIfNonPresent

public void addErrorIfNonPresent(org.apache.jena.rdf.model.Resource error)

Adds the given error to the result model if it does not already contain an error.

This method is thread-safe.

Parameters:

error - the error that should be added to the result model

addError

public void addError(org.apache.jena.rdf.model.Resource error)

Adds the given error to the result model.

This method is thread-safe.

Parameters:

error - the error that should be added to the result model

addError_Unsecured

private void addError_Unsecured(org.apache.jena.rdf.model.Resource error)

Adds the given error to the result model.

This method is not thread-safe.

Parameters:

error - the error that should be added to the result model

initModel_Unsecured

private void initModel_Unsecured()

Initializes the result model and adds basic information using addBasicInformation_Unsecured().

This method is not thread-safe.

addBasicInformation_Unsecured

private void addBasicInformation_Unsecured()

Adds basic information to the result model.

This method is not thread-safe.

addMetaDataToResult

public void addMetaDataToResult(ImageManager imageManager,
                                long endTimeStamp)

Uses the given ImageManager instance to add additional meta data regarding the benchmark and the system to the experiment result model.

Parameters:

imageManager - used to get RDF models for the benchmark and the system of this experiment

endTimeStamp - point in time at which the experiment ended

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException