ai.libs.jaicore.experiments

Interface IExperimentDatabaseHandle

All Known Implementing Classes:

ExperimenterFileDBHandle, ExperimenterSQLHandle

public interface IExperimentDatabaseHandle

This interface is used by the ExperimentRunner to get, create, and update experiment entries.

Method Summary

Modifier and Type	Method and Description
ExperimentDBEntry	createAndGetExperiment(Experiment experiment) * Creates a new experiment entry and returns it.
void	finishExperiment(ExperimentDBEntry exp) Signals that an experiment has been finished successfully.
void	finishExperiment(ExperimentDBEntry exp, java.lang.Throwable errror) Signals that an experiment has failed with an exception.
java.util.Collection<ExperimentDBEntry>	getConductedExperiments() Returns a list of all experiments contained in the database.
void	setup(IExperimentSetConfig config) Prepares everything so that upcoming calls for create and update will be managed according to the specified configuration.
void	updateExperiment(ExperimentDBEntry exp, java.util.Map<java.lang.String,? extends java.lang.Object> values) Updates non-keyfield values of the experiment.

Method Detail

setup

void setup(IExperimentSetConfig config)
    throws ExperimentDBInteractionFailedException

Prepares everything so that upcoming calls for create and update will be managed according to the specified configuration.

Parameters:

config - Description of the experiment setup

Throws:

ExperimentDBInteractionFailedException

getConductedExperiments

java.util.Collection<ExperimentDBEntry> getConductedExperiments()
                                                         throws ExperimentDBInteractionFailedException

Returns a list of all experiments contained in the database. There is no need for those to be in line with the latest configuration.

Returns:

List of all experiments

Throws:

ExperimentDBInteractionFailedException

createAndGetExperiment

ExperimentDBEntry createAndGetExperiment(Experiment experiment)
                                  throws ExperimentDBInteractionFailedException,
                                         ExperimentAlreadyExistsInDatabaseException

* Creates a new experiment entry and returns it.

Parameters:

experiment -

experiment -

Returns:

The id of the created experiment

Throws:

ExperimentDBInteractionFailedException

ExperimentAlreadyExistsInDatabaseException

updateExperiment

void updateExperiment(ExperimentDBEntry exp,
                      java.util.Map<java.lang.String,? extends java.lang.Object> values)
               throws ExperimentUpdateFailedException

Updates non-keyfield values of the experiment.

Parameters:

exp - The experiment entry in the database

values - A key-value store where keys are names of result fields. The values will be associated to each key in the database.

Throws:

ExperimentUpdateFailedException

finishExperiment

void finishExperiment(ExperimentDBEntry exp)
               throws ExperimentDBInteractionFailedException

Signals that an experiment has been finished successfully. A corresponding timestamp will be attached to the experiment entry.

Parameters:

exp -

Throws:

ExperimentDBInteractionFailedException

finishExperiment

void finishExperiment(ExperimentDBEntry exp,
                      java.lang.Throwable errror)
               throws ExperimentDBInteractionFailedException

Signals that an experiment has failed with an exception. The timestamp and the exception will be stored with the experiment.

Parameters:

exp -

errror -

Throws:

ExperimentDBInteractionFailedException