org.wso2.carbon.ml.database.internal

Class MLDatabaseService

java.lang.Object

org.wso2.carbon.ml.database.internal.MLDatabaseService

All Implemented Interfaces:

DatabaseService

public class MLDatabaseService
extends Object
implements DatabaseService

Constructor Summary

Constructors

Constructor and Description
MLDatabaseService()

Method Summary

Modifier and Type	Method and Description
void	deleteAnalysis(int tenantId, String userName, long analysisId) Delete an analysis.
void	deleteDataset(long datasetId) Delete the dataset schema.
void	deleteDatasetVersion(long datasetVersionId) Delete the dataset version.
void	deleteModel(int tenantId, String userName, long modelId) Delete the model from the database.
void	deleteProject(int tenantId, String userName, long projectId) Delete the project.
boolean	getABooleanModelConfiguration(long analysisId, String configKey) Get a boolean value of model configuration.
double	getADoubleModelConfiguration(long analysisId, String configKey) Get a double value of model configuration.
List<org.wso2.carbon.ml.commons.domain.MLAnalysis>	getAllAnalyses(int tenantId, String userName) Get all the analyses of the given tenant and username.
List<org.wso2.carbon.ml.commons.domain.MLAnalysis>	getAllAnalysesOfProject(int tenantId, String userName, long projectId) Get all the analyses of a project.
List<org.wso2.carbon.ml.commons.domain.MLDataset>	getAllDatasets(int tenantId, String userName) Retrieve all datasets
List<org.wso2.carbon.ml.commons.domain.MLModelData>	getAllModels(int tenantId, String userName) Get all models of the given tenant and username.
List<org.wso2.carbon.ml.commons.domain.MLModelData>	getAllModels(int tenantId, String userName, long analysisId) Get all models of a given analysis.
List<org.wso2.carbon.ml.commons.domain.MLProject>	getAllProjects(int tenantId, String userName) Get all the projects of the given tenant and username.
List<org.wso2.carbon.ml.commons.domain.MLDatasetVersion>	getAllVersionsetsOfDataset(int tenantId, String userName, long datasetId) Retrieve all versionset of a dataset
org.wso2.carbon.ml.commons.domain.MLAnalysis	getAnalysis(int tenantId, String userName, long analysisId) Get analysis by id.
org.wso2.carbon.ml.commons.domain.MLAnalysis	getAnalysisOfProject(int tenantId, String userName, long projectId, String analysisName) Returns an analysis of a given name in a given project.
String	getAStringModelConfiguration(long analysisId, String configKey) Get a string value of model configuration.
List<Object>	getChartSamplePoints(int tenantId, String user, long versionsetId, String featureListString) Returns sample data for selected features
List<org.wso2.carbon.ml.commons.domain.MLCustomizedFeature>	getCustomizedFeatures(int tenantId, String userName, long analysisId, int startIndex, int numberOfFeatures) Returns the customized set of features of an analysis in a given range, from the alphabetically ordered set of features, of a dataset.
org.wso2.carbon.ml.commons.domain.MLDataset	getDataset(int tenantId, String userName, long datasetId) Retrieve a dataset from ID
long	getDatasetId(long datasetVersionId) Retrieve the datasetID of a given version set
long	getDatasetId(String datasetName, int tenantId, String userName) Get the dataset id.
long	getDatasetSchemaIdFromAnalysisId(long analysisId) Get the dataset schema ID of a given analysis.
String	getDatasetUri(long datasetId) Retrieves the path of the value-set having the given ID, from the database.
long	getDatasetVersionIdOfModel(long modelId) Get the ID of the dataset version used to generate the model.
String	getDatasetVersionUri(long datasetVersionId) Retrieves the path of the value-set having the given ID, from the database.
String	getDataTypeOfModel(long modelId) Get the data type of the model.
int	getFeatureCount(long datasetSchemaId) Returns the number of features of a given data-set version
List<String>	getFeatureNames(long datasetId) Get feature names of a given dataset using the dataset ID
List<String>	getFeatureNames(long datasetId, String featureType) Returns the names of the features, belongs to a particular type (Categorical/Numerical), of a dataset.
List<String>	getFeatureNames(String analysisId) Returns all the feature names of an analysis.
List<String>	getFeatureNames(String analysisId, String featureType) Returns the names of the features, belongs to a particular type (Categorical/Numerical), of the analysis.
String	getFeatureNamesInOrder(long datasetId, String columnSeparator) Get feature names in order and separated by the given column separator.
String	getFeatureNamesInOrderUsingDatasetVersion(long datasetVersionId, String columnSeparator) Get feature names in order and separated by the given column separator.
List<org.wso2.carbon.ml.commons.domain.FeatureSummary>	getFeatures(int tenantId, String userName, long analysisId, int startIndex, int numberOfFeatures) Returns a set of features in a given range, from the alphabetically ordered set of features, of a data-set.
List<org.wso2.carbon.ml.commons.domain.MLHyperParameter>	getHyperParametersOfModel(long analysisId, String algorithmName) Get the list of Hyper-parameters of the model.
Map<String,String>	getHyperParametersOfModelAsMap(long analysisId) Get the Hyper-parameters of the model as a Map.
org.wso2.carbon.ml.commons.domain.config.MLConfiguration	getMlConfiguration() Returns ML Configuration.
org.wso2.carbon.ml.commons.domain.MLModelData	getModel(int tenantId, String userName, long modelId) Get the model name identified by the given model id.
org.wso2.carbon.ml.commons.domain.MLModelData	getModel(int tenantId, String userName, String modelName) Get the Model having the given model name.
org.wso2.carbon.ml.commons.domain.MLStorage	getModelStorage(long modelId) Get the Model storage of the model.
org.wso2.carbon.ml.commons.domain.ModelSummary	getModelSummary(long modelId) Retrieve the model summary
org.wso2.carbon.ml.commons.domain.MLProject	getProject(int tenantId, String userName, long projectId) Returns project object for a given project ID from the database.
org.wso2.carbon.ml.commons.domain.MLProject	getProject(int tenantId, String userName, String projectName) Get the project having the given project name.
List<org.wso2.carbon.ml.commons.domain.MLModelData>	getProjectModels(int tenantId, String userName, long projectId) Get all models of a given project
List<Object>	getScatterPlotPoints(org.wso2.carbon.ml.commons.domain.ScatterPlotPoints scatterPlotPoints) Returns data points of the selected sample as coordinates of three features, needed for the scatter plot.
String	getSummaryStats(int tenantId, String user, long analysisId, String featureName) Retrieve and returns the Summary statistics for a given feature of a given data-set version, from the database.
Map<String,String>	getSummaryStats(long datasetVersionId) Retrieve and returns the Summary statistics for a given feature of a given data-set version, from the database.
String	getSummaryStats(long datasetId, String featureName) Retrieve and returns summary statistics for a given feature of a given dataset
org.wso2.carbon.ml.commons.domain.MLDatasetVersion	getVersionset(int tenantId, String userName, long datasetVersionId) Retrieve a Versionset from its ID
long	getVersionsetId(String datasetVersionName, int tenantId, String userName) Get the dataset-version id.
org.wso2.carbon.ml.commons.domain.SamplePoints	getVersionsetSample(int tenantId, String user, long versionsetId) Retrieve the SamplePoints object for a given value-set.
org.wso2.carbon.ml.commons.domain.MLDatasetVersion	getVersionSetWithVersion(long datasetId, String version, int tenantId, String userName) Get the unique identifier of the dataset version given the dataset schema and the version.
org.wso2.carbon.ml.commons.domain.Workflow	getWorkflow(long analysisId) Get the workflow of the analysis.
void	insertAnalysis(org.wso2.carbon.ml.commons.domain.MLAnalysis analysis) Insert a new analysis into the database.
void	insertDatasetSchema(org.wso2.carbon.ml.commons.domain.MLDataset dataset) Insert a new dataset-schema into the database.
void	insertDatasetVersion(org.wso2.carbon.ml.commons.domain.MLDatasetVersion datasetVersion) Insert a new dataset-version into the database.
void	insertDefaultsIntoFeatureCustomized(long analysisId, org.wso2.carbon.ml.commons.domain.MLCustomizedFeature customizedValues) Insert the default feature attributes into the relevant customized feature attributes of a given analysis.
void	insertFeatureCustomized(long analysisId, List<org.wso2.carbon.ml.commons.domain.MLCustomizedFeature> customizedFeatures, int tenantId, String userName) Insert a list of Customized-Features into the database.
void	insertHyperParameters(long analysisId, List<org.wso2.carbon.ml.commons.domain.MLHyperParameter> hyperParameters, String algorithmName) Insert a list of HyperParameters into the database.
void	insertModel(org.wso2.carbon.ml.commons.domain.MLModelData model) Insert a new model into the database.
void	insertModelConfigurations(long analysisId, List<org.wso2.carbon.ml.commons.domain.MLModelConfiguration> modelConfigs) Insert a list of ModelConfiguration into the database.
void	insertProject(org.wso2.carbon.ml.commons.domain.MLProject project) Insert a new project to the database.
boolean	isValidModelId(int tenantId, String userName, long modelId) Check whether the given modelId is valid.
boolean	isValidModelStatus(long modelId, int tenantId, String userName) Check whether the model is in a valid state.
void	shutdown() Executes the SHUTDOWN statement.
void	updateModelError(long modelId, String error) Update the model storage
void	updateModelStatus(long modelId, String status) Update the model status
void	updateModelStorage(long modelId, String storageType, String location) Update the model storage
void	updateModelSummary(long modelId, org.wso2.carbon.ml.commons.domain.ModelSummary modelSummary) Update the model summary
void	updateSamplePoints(long datasetVersionId, org.wso2.carbon.ml.commons.domain.SamplePoints samplePoints) Update the database with the sample points of data-set-version.
void	updateSummaryStatistics(long datasetSchemaId, long datasetVersionId, org.wso2.carbon.ml.commons.domain.SummaryStats summaryStats) Update the database with the summary stats of data-set-version.

Methods inherited from class java.lang.Object

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

Constructor Detail

MLDatabaseService

public MLDatabaseService()

Method Detail

getMlConfiguration

public org.wso2.carbon.ml.commons.domain.config.MLConfiguration getMlConfiguration()

Description copied from interface: DatabaseService

Returns ML Configuration.

Specified by:

getMlConfiguration in interface DatabaseService

insertDatasetSchema

public void insertDatasetSchema(org.wso2.carbon.ml.commons.domain.MLDataset dataset)
                         throws DatabaseHandlerException

Description copied from interface: DatabaseService

Insert a new dataset-schema into the database.

Specified by:

insertDatasetSchema in interface DatabaseService

Parameters:

dataset - MLDataset to be inserted

Throws:

DatabaseHandlerException

insertDatasetVersion

public void insertDatasetVersion(org.wso2.carbon.ml.commons.domain.MLDatasetVersion datasetVersion)
                          throws DatabaseHandlerException

Description copied from interface: DatabaseService

Insert a new dataset-version into the database.

Specified by:

insertDatasetVersion in interface DatabaseService

Parameters:

datasetVersion - MLDatasetVersion to be inserted

Throws:

DatabaseHandlerException

insertProject

public void insertProject(org.wso2.carbon.ml.commons.domain.MLProject project)
                   throws DatabaseHandlerException

Description copied from interface: DatabaseService

Insert a new project to the database.

Specified by:

insertProject in interface DatabaseService

Parameters:

project - MLProject to be inserted

Throws:

DatabaseHandlerException

insertAnalysis

public void insertAnalysis(org.wso2.carbon.ml.commons.domain.MLAnalysis analysis)
                    throws DatabaseHandlerException

Description copied from interface: DatabaseService

Insert a new analysis into the database.

Specified by:

insertAnalysis in interface DatabaseService

Parameters:

analysis - MLAnalysis to be inserted

Throws:

DatabaseHandlerException

insertModel

public void insertModel(org.wso2.carbon.ml.commons.domain.MLModelData model)
                 throws DatabaseHandlerException

Description copied from interface: DatabaseService

Insert a new model into the database.

Specified by:

insertModel in interface DatabaseService

Parameters:

model - MLModelNew to be inserted

Throws:

DatabaseHandlerException

getDatasetVersionUri

public String getDatasetVersionUri(long datasetVersionId)
                            throws DatabaseHandlerException

Retrieves the path of the value-set having the given ID, from the database.

Specified by:

getDatasetVersionUri in interface DatabaseService

Parameters:

datasetVersionId - Unique Identifier of the value-set

Returns:

Absolute path of a given value-set

Throws:

DatabaseHandlerException

getDatasetUri

public String getDatasetUri(long datasetId)
                     throws DatabaseHandlerException

Retrieves the path of the value-set having the given ID, from the database.

Specified by:

getDatasetUri in interface DatabaseService

Parameters:

datasetId - Unique Identifier of the value-set

Returns:

Absolute path of a given value-set

Throws:

DatabaseHandlerException

getDatasetId

public long getDatasetId(String datasetName,
                         int tenantId,
                         String userName)
                  throws DatabaseHandlerException

Description copied from interface: DatabaseService

Get the dataset id.

Specified by:

getDatasetId in interface DatabaseService

Parameters:

datasetName - Name of the data-set

tenantId - Tenant Id

userName - Tenant user name

Returns:

Unique Id of the data-set

Throws:

DatabaseHandlerException

getVersionSetWithVersion

public org.wso2.carbon.ml.commons.domain.MLDatasetVersion getVersionSetWithVersion(long datasetId,
                                                                                   String version,
                                                                                   int tenantId,
                                                                                   String userName)
                                                                            throws DatabaseHandlerException

Description copied from interface: DatabaseService

Get the unique identifier of the dataset version given the dataset schema and the version.

Specified by:

getVersionSetWithVersion in interface DatabaseService

Parameters:

datasetId - ID of the dataset

version - Version of the dataset version

tenantId - ID of the tenant

userName - Username of the tenant

Returns:

MLDatasetVersion object

Throws:

DatabaseHandlerException

getVersionsetId

public long getVersionsetId(String datasetVersionName,
                            int tenantId,
                            String userName)
                     throws DatabaseHandlerException

Description copied from interface: DatabaseService

Get the dataset-version id.

Specified by:

getVersionsetId in interface DatabaseService

Parameters:

datasetVersionName - Name of the dataset version

tenantId - ID of the tenant

userName - Username of the tenant

Returns:

ID of the dataset version

Throws:

DatabaseHandlerException

getDatasetVersionIdOfModel

public long getDatasetVersionIdOfModel(long modelId)
                                throws DatabaseHandlerException

Description copied from interface: DatabaseService

Get the ID of the dataset version used to generate the model.

Specified by:

getDatasetVersionIdOfModel in interface DatabaseService

Parameters:

modelId - ID of the model

Returns:

Dataset version ID

Throws:

DatabaseHandlerException

getAllVersionsetsOfDataset

public List<org.wso2.carbon.ml.commons.domain.MLDatasetVersion> getAllVersionsetsOfDataset(int tenantId,
                                                                                           String userName,
                                                                                           long datasetId)
                                                                                    throws DatabaseHandlerException

Retrieve all versionset of a dataset

Specified by:

getAllVersionsetsOfDataset in interface DatabaseService

Parameters:

tenantId - ID of the tenant

userName - Username of the tenant

datasetId - dataset schema id

Returns:

List of MLDatasetVersion objects

Throws:

DatabaseHandlerException

getVersionset

public org.wso2.carbon.ml.commons.domain.MLDatasetVersion getVersionset(int tenantId,
                                                                        String userName,
                                                                        long datasetVersionId)
                                                                 throws DatabaseHandlerException

Retrieve a Versionset from its ID

Specified by:

getVersionset in interface DatabaseService

Parameters:

tenantId - ID of the tenant

userName - Username of the tenant

datasetVersionId - ID of the dataset version

Returns:

MLDatasetVersion object

Throws:

DatabaseHandlerException

getAllDatasets

public List<org.wso2.carbon.ml.commons.domain.MLDataset> getAllDatasets(int tenantId,
                                                                        String userName)
                                                                 throws DatabaseHandlerException

Retrieve all datasets

Specified by:

getAllDatasets in interface DatabaseService

Parameters:

tenantId - ID of the tenant

userName - Username of the tenant

Returns:

List of MLDataset objects

Throws:

DatabaseHandlerException

getDataset

public org.wso2.carbon.ml.commons.domain.MLDataset getDataset(int tenantId,
                                                              String userName,
                                                              long datasetId)
                                                       throws DatabaseHandlerException

Retrieve a dataset from ID

Specified by:

getDataset in interface DatabaseService

Parameters:

tenantId - ID of the tenant

userName - Username of the tenant

datasetId - Dataset schema ID

Returns:

MLDataset object

Throws:

DatabaseHandlerException

getDatasetId

public long getDatasetId(long datasetVersionId)
                  throws DatabaseHandlerException

Retrieve the datasetID of a given version set

Specified by:

getDatasetId in interface DatabaseService

Parameters:

datasetVersionId - Unique ID of the dataset version

Returns:

Dataset ID

Throws:

DatabaseHandlerException

getDataTypeOfModel

public String getDataTypeOfModel(long modelId)
                          throws DatabaseHandlerException

Description copied from interface: DatabaseService

Get the data type of the model.

Specified by:

getDataTypeOfModel in interface DatabaseService

Parameters:

modelId - ID of the model

Returns:

Data type of the model

Throws:

DatabaseHandlerException

updateModelSummary

public void updateModelSummary(long modelId,
                               org.wso2.carbon.ml.commons.domain.ModelSummary modelSummary)
                        throws DatabaseHandlerException

Update the model summary

Specified by:

updateModelSummary in interface DatabaseService

Parameters:

modelId - model id

modelSummary - ModelSummary

Throws:

DatabaseHandlerException

getModelSummary

public org.wso2.carbon.ml.commons.domain.ModelSummary getModelSummary(long modelId)
                                                               throws DatabaseHandlerException

Retrieve the model summary

Specified by:

getModelSummary in interface DatabaseService

Parameters:

modelId - ID of the model

Returns:

ModelSummary object

Throws:

DatabaseHandlerException

updateModelStorage

public void updateModelStorage(long modelId,
                               String storageType,
                               String location)
                        throws DatabaseHandlerException

Update the model storage

Specified by:

updateModelStorage in interface DatabaseService

Parameters:

modelId - Model Id

storageType - Storage type

location - Storage location

Throws:

DatabaseHandlerException

updateModelStatus

public void updateModelStatus(long modelId,
                              String status)
                       throws DatabaseHandlerException

Update the model status

Specified by:

updateModelStatus in interface DatabaseService

Parameters:

modelId - Unique id of the model

status - Status to be updated

Throws:

DatabaseHandlerException

updateModelError

public void updateModelError(long modelId,
                             String error)
                      throws DatabaseHandlerException

Update the model storage

Specified by:

updateModelError in interface DatabaseService

Parameters:

modelId - Unique id of the model

error - Error value to be updated

Throws:

DatabaseHandlerException

getScatterPlotPoints

public List<Object> getScatterPlotPoints(org.wso2.carbon.ml.commons.domain.ScatterPlotPoints scatterPlotPoints)
                                  throws DatabaseHandlerException

Returns data points of the selected sample as coordinates of three features, needed for the scatter plot.

Specified by:

getScatterPlotPoints in interface DatabaseService

Parameters:

scatterPlotPoints - Scatter plot points

Returns:

A JSON array of data points

Throws:

DatabaseHandlerException

getChartSamplePoints

public List<Object> getChartSamplePoints(int tenantId,
                                         String user,
                                         long versionsetId,
                                         String featureListString)
                                  throws DatabaseHandlerException

Returns sample data for selected features

Specified by:

getChartSamplePoints in interface DatabaseService

Parameters:

versionsetId - Unique Identifier of the value-set

featureListString - String containing feature name list

tenantId - Tenant id

user - Tenant user name

Returns:

A JSON array of data points

Throws:

DatabaseHandlerException

getVersionsetSample

public org.wso2.carbon.ml.commons.domain.SamplePoints getVersionsetSample(int tenantId,
                                                                          String user,
                                                                          long versionsetId)
                                                                   throws DatabaseHandlerException

Retrieve the SamplePoints object for a given value-set.

Specified by:

getVersionsetSample in interface DatabaseService

Parameters:

tenantId - Tenant id

user - Tenant user name

versionsetId - Unique Identifier of the dataset version

Returns:

SamplePoints object of the value-set

Throws:

DatabaseHandlerException

getFeatures

public List<org.wso2.carbon.ml.commons.domain.FeatureSummary> getFeatures(int tenantId,
                                                                          String userName,
                                                                          long analysisId,
                                                                          int startIndex,
                                                                          int numberOfFeatures)
                                                                   throws DatabaseHandlerException

Returns a set of features in a given range, from the alphabetically ordered set of features, of a data-set.

Specified by:

getFeatures in interface DatabaseService

Parameters:

tenantId - Tenant id

userName - Tenant user name

analysisId - Unique id of the analysis

startIndex - Starting index of the set of features needed

numberOfFeatures - Number of features needed, from the starting index

Returns:

A list of Feature objects

Throws:

DatabaseHandlerException

getCustomizedFeatures

public List<org.wso2.carbon.ml.commons.domain.MLCustomizedFeature> getCustomizedFeatures(int tenantId,
                                                                                         String userName,
                                                                                         long analysisId,
                                                                                         int startIndex,
                                                                                         int numberOfFeatures)
                                                                                  throws DatabaseHandlerException

Returns the customized set of features of an analysis in a given range, from the alphabetically ordered set of features, of a dataset.

Specified by:

getCustomizedFeatures in interface DatabaseService

Parameters:

tenantId - ID of the tenant

userName - Username of the tenant

analysisId - Unique ID of the analysis

startIndex - Starting index of the set of features needed

numberOfFeatures - Number of features needed, from the starting index

Returns:

A list of feature configuration objects

Throws:

DatabaseHandlerException

getFeatureNamesInOrderUsingDatasetVersion

public String getFeatureNamesInOrderUsingDatasetVersion(long datasetVersionId,
                                                        String columnSeparator)
                                                 throws DatabaseHandlerException

Get feature names in order and separated by the given column separator.

Specified by:

getFeatureNamesInOrderUsingDatasetVersion in interface DatabaseService

Parameters:

datasetVersionId - Unique id of the dataset version

columnSeparator - Column separator (CSV or TSV)

Returns:

A string containing the list of feature names separated by the given column separator

Throws:

DatabaseHandlerException

getFeatureNamesInOrder

public String getFeatureNamesInOrder(long datasetId,
                                     String columnSeparator)
                              throws DatabaseHandlerException

Get feature names in order and separated by the given column separator.

Specified by:

getFeatureNamesInOrder in interface DatabaseService

Parameters:

datasetId - Unique id of dataset

columnSeparator - Column separator (CSV or TSV)

Returns:

A string containing the list of feature names separated by the given column separator

Throws:

DatabaseHandlerException

getFeatureNames

public List<String> getFeatureNames(long datasetId)
                             throws DatabaseHandlerException

Get feature names of a given dataset using the dataset ID

Specified by:

getFeatureNames in interface DatabaseService

Parameters:

datasetId - Unique id of the dataset.

Returns:

A list of feature names

Throws:

DatabaseHandlerException

getFeatureNames

public List<String> getFeatureNames(String analysisId,
                                    String featureType)
                             throws DatabaseHandlerException

Returns the names of the features, belongs to a particular type (Categorical/Numerical), of the analysis.

Specified by:

getFeatureNames in interface DatabaseService

Parameters:

analysisId - Unique identifier of the current analysis

featureType - Type of the feature

Returns:

A list of feature names

Throws:

DatabaseHandlerException

getFeatureNames

public List<String> getFeatureNames(String analysisId)
                             throws DatabaseHandlerException

Returns all the feature names of an analysis.

Specified by:

getFeatureNames in interface DatabaseService

Parameters:

analysisId - Unique identifier of the current analysis

Returns:

A list of feature names

Throws:

DatabaseHandlerException

getFeatureNames

public List<String> getFeatureNames(long datasetId,
                                    String featureType)
                             throws DatabaseHandlerException

Returns the names of the features, belongs to a particular type (Categorical/Numerical), of a dataset.

Specified by:

getFeatureNames in interface DatabaseService

Parameters:

datasetId - Unique identifier of a dataset

featureType - Type of the feature

Returns:

A list of feature names

Throws:

DatabaseHandlerException

getSummaryStats

public String getSummaryStats(int tenantId,
                              String user,
                              long analysisId,
                              String featureName)
                       throws DatabaseHandlerException

Retrieve and returns the Summary statistics for a given feature of a given data-set version, from the database.

Specified by:

getSummaryStats in interface DatabaseService

Parameters:

tenantId - Tenant id

user - Tenant user name

analysisId - Unique identifier of the analysis

featureName - Name of the feature of which summary statistics are needed

Returns:

JSON string containing the summary statistics

Throws:

DatabaseHandlerException

getSummaryStats

public Map<String,String> getSummaryStats(long datasetVersionId)
                                   throws DatabaseHandlerException

Retrieve and returns the Summary statistics for a given feature of a given data-set version, from the database.

Specified by:

getSummaryStats in interface DatabaseService

Parameters:

datasetVersionId - Unique identifier of the data-set version

Returns:

Map; key - feature name : value - stats

Throws:

DatabaseHandlerException

getSummaryStats

public String getSummaryStats(long datasetId,
                              String featureName)
                       throws DatabaseHandlerException

Retrieve and returns summary statistics for a given feature of a given dataset

Specified by:

getSummaryStats in interface DatabaseService

Parameters:

datasetId - Unique identifier of a dataset

featureName - Name of the feature of which summary statistics are needed

Returns:

JSON string containing summary statistics

Throws:

DatabaseHandlerException

getFeatureCount

public int getFeatureCount(long datasetSchemaId)
                    throws DatabaseHandlerException

Returns the number of features of a given data-set version

Specified by:

getFeatureCount in interface DatabaseService

Parameters:

datasetSchemaId - Unique identifier of the data-set version

Returns:

Number of features in the data-set version

Throws:

DatabaseHandlerException

getProject

public org.wso2.carbon.ml.commons.domain.MLProject getProject(int tenantId,
                                                              String userName,
                                                              String projectName)
                                                       throws DatabaseHandlerException

Description copied from interface: DatabaseService

Get the project having the given project name.

Specified by:

getProject in interface DatabaseService

Parameters:

tenantId - tenant id

userName - username

projectName - project name

Returns:

MLProject object

Throws:

DatabaseHandlerException

getProject

public org.wso2.carbon.ml.commons.domain.MLProject getProject(int tenantId,
                                                              String userName,
                                                              long projectId)
                                                       throws DatabaseHandlerException

Returns project object for a given project ID from the database.

Specified by:

getProject in interface DatabaseService

Parameters:

tenantId - ID of the tenant

userName - Username of the tenant

projectId - ID of the project

Returns:

MLProject object

Throws:

DatabaseHandlerException

getAllProjects

public List<org.wso2.carbon.ml.commons.domain.MLProject> getAllProjects(int tenantId,
                                                                        String userName)
                                                                 throws DatabaseHandlerException

Description copied from interface: DatabaseService

Get all the projects of the given tenant and username.

Specified by:

getAllProjects in interface DatabaseService

Parameters:

tenantId - tenant id

userName - username

Returns:

List of MLProject objects

Throws:

DatabaseHandlerException

getProjectModels

public List<org.wso2.carbon.ml.commons.domain.MLModelData> getProjectModels(int tenantId,
                                                                            String userName,
                                                                            long projectId)
                                                                     throws DatabaseHandlerException

Get all models of a given project

Specified by:

getProjectModels in interface DatabaseService

Parameters:

tenantId - tenant ID

userName - username

projectId - Project ID

Returns:

List of MLModelData objects

Throws:

DatabaseHandlerException

deleteProject

public void deleteProject(int tenantId,
                          String userName,
                          long projectId)
                   throws DatabaseHandlerException

Description copied from interface: DatabaseService

Delete the project.

Specified by:

deleteProject in interface DatabaseService

Parameters:

tenantId - ID of the tenant

userName - Username of the tenant

projectId - ID of the project

Throws:

DatabaseHandlerException

deleteModel

public void deleteModel(int tenantId,
                        String userName,
                        long modelId)
                 throws DatabaseHandlerException

Description copied from interface: DatabaseService

Delete the model from the database.

Specified by:

deleteModel in interface DatabaseService

Parameters:

tenantId - tenant id

userName - username

modelId - model id

Throws:

DatabaseHandlerException

getAnalysis

public org.wso2.carbon.ml.commons.domain.MLAnalysis getAnalysis(int tenantId,
                                                                String userName,
                                                                long analysisId)
                                                         throws DatabaseHandlerException

Description copied from interface: DatabaseService

Get analysis by id.

Specified by:

getAnalysis in interface DatabaseService

Parameters:

tenantId - Tenant id

userName - Tenant user name

analysisId - Unique id of the analysis

Returns:

MLAnalysis object

Throws:

DatabaseHandlerException

getAllAnalyses

public List<org.wso2.carbon.ml.commons.domain.MLAnalysis> getAllAnalyses(int tenantId,
                                                                         String userName)
                                                                  throws DatabaseHandlerException

Description copied from interface: DatabaseService

Get all the analyses of the given tenant and username.

Specified by:

getAllAnalyses in interface DatabaseService

Parameters:

tenantId - tenant id

userName - username

Returns:

List of MLAnalysis objects

Throws:

DatabaseHandlerException

getAllAnalysesOfProject

public List<org.wso2.carbon.ml.commons.domain.MLAnalysis> getAllAnalysesOfProject(int tenantId,
                                                                                  String userName,
                                                                                  long projectId)
                                                                           throws DatabaseHandlerException

Description copied from interface: DatabaseService

Get all the analyses of a project.

Specified by:

getAllAnalysesOfProject in interface DatabaseService

Parameters:

tenantId - tenant id

userName - user name

projectId - project id

Returns:

List of MLAnalysis objects

Throws:

DatabaseHandlerException

getModel

public org.wso2.carbon.ml.commons.domain.MLModelData getModel(int tenantId,
                                                              String userName,
                                                              String modelName)
                                                       throws DatabaseHandlerException

Description copied from interface: DatabaseService

Get the Model having the given model name.

Specified by:

getModel in interface DatabaseService

Parameters:

tenantId - tenant id

userName - username

modelName - model name

Returns:

MLModelData object

Throws:

DatabaseHandlerException

getModel

public org.wso2.carbon.ml.commons.domain.MLModelData getModel(int tenantId,
                                                              String userName,
                                                              long modelId)
                                                       throws DatabaseHandlerException

Description copied from interface: DatabaseService

Get the model name identified by the given model id.

Specified by:

getModel in interface DatabaseService

Parameters:

tenantId - tenant id

userName - username

modelId - model id

Returns:

MLModelData object

Throws:

DatabaseHandlerException

getAllModels

public List<org.wso2.carbon.ml.commons.domain.MLModelData> getAllModels(int tenantId,
                                                                        String userName,
                                                                        long analysisId)
                                                                 throws DatabaseHandlerException

Description copied from interface: DatabaseService

Get all models of a given analysis.

Specified by:

getAllModels in interface DatabaseService

Parameters:

tenantId - ID of the tenant

userName - Username of the tenant

analysisId - ID of the analysis

Returns:

List of MLModelData objects

Throws:

DatabaseHandlerException

getAllModels

public List<org.wso2.carbon.ml.commons.domain.MLModelData> getAllModels(int tenantId,
                                                                        String userName)
                                                                 throws DatabaseHandlerException

Description copied from interface: DatabaseService

Get all models of the given tenant and username.

Specified by:

getAllModels in interface DatabaseService

Parameters:

tenantId - tenant id

userName - username

Returns:

List of MLModelData objects

Throws:

DatabaseHandlerException

getModelStorage

public org.wso2.carbon.ml.commons.domain.MLStorage getModelStorage(long modelId)
                                                            throws DatabaseHandlerException

Description copied from interface: DatabaseService

Get the Model storage of the model.

Specified by:

getModelStorage in interface DatabaseService

Parameters:

modelId - unique id of the model

Returns:

MLStorage object

Throws:

DatabaseHandlerException

isValidModelId

public boolean isValidModelId(int tenantId,
                              String userName,
                              long modelId)
                       throws DatabaseHandlerException

Description copied from interface: DatabaseService

Check whether the given modelId is valid.

Specified by:

isValidModelId in interface DatabaseService

Parameters:

tenantId - ID of the tenant

userName - Username of the tenant

modelId - ID of the model

Returns:

Validity of the model ID

Throws:

DatabaseHandlerException

deleteAnalysis

public void deleteAnalysis(int tenantId,
                           String userName,
                           long analysisId)
                    throws DatabaseHandlerException

Description copied from interface: DatabaseService

Delete an analysis.

Specified by:

deleteAnalysis in interface DatabaseService

Parameters:

tenantId - Tenant id

userName - Tenant user name

analysisId - Unique id of the analysis

Throws:

DatabaseHandlerException

insertModelConfigurations

public void insertModelConfigurations(long analysisId,
                                      List<org.wso2.carbon.ml.commons.domain.MLModelConfiguration> modelConfigs)
                               throws DatabaseHandlerException

Description copied from interface: DatabaseService

Insert a list of ModelConfiguration into the database.

Specified by:

insertModelConfigurations in interface DatabaseService

Parameters:

analysisId - Analysis ID

modelConfigs - MLModelConfiguration list

Throws:

DatabaseHandlerException

insertHyperParameters

public void insertHyperParameters(long analysisId,
                                  List<org.wso2.carbon.ml.commons.domain.MLHyperParameter> hyperParameters,
                                  String algorithmName)
                           throws DatabaseHandlerException

Description copied from interface: DatabaseService

Insert a list of HyperParameters into the database.

Specified by:

insertHyperParameters in interface DatabaseService

Parameters:

analysisId - Analysis ID

hyperParameters - MLHyperParameter list

algorithmName - Algorithm name

Throws:

DatabaseHandlerException

getHyperParametersOfModel

public List<org.wso2.carbon.ml.commons.domain.MLHyperParameter> getHyperParametersOfModel(long analysisId,
                                                                                          String algorithmName)
                                                                                   throws DatabaseHandlerException

Description copied from interface: DatabaseService

Get the list of Hyper-parameters of the model.

Specified by:

getHyperParametersOfModel in interface DatabaseService

Parameters:

analysisId - Unique ID of the analysis

algorithmName - Algorithm name

Returns:

List of MLHyperParameter objects

Throws:

DatabaseHandlerException

getHyperParametersOfModelAsMap

public Map<String,String> getHyperParametersOfModelAsMap(long analysisId)
                                                  throws DatabaseHandlerException

Description copied from interface: DatabaseService

Get the Hyper-parameters of the model as a Map.

Specified by:

getHyperParametersOfModelAsMap in interface DatabaseService

Parameters:

analysisId - unique id of the model

Returns:

String map of model hyper-parameters

Throws:

DatabaseHandlerException

getDatasetSchemaIdFromAnalysisId

public long getDatasetSchemaIdFromAnalysisId(long analysisId)
                                      throws DatabaseHandlerException

Description copied from interface: DatabaseService

Get the dataset schema ID of a given analysis.

Specified by:

getDatasetSchemaIdFromAnalysisId in interface DatabaseService

Parameters:

analysisId - ID of the analysis

Returns:

ID of the dataset schema

Throws:

DatabaseHandlerException

insertDefaultsIntoFeatureCustomized

public void insertDefaultsIntoFeatureCustomized(long analysisId,
                                                org.wso2.carbon.ml.commons.domain.MLCustomizedFeature customizedValues)
                                         throws DatabaseHandlerException

Description copied from interface: DatabaseService

Insert the default feature attributes into the relevant customized feature attributes of a given analysis.

Specified by:

insertDefaultsIntoFeatureCustomized in interface DatabaseService

Parameters:

analysisId - ID of the analysis

customizedValues - customized feature

Throws:

DatabaseHandlerException

insertFeatureCustomized

public void insertFeatureCustomized(long analysisId,
                                    List<org.wso2.carbon.ml.commons.domain.MLCustomizedFeature> customizedFeatures,
                                    int tenantId,
                                    String userName)
                             throws DatabaseHandlerException

Description copied from interface: DatabaseService

Insert a list of Customized-Features into the database.

Specified by:

insertFeatureCustomized in interface DatabaseService

Parameters:

analysisId - Analysis Id

customizedFeatures - MLCustomizedFeature list

tenantId - Tenant Id

userName - Username

Throws:

DatabaseHandlerException

updateSummaryStatistics

public void updateSummaryStatistics(long datasetSchemaId,
                                    long datasetVersionId,
                                    org.wso2.carbon.ml.commons.domain.SummaryStats summaryStats)
                             throws DatabaseHandlerException

Description copied from interface: DatabaseService

Update the database with the summary stats of data-set-version.

Specified by:

updateSummaryStatistics in interface DatabaseService

Parameters:

datasetSchemaId - Unique id of the dataset schema

datasetVersionId - Unique Id of the data-set-version

summaryStats - Summary stats

Throws:

DatabaseHandlerException

getWorkflow

public org.wso2.carbon.ml.commons.domain.Workflow getWorkflow(long analysisId)
                                                       throws DatabaseHandlerException

Description copied from interface: DatabaseService

Get the workflow of the analysis.

Specified by:

getWorkflow in interface DatabaseService

Parameters:

analysisId - unique id of the analysis

Returns:

Workflow object

Throws:

DatabaseHandlerException

getAStringModelConfiguration

public String getAStringModelConfiguration(long analysisId,
                                           String configKey)
                                    throws DatabaseHandlerException

Description copied from interface: DatabaseService

Get a string value of model configuration.

Specified by:

getAStringModelConfiguration in interface DatabaseService

Parameters:

analysisId - Unique ID of the analysis

configKey - Model configuration key

Returns:

Model configuration as a string

Throws:

DatabaseHandlerException

getADoubleModelConfiguration

public double getADoubleModelConfiguration(long analysisId,
                                           String configKey)
                                    throws DatabaseHandlerException

Description copied from interface: DatabaseService

Get a double value of model configuration.

Specified by:

getADoubleModelConfiguration in interface DatabaseService

Parameters:

analysisId - unique id of the analysis

configKey - model configuration key

Returns:

Model configuration as a double

Throws:

DatabaseHandlerException

getABooleanModelConfiguration

public boolean getABooleanModelConfiguration(long analysisId,
                                             String configKey)
                                      throws DatabaseHandlerException

Description copied from interface: DatabaseService

Get a boolean value of model configuration.

Specified by:

getABooleanModelConfiguration in interface DatabaseService

Parameters:

analysisId - unique id of the analysis

configKey - model configuration key

Returns:

Model configuration as a double

Throws:

DatabaseHandlerException

deleteDataset

public void deleteDataset(long datasetId)
                   throws DatabaseHandlerException

Description copied from interface: DatabaseService

Delete the dataset schema.

Specified by:

deleteDataset in interface DatabaseService

Parameters:

datasetId - unique id of dataset schema

Throws:

DatabaseHandlerException

deleteDatasetVersion

public void deleteDatasetVersion(long datasetVersionId)
                          throws DatabaseHandlerException

Description copied from interface: DatabaseService

Delete the dataset version.

Specified by:

deleteDatasetVersion in interface DatabaseService

Parameters:

datasetVersionId - unique id of dataset version

Throws:

DatabaseHandlerException

getAnalysisOfProject

public org.wso2.carbon.ml.commons.domain.MLAnalysis getAnalysisOfProject(int tenantId,
                                                                         String userName,
                                                                         long projectId,
                                                                         String analysisName)
                                                                  throws DatabaseHandlerException

Description copied from interface: DatabaseService

Returns an analysis of a given name in a given project.

Specified by:

getAnalysisOfProject in interface DatabaseService

Parameters:

tenantId - Tenant id

userName - Tenant user name

projectId - Unique id of the project

analysisName - Name of the analysis

Returns:

MLAnalysis object

Throws:

DatabaseHandlerException

updateSamplePoints

public void updateSamplePoints(long datasetVersionId,
                               org.wso2.carbon.ml.commons.domain.SamplePoints samplePoints)
                        throws DatabaseHandlerException

Description copied from interface: DatabaseService

Update the database with the sample points of data-set-version.

Specified by:

updateSamplePoints in interface DatabaseService

Parameters:

datasetVersionId - Unique Id of the data-set-version

samplePoints - Sample points of this dataset version

Throws:

DatabaseHandlerException

isValidModelStatus

public boolean isValidModelStatus(long modelId,
                                  int tenantId,
                                  String userName)
                           throws DatabaseHandlerException

Description copied from interface: DatabaseService

Check whether the model is in a valid state.

Specified by:

isValidModelStatus in interface DatabaseService

Parameters:

modelId - ID of the model

tenantId - Tenant id

userName - Tenant user name

Returns:

Validity of the model status

Throws:

DatabaseHandlerException

shutdown

public void shutdown()
              throws DatabaseHandlerException

Description copied from interface: DatabaseService

Executes the SHUTDOWN statement.

Specified by:

shutdown in interface DatabaseService

Throws:

DatabaseHandlerException