ai.libs.jaicore.experiments.databasehandle

Class ExperimenterFileDBHandle

java.lang.Object

ai.libs.jaicore.experiments.databasehandle.ExperimenterFileDBHandle

All Implemented Interfaces:

IExperimentDatabaseHandle

public class ExperimenterFileDBHandle
extends java.lang.Object
implements IExperimentDatabaseHandle

Constructor Summary

Constructors

Constructor and Description
ExperimenterFileDBHandle(java.io.File file)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExperimenterFileDBHandle

public ExperimenterFileDBHandle(java.io.File file)

Method Detail

setup

public void setup(IExperimentSetConfig config)
           throws ExperimentDBInteractionFailedException

Description copied from interface: IExperimentDatabaseHandle

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

Specified by:

setup in interface IExperimentDatabaseHandle

Parameters:

config - Description of the experiment setup

Throws:

ExperimentDBInteractionFailedException

getConductedExperiments

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

Description copied from interface: IExperimentDatabaseHandle

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

Specified by:

getConductedExperiments in interface IExperimentDatabaseHandle

Returns:

List of all experiments

Throws:

ExperimentDBInteractionFailedException

createAndGetExperiment

public ExperimentDBEntry createAndGetExperiment(Experiment experiment)
                                         throws ExperimentDBInteractionFailedException

Description copied from interface: IExperimentDatabaseHandle

* Creates a new experiment entry and returns it.

Specified by:

createAndGetExperiment in interface IExperimentDatabaseHandle

Returns:

The id of the created experiment

Throws:

ExperimentDBInteractionFailedException

updateExperiment

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

Description copied from interface: IExperimentDatabaseHandle

Updates non-keyfield values of the experiment.

Specified by:

updateExperiment in interface IExperimentDatabaseHandle

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

public void finishExperiment(ExperimentDBEntry exp)
                      throws ExperimentDBInteractionFailedException

Description copied from interface: IExperimentDatabaseHandle

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

Specified by:

finishExperiment in interface IExperimentDatabaseHandle

Throws:

ExperimentDBInteractionFailedException

finishExperiment

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

Description copied from interface: IExperimentDatabaseHandle

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

Specified by:

finishExperiment in interface IExperimentDatabaseHandle

Throws:

ExperimentDBInteractionFailedException