org.aksw.gerbil.database

Class ExperimentDAOImpl

java.lang.Object

org.aksw.gerbil.database.AbstractExperimentDAO

org.aksw.gerbil.database.ExperimentDAOImpl

All Implemented Interfaces:

Closeable, AutoCloseable, ExperimentDAO

public class ExperimentDAOImpl
extends AbstractExperimentDAO

SQL database based implementation of the AbstractExperimentDAO class.

Author:

b.eickmann, m.roeder

Field Summary

Fields inherited from class org.aksw.gerbil.database.AbstractExperimentDAO

EXPERIMENT_TASK_NOT_CACHED, initialized, 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
ExperimentDAOImpl(DataSource dataSource)
ExperimentDAOImpl(DataSource dataSource, long resultDurability)

Method Summary

Modifier and Type	Method and Description
protected void	addAdditionalResults(ExperimentTaskResult result)
protected void	addAdditionaResult(int taskId, int resultId, double value)
protected void	addSubTaskRelation(int taskId, int subTaskId)
protected void	addSubTasks(ExperimentTaskResult expTask)
void	close()
protected void	connectExistingTaskWithExperiment(int experimentTaskId, String experimentId) This method connects an already existing experiment task with an experiment.
int	createTask(String annotatorName, String datasetName, String experimentType, String matching, String experimentId) Creates a new experiment task with the given preferences, sets its GERBIL version value using the current version, sets the task to unfinished by setting its state to ExperimentDAO.TASK_STARTED_BUT_NOT_FINISHED_YET and connects it to the experiment with the given experiment id.
List<ExperimentTaskResult>	getAllRunningExperimentTasks() Returns a list of all running experiment tasks.
protected List<String[]>	getAnnotatorDatasetCombinations(String experimentType, String matching) Deprecated.
protected 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.
int	getExperimentState(int experimentTaskId) Returns the state of the existing experiment task, identified by the given id.
String	getHighestExperimentId() Returns the highest experiment ID that is known by the system or null if there are no experiments.
protected ExperimentTaskResult	getLatestExperimentTaskResult(String experimentType, String matching, String annotatorName, String datasetName) Deprecated.
List<ExperimentTaskResult>	getLatestResultsOfExperiments(String experimentType, String matching) Returns the latest results for experiments with the given experiment type and matching type.
List<ExperimentTaskResult>	getLatestResultsOfExperiments(String experimentType, String matching, String[] annotatorNames, String[] datasetNames) Returns the latest results for experiments with the given experiment type and matching type.
ExperimentTaskResult	getResultOfExperimentTask(int experimentTaskId) Returns the result of the experiment task with the given ID or null if this task does not exist.
List<ExperimentTaskResult>	getResultsOfExperiment(String experimentId) Returns the results of the experiment tasks that are connected to the experiment with the given experiment id.
protected void	insertSubTask(ExperimentTaskResult subTask, int experimentTaskId)
void	setExperimentState(int experimentTaskId, int state) Sets the state of the already existing experiment task, identified by the given id.
void	setExperimentTaskResult(int experimentTaskId, ExperimentTaskResult result) This method updates the result of the already existing experiment task, identified by the given id.
protected 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 org.aksw.gerbil.database.AbstractExperimentDAO

connectCachedResultOrCreateTask, getResultDurability, initialize, setResultDurability

Methods inherited from class java.lang.Object

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

Constructor Detail

ExperimentDAOImpl

public ExperimentDAOImpl(DataSource dataSource)

ExperimentDAOImpl

public ExperimentDAOImpl(DataSource dataSource,
                         long resultDurability)

Method Detail

getResultsOfExperiment

public List<ExperimentTaskResult> getResultsOfExperiment(String experimentId)

Description copied from interface: ExperimentDAO

Returns the results of the experiment tasks that are connected to the experiment with the given experiment id. Note that before retrieving the results of an experiment its state should be checked.

Parameters:

experimentId - if of the experiment

Returns:

a list of experiment task results that are connected to the experiment

createTask

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

Description copied from interface: ExperimentDAO

Creates a new experiment task with the given preferences, sets its GERBIL version value using the current version, sets the task to unfinished by setting its state to ExperimentDAO.TASK_STARTED_BUT_NOT_FINISHED_YET and connects it to the experiment with the given experiment id.

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:

the id of the newly created experiment task.

setExperimentTaskResult

public void setExperimentTaskResult(int experimentTaskId,
                                    ExperimentTaskResult result)

Description copied from interface: ExperimentDAO

This method updates the result of the already existing experiment task, identified by the given id. Additionally it should update the timestamp of the task and set its state to the state countained inside the given result object.

Parameters:

experimentTaskId - the id of the experiment task to which the result has been calculated

result - the result of this experiment task

addAdditionaResult

protected void addAdditionaResult(int taskId,
                                  int resultId,
                                  double value)

setExperimentState

public void setExperimentState(int experimentTaskId,
                               int state)

Description copied from interface: ExperimentDAO

Sets the state of the already existing experiment task, identified by the given id.

Parameters:

experimentTaskId - the id of the experiment task for which the state should be set

state - the state of this experiment task

getExperimentState

public int getExperimentState(int experimentTaskId)

Description copied from interface: ExperimentDAO

Returns the state of the existing experiment task, identified by the given id.

Parameters:

experimentTaskId - the id of the experiment task for which the state should be retrieved

Returns:

the state of the experiment task or ExperimentDAO.TASK_NOT_FOUND= -2 if such a task couldn't be found.

getCachedExperimentTaskId

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

Description copied from class: AbstractExperimentDAO

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 AbstractExperimentDAO.EXPERIMENT_TASK_NOT_CACHED is returned. NOTE: this method MUST be synchronized since it should only be called by a single thread at once.

Specified by:

getCachedExperimentTaskId in class AbstractExperimentDAO

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 void connectExistingTaskWithExperiment(int experimentTaskId,
                                                 String experimentId)

Description copied from class: AbstractExperimentDAO

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

Specified by:

connectExistingTaskWithExperiment in class AbstractExperimentDAO

Parameters:

experimentTaskId - the id of the experiment task

experimentId - the id of the experiment

getHighestExperimentId

public String getHighestExperimentId()

Description copied from interface: ExperimentDAO

Returns the highest experiment ID that is known by the system or null if there are no experiments.

Returns:

the highest experiment ID or null if there is no experiment

setRunningExperimentsToError

protected void setRunningExperimentsToError()

Description copied from class: AbstractExperimentDAO

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.

Specified by:

setRunningExperimentsToError in class AbstractExperimentDAO

getAnnotatorDatasetCombinations

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

Deprecated.

Description copied from class: AbstractExperimentDAO

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.

Specified by:

getAnnotatorDatasetCombinations in class AbstractExperimentDAO

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 ExperimentTaskResult getLatestExperimentTaskResult(String experimentType,
                                                                          String matching,
                                                                          String annotatorName,
                                                                          String datasetName)

Deprecated.

Description copied from class: AbstractExperimentDAO

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

Specified by:

getLatestExperimentTaskResult in class AbstractExperimentDAO

Parameters:

experimentType - the name of the experiment type

matching - the name of the matching used

annotatorName - the name with which the annotator can be identified

datasetName - the name of the dataset

Returns:

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

getAllRunningExperimentTasks

public List<ExperimentTaskResult> getAllRunningExperimentTasks()

Description copied from interface: ExperimentDAO

Returns a list of all running experiment tasks.

Returns:

a list of all running experiment tasks.

getLatestResultsOfExperiments

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

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

Overrides:

getLatestResultsOfExperiments in class AbstractExperimentDAO

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.

getLatestResultsOfExperiments

public List<ExperimentTaskResult> getLatestResultsOfExperiments(String experimentType,
                                                                String matching,
                                                                String[] annotatorNames,
                                                                String[] datasetNames)

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.

Parameters:

experimentType - the name of the experiment type

matching - the name of the matching used

annotatorNames - the names of annotators for which the data should be collected

datasetNames - the names of datasets for which the data should be collected

Returns:

a list of the latest results available in the database.

addAdditionalResults

protected void addAdditionalResults(ExperimentTaskResult result)

insertSubTask

protected void insertSubTask(ExperimentTaskResult subTask,
                             int experimentTaskId)

addSubTaskRelation

protected void addSubTaskRelation(int taskId,
                                  int subTaskId)

addSubTasks

protected void addSubTasks(ExperimentTaskResult expTask)

getResultOfExperimentTask

public ExperimentTaskResult getResultOfExperimentTask(int experimentTaskId)

Description copied from interface: ExperimentDAO

Returns the result of the experiment task with the given ID or null if this task does not exist.

Parameters:

experimentTaskId - the id of the experiment task

Returns:

the experiment task or null if this task does not exist.

close

public void close()
           throws IOException

Throws:

IOException