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

Methods

Modifier and Type	Method and Description
void	addTenantToProject(int tenantID, String projectID) Assign a tenant to a given project.
void	deleteAnalysis(int tenantId, String userName, long analysisId)
void	deleteAnalysis(int tenantId, String userName, String analysisName) Delete the 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, String projectName) Delete the project
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.MLModelNew>	getAllModels(int tenantId, String userName) Get all models of the given tenant and username
List<org.wso2.carbon.ml.commons.domain.MLModelNew>	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)
org.wso2.carbon.ml.commons.domain.MLAnalysis	getAnalysis(int tenantId, String userName, String analysisName) Get the Analysis having the given analysis name
long	getAnalysisId(int tenantId, String userName, String analysisName) Get the analysis Id of a given tenant id, username, analysis combination
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
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)
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	getDatasetVersionId(long datasetId, String datasetVersion)
long	getDatasetVersionId(long datasetId, String version, int tenantId, String userName) Get the unique identifier of the dataset version given the dataset schema and the version
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
List<org.wso2.carbon.ml.commons.domain.FeatureSummary>	getDefaultFeatures(long datasetVersionId, int startIndex, int numberOfFeatures) This method extracts and returns default features available in a given dataset version
int	getFeatureCount(long datasetSchemaId) Returns the number of features of a given data-set version
List<String>	getFeatureNames(long modelId) Returns the names of the features of the model
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.
String	getFeatureType(long modelId, String featureName) Retrieves the type of a feature.
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.MLModelNew	getModel(int tenantId, String userName, long modelId) Get the model name identified by the given model id
org.wso2.carbon.ml.commons.domain.MLModelNew	getModel(int tenantId, String userName, String modelName) Get the Model having the given model name
String	getModelConfigurationValue(long modelId, String name) retrieve a model configuration
long	getModelId(int tenantId, String userName, String modelName) Get the Id of the model
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, String projectName) Get the project having the given project name
long	getProjectId(int tenantId, String userName, String projectName) Get the unique Id of the 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.
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) Get the dataset-version id
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	insertDatasetDetails(String name, int tenantID, String username, String comments, String sourceType, String targetType, String dataType)
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	insertDataSource(long datasetVersionId, int tenantId, String username, String key, String value) Insert data source to 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	insertFeatureCustomized(long analysisId, org.wso2.carbon.ml.commons.domain.MLCustomizedFeature customizedFeature) Insert cutomized feature to 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.MLModelNew 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	isDatasetNameExist(int tenantId, String userName, String datasetName) Check whether the given database name exists in the given tenantId
boolean	isDatasetVersionExist(int tenantId, String datasetName, String datasetVersion) Check whether the given database version exists for the given data-set name and tenant ID
boolean	isValidModelId(int tenantId, String userName, long modelId) Check whether the given modelId is valid
void	updateDataType(String featureName, long modelId, String featureType) Update the data type of a given feature.
void	updateFeatureInclusion(String featureName, long modelId, boolean isInput) Change whether a feature should be included as an input or not.
void	updateImputeOption(String featureName, long modelId, String imputeOption) Update the impute method option of a given feature.
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	updateSummaryStatistics(long datasetSchemaId, long datasetVersionId, org.wso2.carbon.ml.commons.domain.SummaryStats summaryStats) Update the database with the summary stats of data-set-version
void	updateVersionsetSample(long datasetVesionId, org.wso2.carbon.ml.commons.domain.SamplePoints valueSetSample) Update the dataset version table with a sample points

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

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.MLModelNew 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

insertDatasetDetails

public void insertDatasetDetails(String name,
                        int tenantID,
                        String username,
                        String comments,
                        String sourceType,
                        String targetType,
                        String dataType)
                          throws DatabaseHandlerException

Parameters:

name -

tenantID -

username -

comments -

sourceType -

targetType -

dataType -

Throws:

DatabaseHandlerException

getDatasetId

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

Specified by:

getDatasetId in interface DatabaseService

Parameters:

datasetName - Name of the data-set

tenantId - Tenant Id

Returns:

Unique Id of the data-set

Throws:

DatabaseHandlerException

getDatasetVersionId

public long getDatasetVersionId(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:

getDatasetVersionId in interface DatabaseService

Parameters:

datasetId - dataset schema id

version - version

tenantId - tenant id

userName - username

Returns:

Throws:

DatabaseHandlerException

getVersionsetId

public long getVersionsetId(String datasetVersionName,
                   int tenantId)
                     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 - tenant id

Returns:

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 - unique id of the model

Returns:

Throws:

DatabaseHandlerException

insertDataSource

public void insertDataSource(long datasetVersionId,
                    int tenantId,
                    String username,
                    String key,
                    String value)
                      throws DatabaseHandlerException

Description copied from interface: DatabaseService

Insert data source to the database

Specified by:

insertDataSource in interface DatabaseService

Parameters:

datasetVersionId - unique id of the dataset-version

tenantId - tenant id

username - username

key - key

value - value

Throws:

DatabaseHandlerException

isDatasetNameExist

public boolean isDatasetNameExist(int tenantId,
                         String userName,
                         String datasetName)
                           throws DatabaseHandlerException

Description copied from interface: DatabaseService

Check whether the given database name exists in the given tenantId

Specified by:

isDatasetNameExist in interface DatabaseService

Parameters:

tenantId - tenant Id

datasetName - name of the data-set

Returns:

true if the name exists

Throws:

DatabaseHandlerException

isDatasetVersionExist

public boolean isDatasetVersionExist(int tenantId,
                            String datasetName,
                            String datasetVersion)
                              throws DatabaseHandlerException

Description copied from interface: DatabaseService

Check whether the given database version exists for the given data-set name and tenant ID

Specified by:

isDatasetVersionExist in interface DatabaseService

Parameters:

tenantId - tenantId

datasetName - name of the data-set

datasetVersion - version of the data-set

Returns:

true if the version of the data-set exists

Throws:

DatabaseHandlerException

getDatasetVersionId

public long getDatasetVersionId(long datasetId,
                       String datasetVersion)
                         throws DatabaseHandlerException

Specified by:

getDatasetVersionId in interface DatabaseService

Returns:

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 - tenant id

userName - username

datasetId - dataset schema id

Returns:

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 - tenant id

userName - username

datasetVersionId - dataset-version id

Returns:

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 - tenant id

userName - username

Returns:

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 - tenant id

userName - username

datasetId - dataset schema id

Returns:

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:

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 - unique id of the model

Returns:

Throws:

DatabaseHandlerException

updateVersionsetSample

public void updateVersionsetSample(long datasetVesionId,
                          org.wso2.carbon.ml.commons.domain.SamplePoints valueSetSample)
                            throws DatabaseHandlerException

Update the dataset version table with a sample points

Specified by:

updateVersionsetSample in interface DatabaseService

Parameters:

datasetVesionId - Unique Identifier of the dataset-version

valueSetSample - SamplePoints object of the dataset-version

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:

Model Summary

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

Throws:

DatabaseHandlerException

updateModelError

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

Update the model storage

Specified by:

updateModelError in interface DatabaseService

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 - TODO

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

Returns:

A JSON array of data points

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:

datasetID - Unique Identifier of the data-set

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

getDefaultFeatures

public List<org.wso2.carbon.ml.commons.domain.FeatureSummary> getDefaultFeatures(long datasetVersionId,
                                                                        int startIndex,
                                                                        int numberOfFeatures)
                                                                          throws DatabaseHandlerException

This method extracts and returns default features available in a given dataset version

Specified by:

getDefaultFeatures in interface DatabaseService

Parameters:

datasetVersionId - The dataset version id

Returns:

A list of FeatureSummary

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

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

Throws:

DatabaseHandlerException

getFeatureNames

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

Returns the names of the features of the model

Specified by:

getFeatureNames in interface DatabaseService

Parameters:

modelId - Unique identifier of the current model

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

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:

datasetVersionId - Unique identifier of the data-set version

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

Returns:

JSON string containing the 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

getProjectId

public long getProjectId(int tenantId,
                String userName,
                String projectName)
                  throws DatabaseHandlerException

Description copied from interface: DatabaseService

Get the unique Id of the project

Specified by:

getProjectId in interface DatabaseService

Parameters:

tenantId - tenant Id

userName - username of the project

projectName - name of the project

Returns:

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:

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:

Throws:

DatabaseHandlerException

deleteProject

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

Description copied from interface: DatabaseService

Delete the project

Specified by:

deleteProject in interface DatabaseService

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

getAnalysisId

public long getAnalysisId(int tenantId,
                 String userName,
                 String analysisName)
                   throws DatabaseHandlerException

Description copied from interface: DatabaseService

Get the analysis Id of a given tenant id, username, analysis combination

Specified by:

getAnalysisId in interface DatabaseService

Returns:

Throws:

DatabaseHandlerException

getAnalysis

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

Description copied from interface: DatabaseService

Get the Analysis having the given analysis name

Specified by:

getAnalysis in interface DatabaseService

Parameters:

tenantId - tenant id

userName - username

analysisName - analysis name

Returns:

Throws:

DatabaseHandlerException

getAnalysis

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

Specified by:

getAnalysis in interface DatabaseService

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:

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

Throws:

DatabaseHandlerException

getModelId

public long getModelId(int tenantId,
              String userName,
              String modelName)
                throws DatabaseHandlerException

Description copied from interface: DatabaseService

Get the Id of the model

Specified by:

getModelId in interface DatabaseService

Parameters:

tenantId - Tenant Id

userName - Username

modelName - Model name

Returns:

Throws:

DatabaseHandlerException

getModel

public org.wso2.carbon.ml.commons.domain.MLModelNew 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:

Throws:

DatabaseHandlerException

getModel

public org.wso2.carbon.ml.commons.domain.MLModelNew 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:

Throws:

DatabaseHandlerException

getAllModels

public List<org.wso2.carbon.ml.commons.domain.MLModelNew> 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

Returns:

list of models

Throws:

DatabaseHandlerException

getAllModels

public List<org.wso2.carbon.ml.commons.domain.MLModelNew> 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:

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:

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

Returns:

Throws:

DatabaseHandlerException

deleteAnalysis

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

Description copied from interface: DatabaseService

Delete the analysis

Specified by:

deleteAnalysis in interface DatabaseService

Throws:

DatabaseHandlerException

deleteAnalysis

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

Specified by:

deleteAnalysis in interface DatabaseService

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

getModelConfigurationValue

public String getModelConfigurationValue(long modelId,
                                String name)
                                  throws DatabaseHandlerException

retrieve a model configuration

Specified by:

getModelConfigurationValue in interface DatabaseService

Parameters:

modelId - Unique identifier of the current model

name - config name

Returns:

config value

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:

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:

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 - Unique 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 - unique 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

insertFeatureCustomized

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

Description copied from interface: DatabaseService

Insert cutomized feature to the database

Specified by:

insertFeatureCustomized in interface DatabaseService

Parameters:

analysisId - analysis id

customizedFeature - customized feature

Throws:

DatabaseHandlerException

addTenantToProject

public void addTenantToProject(int tenantID,
                      String projectID)
                        throws DatabaseHandlerException

Assign a tenant to a given project.

Parameters:

tenantID - Unique identifier for the current tenant.

projectID - Unique identifier for the project.

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

datasetVersionId - Unique Id of the data-set-version

summaryStats - Summary stats

Throws:

DatabaseHandlerException

getFeatureType

public String getFeatureType(long modelId,
                    String featureName)
                      throws DatabaseHandlerException

Retrieves the type of a feature.

Specified by:

getFeatureType in interface DatabaseService

Parameters:

modelId - Unique identifier of the model

featureName - Name of the feature

Returns:

Type of the feature (Categorical/Numerical)

Throws:

DatabaseHandlerException

updateFeatureInclusion

public void updateFeatureInclusion(String featureName,
                          long modelId,
                          boolean isInput)
                            throws DatabaseHandlerException

Change whether a feature should be included as an input or not.

Specified by:

updateFeatureInclusion in interface DatabaseService

Parameters:

featureName - Name of the feature to be updated

modelId - Unique identifier of the current model

isInput - Boolean value indicating whether the feature is an input or not

Throws:

DatabaseHandlerException

updateImputeOption

public void updateImputeOption(String featureName,
                      long modelId,
                      String imputeOption)
                        throws DatabaseHandlerException

Update the impute method option of a given feature.

Specified by:

updateImputeOption in interface DatabaseService

Parameters:

featureName - Name of the feature to be updated

modelId - Unique identifier of the current model

imputeOption - Updated impute option of the feature

Throws:

DatabaseHandlerException

updateDataType

public void updateDataType(String featureName,
                  long modelId,
                  String featureType)
                    throws DatabaseHandlerException

Update the data type of a given feature.

Specified by:

updateDataType in interface DatabaseService

Parameters:

featureName - Name of the feature to be updated

modelId - Unique identifier of the current model

featureType - Updated type of the feature

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:

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:

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:

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

Throws:

DatabaseHandlerException