org.aksw.gerbil.database

Class AbstractExperimentDAO

java.lang.Object

org.aksw.gerbil.database.AbstractExperimentDAO

All Implemented Interfaces:

Closeable, AutoCloseable, ExperimentDAO

Direct Known Subclasses:

ExperimentDAOImpl

public abstract class AbstractExperimentDAO
extends Object
implements ExperimentDAO

Abstract class implementing the general behavior of an ExperimentDAO. Note that it is strongly recommended to extend this class instead of implementing the ExperimentDAO class directly since this class already takes care of the synchronization problem of the ExperimentDAO.connectCachedResultOrCreateTask(String, String, String, String, String) method.

Author:

m.roeder

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	EXPERIMENT_TASK_NOT_CACHED Sentinel value used to indicate that an experiment task with the given preferences couldn't be found.
protected boolean	initialized
protected long	resultDurability

Fields inherited from interface org.aksw.gerbil.database.ExperimentDAO

CACHED_EXPERIMENT_TASK_CAN_BE_USED, TASK_FINISHED, TASK_NOT_FOUND, TASK_STARTED_BUT_NOT_FINISHED_YET

Constructor Summary

Constructors

Constructor and Description
AbstractExperimentDAO()
AbstractExperimentDAO(long resultDurability)

Method Summary

Modifier and Type	Method and Description
int	connectCachedResultOrCreateTask(String annotatorName, String datasetName, String experimentType, String matching, String experimentId) This method is called with the description of an experiment task and an experiment id.
protected abstract void	connectExistingTaskWithExperiment(int experimentTaskId, String experimentId) This method connects an already existing experiment task with an experiment.
protected abstract List<String[]>	getAnnotatorDatasetCombinations(String experimentType, String matching) Deprecated.
protected abstract int	getCachedExperimentTaskId(String annotatorName, String datasetName, String experimentType, String matching) The method checks whether there exists an experiment task with the given preferences inside the database.
protected abstract ExperimentTaskResult	getLatestExperimentTaskResult(String experimentType, String matching, String annotatorName, String datasetName) Deprecated.
List<ExperimentTaskResult>	getLatestResultsOfExperiments(String experimentType, String matching) Deprecated.
long	getResultDurability()
void	initialize() The AbstractExperimentDAO class makes sure that an instance is initialized only once even if this method is called multiple times.
void	setResultDurability(long resultDurability) Sets the durability of a experiment task result.
protected abstract void	setRunningExperimentsToError() Searches the database for experiment tasks that have been started but not ended yet (their status equals ExperimentDAO.TASK_STARTED_BUT_NOT_FINISHED_YET ) and set their status to ErrorTypes.SERVER_STOPPED_WHILE_PROCESSING.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.aksw.gerbil.database.ExperimentDAO

createTask, getAllRunningExperimentTasks, getExperimentState, getHighestExperimentId, getLatestResultsOfExperiments, getResultOfExperimentTask, getResultsOfExperiment, setExperimentState, setExperimentTaskResult

Methods inherited from interface java.io.Closeable

close

Field Detail

EXPERIMENT_TASK_NOT_CACHED

protected static final int EXPERIMENT_TASK_NOT_CACHED

Sentinel value used to indicate that an experiment task with the given preferences couldn't be found.

See Also:

Constant Field Values

resultDurability

protected long resultDurability

initialized

protected boolean initialized

Constructor Detail

AbstractExperimentDAO

public AbstractExperimentDAO()

AbstractExperimentDAO

public AbstractExperimentDAO(long resultDurability)

Method Detail

initialize

public void initialize()

The AbstractExperimentDAO class makes sure that an instance is initialized only once even if this method is called multiple times.

Specified by:

initialize in interface ExperimentDAO

setRunningExperimentsToError

protected abstract void setRunningExperimentsToError()

Searches the database for experiment tasks that have been started but not ended yet (their status equals ExperimentDAO.TASK_STARTED_BUT_NOT_FINISHED_YET ) and set their status to ErrorTypes.SERVER_STOPPED_WHILE_PROCESSING. This method should only be called directly after the initialization of the database. It makes sure that "old" experiment tasks which have been started but never finished are set to an error state and can't be used inside the caching mechanism.

setResultDurability

public void setResultDurability(long resultDurability)

Description copied from interface: ExperimentDAO

Sets the durability of a experiment task result.

Specified by:

setResultDurability in interface ExperimentDAO

getResultDurability

public long getResultDurability()

connectCachedResultOrCreateTask

public int connectCachedResultOrCreateTask(String annotatorName,
                                           String datasetName,
                                           String experimentType,
                                           String matching,
                                           String experimentId)

Description copied from interface: ExperimentDAO

This method is called with the description of an experiment task and an experiment id. The method checks whether there is already such an experiment task inside the database that does not have an error code as state. If such a task exists and if it is not to old regarding the durability of experiment task results, the experiment id is connected to the already existing task and ExperimentDAO.CACHED_EXPERIMENT_TASK_CAN_BE_USED = -1 is returned. Otherwise, a new experiment task is created, set to unfinished by setting its state to ExperimentDAO.TASK_STARTED_BUT_NOT_FINISHED_YET, connected to the given experiment and the id of the newly created experiment task is returned. NOTE: this method MUST be synchronized since it should only be called by a single thread at once.

Specified by:

connectCachedResultOrCreateTask in interface ExperimentDAO

Parameters:

annotatorName - the name with which the annotator can be identified

datasetName - the name of the dataset

experimentType - the name of the experiment type

matching - the name of the matching used

experimentId - the id of the experiment

Returns:

ExperimentDAO.CACHED_EXPERIMENT_TASK_CAN_BE_USED= -1 if there is already an experiment task with the given preferences or the id of the newly created experiment task.

getCachedExperimentTaskId

protected abstract int getCachedExperimentTaskId(String annotatorName,
                                                 String datasetName,
                                                 String experimentType,
                                                 String matching)

The method checks whether there exists an experiment task with the given preferences inside the database. If such a task exists, if it is not to old regarding the durability of experiment task results and if its state is not an error code, its experiment task id is returned. Otherwise EXPERIMENT_TASK_NOT_CACHED is returned. NOTE: this method MUST be synchronized since it should only be called by a single thread at once.

Parameters:

annotatorName - the name with which the annotator can be identified

datasetName - the name of the dataset

experimentType - the name of the experiment type

matching - the name of the matching used

Returns:

The id of the experiment task or -1 if such an experiment task couldn't be found.

connectExistingTaskWithExperiment

protected abstract void connectExistingTaskWithExperiment(int experimentTaskId,
                                                          String experimentId)

This method connects an already existing experiment task with an experiment.

Parameters:

experimentTaskId - the id of the experiment task

experimentId - the id of the experiment

getLatestResultsOfExperiments

@Deprecated
public List<ExperimentTaskResult> getLatestResultsOfExperiments(String experimentType,
                                                                             String matching)

Deprecated.

Description copied from interface: ExperimentDAO

Returns the latest results for experiments with the given experiment type and matching type. Note that the experiment tasks of which the results are returned should be finished.

Specified by:

getLatestResultsOfExperiments in interface ExperimentDAO

Parameters:

experimentType - the name of the experiment type

matching - the name of the matching used

Returns:

a list of the latest results available in the database.

getAnnotatorDatasetCombinations

@Deprecated
protected abstract List<String[]> getAnnotatorDatasetCombinations(String experimentType,
                                                                               String matching)

Deprecated.

This method returns a list of annotator dataset combinations for the given experimentType and matching that exist inside the database. The first element of every array contains the name of an annotator and the second element is the name of a dataset.

Parameters:

experimentType - the name of the experiment type

matching - the name of the matching used

Returns:

a list of annotator dataset combinations

getLatestExperimentTaskResult

@Deprecated
protected abstract ExperimentTaskResult getLatestExperimentTaskResult(String experimentType,
                                                                                   String matching,
                                                                                   String annotatorName,
                                                                                   String datasetName)

Deprecated.

Returns the result of the most recent finished experiment task with the given experiment type, matchin, annotator and dataset.

Parameters:

annotatorName - the name with which the annotator can be identified

datasetName - the name of the dataset

experimentType - the name of the experiment type

matching - the name of the matching used

Returns:

the result of the most recent experiment task or null if no such task exists