org.wso2.carbon.ml.database

Interface DatabaseService

All Known Implementing Classes:

MLDatabaseService

public interface DatabaseService

Method Summary

Methods

Modifier and Type	Method and Description
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) Get all the dataset schemas of the given tenant and username
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) Get all the dataset-versions of the given dataset schema
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) Get the dataset schema identified by the given dataset schema id
long	getDatasetId(long datasetVersionId) Get the dataset-schema id of the dataset-version
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 retures default features available in a given dataset version
int	getFeatureCount(long datasetVersionId) Returns the number of features of a given data-set version
List<String>	getFeatureNames(long modelId) Returns the names of the features, belongs to a particular data-type (Categorical/Numerical), of the work-flow.
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)
String	getFeatureNamesInOrderUsingDatasetVersion(long datasetVersionId, String columnSeparator)
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 modelId) 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)
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 summary of the model
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) Get the dataset-version identified by the given dataset-version 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	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)
void	updateModelStatus(long modelId, String status)
void	updateModelStorage(long modelId, String storageType, String location) Update the storage details of a model
void	updateModelSummary(long modelId, org.wso2.carbon.ml.commons.domain.ModelSummary modelSummary) Update the model summary of a given model
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 value-set table with a data-set sample.

Method Detail

insertDatasetSchema

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

Insert a new dataset-schema into the database

Parameters:

dataset - MLDataset to be inserted

Throws:

DatabaseHandlerException

insertDatasetVersion

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

Insert a new dataset-version into the database

Parameters:

datasetVersion - MLDatasetVersion to be inserted

Throws:

DatabaseHandlerException

insertProject

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

Insert a new project to the database

Parameters:

project - MLProject to be inserted

Throws:

DatabaseHandlerException

insertAnalysis

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

Insert a new analysis into the database

Parameters:

analysis - MLAnalysis to be inserted

Throws:

DatabaseHandlerException

insertModel

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

Insert a new model into the database

Parameters:

model - MLModelNew to be inserted

Throws:

DatabaseHandlerException

getDatasetVersionUri

String getDatasetVersionUri(long datasetVersionId)
                            throws DatabaseHandlerException

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

Parameters:

datasetVersionId - Unique Identifier of the dataset-version

Returns:

Absolute path of a given dataset-version

Throws:

DatabaseHandlerException

getDatasetUri

String getDatasetUri(long datasetId)
                     throws DatabaseHandlerException

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

Parameters:

datasetId - Unique Identifier of the dataset

Returns:

Absolute path of a given dataset

Throws:

DatabaseHandlerException

getDatasetId

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

Parameters:

datasetName - Name of the data-set

tenantId - Tenant Id

Returns:

Unique Id of the data-set

Throws:

DatabaseHandlerException

getVersionsetId

long getVersionsetId(String datasetVersionName,
                   int tenantId)
                     throws DatabaseHandlerException

Get the dataset-version id

Parameters:

datasetVersionName - name of the dataset-version

tenantId - tenant id

Returns:

Throws:

DatabaseHandlerException

isDatasetNameExist

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

Check whether the given database name exists in the given tenantId

Parameters:

tenantId - tenant Id

datasetName - name of the data-set

Returns:

true if the name exists

Throws:

DatabaseHandlerException

isDatasetVersionExist

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

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

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

long getDatasetVersionId(long datasetId,
                       String datasetVersion)
                         throws DatabaseHandlerException

Parameters:

datasetId -

datasetVersion -

Returns:

Throws:

DatabaseHandlerException

updateVersionsetSample

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

Update the value-set table with a data-set sample.

Parameters:

datasetVesionId - Unique Identifier of the value-set

valueSetSample - SamplePoints object of the value-set

Throws:

DatabaseHandlerException

getScatterPlotPoints

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.

Parameters:

scatterPlotPoints - TODO

Returns:

A JSON array of data points

Throws:

DatabaseHandlerException

getChartSamplePoints

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

Returns sample data for selected features

Parameters:

versionsetId - Unique Identifier of the value-set

featureListString - String containing feature name list

Returns:

A JSON array of data points

Throws:

DatabaseHandlerException

getFeatures

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.

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

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

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

Parameters:

datasetVersionId - The dataset varsion id associated with this dataset version

Returns:

A list of FeatureSummaries

Throws:

DatabaseHandlerException

getFeatureNames

List<String> getFeatureNames(long modelId)
                             throws DatabaseHandlerException

Returns the names of the features, belongs to a particular data-type (Categorical/Numerical), of the work-flow.

Parameters:

modelId - Unique identifier of the current model

Returns:

A list of feature names

Throws:

DatabaseHandlerException

getFeatureNames

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.

Parameters:

analysisId - Unique identifier of the current analysis

featureType - Type of the feature

Returns:

A list of feature names

Throws:

DatabaseHandlerException

getFeatureNames

List<String> getFeatureNames(String analysisId)
                             throws DatabaseHandlerException

Returns all the feature names of an analysis.

Parameters:

analysisId - Unique identifier of the current analysis

Returns:

A list of feature names

Throws:

DatabaseHandlerException

getSummaryStats

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

Parameters:

analysisId - Unique identifier of the data-set

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

Returns:

JSON string containing the summary statistics

Throws:

DatabaseHandlerException

getFeatureCount

int getFeatureCount(long datasetVersionId)
                    throws DatabaseHandlerException

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

Parameters:

datasetVersionId - Unique identifier of the data-set version

Returns:

Number of features in the data-set version

Throws:

DatabaseHandlerException

updateSummaryStatistics

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

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

Parameters:

datasetVersionId - Unique Id of the data-set-version

summaryStats - Summary stats

Throws:

DatabaseHandlerException

getFeatureType

String getFeatureType(long modelId,
                    String featureName)
                      throws DatabaseHandlerException

Retrieves the type of a feature.

Parameters:

modelId - Unique identifier of the model

featureName - Name of the feature

Returns:

Type of the feature (Categorical/Numerical)

Throws:

DatabaseHandlerException

updateFeatureInclusion

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

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

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

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

Update the impute method option of a given feature.

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

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

Update the data type of a given feature.

Parameters:

featureName - Name of the feature to be updated

modelId - Unique identifier of the current model

featureType - Updated type of the feature

Throws:

DatabaseHandlerException

getProjectId

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

Get the unique Id of the project

Parameters:

tenantId - tenant Id

userName - username of the project

projectName - name of the project

Returns:

Throws:

DatabaseHandlerException

deleteProject

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

Delete the project

Parameters:

tenantId -

userName -

projectName -

Throws:

DatabaseHandlerException

getAnalysisId

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

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

Parameters:

tenantId -

userName -

analysisName -

Returns:

Throws:

DatabaseHandlerException

getModelId

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

Get the Id of the model

Parameters:

tenantId - Tenant Id

userName - Username

modelName - Model name

Returns:

Throws:

DatabaseHandlerException

deleteAnalysis

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

Delete the analysis

Parameters:

tenantId -

userName -

analysisName -

Throws:

DatabaseHandlerException

insertFeatureCustomized

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

Insert a list of Customized-Features into the database

Parameters:

analysisId - Analysis Id

customizedFeatures - MLCustomizedFeature list

tenantId - Tenant Id

userName - Username

Throws:

DatabaseHandlerException

insertModelConfigurations

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

Insert a list of ModelConfiguration into the database

Parameters:

analysisId - Analysis Id

modelConfigs - MLModelConfiguration list

Throws:

DatabaseHandlerException

insertHyperParameters

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

Insert a list of HyperParameters into the database

Parameters:

analysisId - Analysis Id

hyperParameters - MLHyperParameter list

algorithmName - Algorithm name

Throws:

DatabaseHandlerException

getModelConfigurationValue

String getModelConfigurationValue(long modelId,
                                String name)
                                  throws DatabaseHandlerException

Parameters:

modelId -

name -

Returns:

Throws:

DatabaseHandlerException

updateModelSummary

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

Update the model summary of a given model

Parameters:

modelId - model id

modelSummary - ModelSummary

Throws:

DatabaseHandlerException

updateModelStorage

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

Update the storage details of a model

Parameters:

modelId - Model Id

storageType - Storage type

location - Storage location

Throws:

DatabaseHandlerException

isValidModelId

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

Check whether the given modelId is valid

Parameters:

tenantId -

userName -

modelId -

Returns:

Throws:

DatabaseHandlerException

insertFeatureCustomized

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

Insert cutomized feature to the database

Parameters:

analysisId - analysis id

customizedFeature - customized feature

Throws:

DatabaseHandlerException

getDatasetVersionIdOfModel

long getDatasetVersionIdOfModel(long modelId)
                                throws DatabaseHandlerException

Get the id of the dataset-version used to generate the model

Parameters:

modelId - unique id of the model

Returns:

Throws:

DatabaseHandlerException

insertDataSource

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

Insert data source to the database

Parameters:

datasetVersionId - unique id of the dataset-version

tenantId - tenant id

username - username

key - key

value - value

Throws:

DatabaseHandlerException

getDatasetId

long getDatasetId(long datasetVersionId)
                  throws DatabaseHandlerException

Get the dataset-schema id of the dataset-version

Parameters:

datasetVersionId - unique id of the dataset version

Returns:

Throws:

DatabaseHandlerException

getDataTypeOfModel

String getDataTypeOfModel(long modelId)
                          throws DatabaseHandlerException

Get the data type of the model

Parameters:

modelId - unique id of the model

Returns:

Throws:

DatabaseHandlerException

getAStringModelConfiguration

String getAStringModelConfiguration(long analysisId,
                                  String configKey)
                                    throws DatabaseHandlerException

Get a string value of model configuration

Parameters:

analysisId - unique id of the analysis

configKey - model configuration key

Returns:

Throws:

DatabaseHandlerException

getADoubleModelConfiguration

double getADoubleModelConfiguration(long analysisId,
                                  String configKey)
                                    throws DatabaseHandlerException

Get a double value of model configuration

Parameters:

analysisId - unique id of the analysis

configKey - model configuration key

Returns:

Throws:

DatabaseHandlerException

getHyperParametersOfModel

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

Get the list of Hyper-parameters of the model

Parameters:

analysisId - Unique ID of the analysis

algorithmName - Algorithm name

Returns:

Throws:

DatabaseHandlerException

getHyperParametersOfModelAsMap

Map<String,String> getHyperParametersOfModelAsMap(long modelId)
                                                  throws DatabaseHandlerException

Get the Hyper-parameters of the model as a Map

Parameters:

modelId - unique id of the model

Returns:

Throws:

DatabaseHandlerException

getWorkflow

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

Get the workflow of the analysis

Parameters:

analysisId - unique id of the analysis

Returns:

Throws:

DatabaseHandlerException

getModelStorage

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

Get the Model storage of the model

Parameters:

modelId - unique id of the model

Returns:

Throws:

DatabaseHandlerException

getProject

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

Get the project having the given project name

Parameters:

tenantId - tenant id

userName - username

projectName - project name

Returns:

Throws:

DatabaseHandlerException

getAllProjects

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

Get all the projects of the given tenant and username

Parameters:

tenantId - tenant id

userName - username

Returns:

Throws:

DatabaseHandlerException

getAnalysis

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

Get the Analysis having the given analysis name

Parameters:

tenantId - tenant id

userName - username

analysisName - analysis name

Returns:

Throws:

DatabaseHandlerException

getAllAnalyses

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

Get all the analyses of the given tenant and username

Parameters:

tenantId - tenant id

userName - username

Returns:

Throws:

DatabaseHandlerException

getModel

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

Get the Model having the given model name

Parameters:

tenantId - tenant id

userName - username

modelName - model name

Returns:

Throws:

DatabaseHandlerException

getModel

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

Get the model name identified by the given model id

Parameters:

tenantId - tenant id

userName - username

modelId - model id

Returns:

Throws:

DatabaseHandlerException

getAllModels

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

Get all models of the given tenant and username

Parameters:

tenantId - tenant id

userName - username

Returns:

Throws:

DatabaseHandlerException

getAllVersionsetsOfDataset

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

Get all the dataset-versions of the given dataset schema

Parameters:

tenantId - tenant id

userName - username

datasetId - dataset schema id

Returns:

Throws:

DatabaseHandlerException

getAllDatasets

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

Get all the dataset schemas of the given tenant and username

Parameters:

tenantId - tenant id

userName - username

Returns:

Throws:

DatabaseHandlerException

getDataset

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

Get the dataset schema identified by the given dataset schema id

Parameters:

tenantId - tenant id

userName - username

datasetId - dataset schema id

Returns:

Throws:

DatabaseHandlerException

getVersionset

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

Get the dataset-version identified by the given dataset-version id

Parameters:

tenantId - tenant id

userName - username

datasetVersionId - dataset-version id

Returns:

Throws:

DatabaseHandlerException

getDatasetVersionId

long getDatasetVersionId(long datasetId,
                       String version,
                       int tenantId,
                       String userName)
                         throws DatabaseHandlerException

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

Parameters:

datasetId - dataset schema id

version - version

tenantId - tenant id

userName - username

Returns:

Throws:

DatabaseHandlerException

insertDefaultsIntoFeatureCustomized

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

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

Parameters:

analysisId - unique id of the analysis

customizedValues - customized feature

Throws:

DatabaseHandlerException

getDatasetSchemaIdFromAnalysisId

long getDatasetSchemaIdFromAnalysisId(long analysisId)
                                      throws DatabaseHandlerException

Get the dataset schema id of a given analysis

Parameters:

analysisId - Unique id of the analysis

Returns:

ID of the dataset schema

Throws:

DatabaseHandlerException

deleteModel

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

Delete the model from the database

Parameters:

tenantId - tenant id

userName - username

modelId - model id

Throws:

DatabaseHandlerException

getAllAnalysesOfProject

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

Get all the analyses of a project.

Parameters:

tenantId - tenant id

userName - user name

projectId - project id

Returns:

list of MLAnalysis

Throws:

DatabaseHandlerException

getAllModels

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

Get all models of a given analysis

Parameters:

tenantId -

userName -

analysisId -

Returns:

list of models

Throws:

DatabaseHandlerException

getModelSummary

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

Retrieve summary of the model

Parameters:

modelId - ID of the model

Returns:

Model Summary

Throws:

DatabaseHandlerException

updateModelStatus

void updateModelStatus(long modelId,
                     String status)
                       throws DatabaseHandlerException

Throws:

DatabaseHandlerException

getAnalysis

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

Throws:

DatabaseHandlerException

deleteDataset

void deleteDataset(long datasetId)
                   throws DatabaseHandlerException

Delete the dataset schema

Parameters:

datasetId - unique id of dataset schema

Throws:

DatabaseHandlerException

deleteDatasetVersion

void deleteDatasetVersion(long datasetVersionId)
                          throws DatabaseHandlerException

Delete the dataset version

Parameters:

datasetVersionId - unique id of dataset version

Throws:

DatabaseHandlerException

getAnalysisOfProject

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

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

Throws:

DatabaseHandlerException

deleteAnalysis

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

Throws:

DatabaseHandlerException

updateModelError

void updateModelError(long modelId,
                    String error)
                      throws DatabaseHandlerException

Throws:

DatabaseHandlerException

getFeatureNamesInOrder

String getFeatureNamesInOrder(long datasetId,
                            String columnSeparator)
                              throws DatabaseHandlerException

Throws:

DatabaseHandlerException

getFeatureNamesInOrderUsingDatasetVersion

String getFeatureNamesInOrderUsingDatasetVersion(long datasetVersionId,
                                               String columnSeparator)
                                                 throws DatabaseHandlerException

Throws:

DatabaseHandlerException