org.wso2.carbon.ml.database

Interface DatabaseService

All Known Implementing Classes:

MLDatabaseService

public interface DatabaseService

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) Get all the dataset schemas of the given tenant and username.
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) Get all the dataset-versions of the given dataset schema.
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) 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) 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 datasetVersionId) Returns the number of features of a given data-set version.
List<String>	getFeatureNames(long datasetId) Get feature names of a dataset.
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 of a dataset ordered by feature index.
String	getFeatureNamesInOrderUsingDatasetVersion(long datasetVersionId, String columnSeparator) Get feature names of a dataset version ordered by feature index.
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 dataset.
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.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 summary of the model.
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) Get the summary stats of the dataset version.
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) Get the dataset-version identified by the given dataset-version 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 version-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 model error.
void	updateModelStatus(long modelId, String status) Update model 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	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.

Method Detail

getMlConfiguration

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

Returns ML Configuration.

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

Get the dataset id.

Parameters:

datasetName - Name of the data-set

tenantId - Tenant Id

userName - Tenant user name

Returns:

Unique Id of the data-set

Throws:

DatabaseHandlerException

getVersionsetId

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

Get the dataset-version id.

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

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 - Scatter plot points

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:

tenantId - Tenant id

user - Tenant user name

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

Parameters:

tenantId - ID of the tenant

userName - Tenant user name

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

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.

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 objects

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

getFeatureNames

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.

Parameters:

datasetId - Unique identifier of a dataset

featureType - Type of the feature

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:

tenantId - Tenant id

user - Tenant user name

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

getSummaryStats

String getSummaryStats(long datasetId,
                       String featureName)
                throws DatabaseHandlerException

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

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

getVersionsetSample

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

Retrieve the SamplePoints object for a given version-set.

Parameters:

tenantId - Tenant id

user - Tenant user name

versionsetId - ID of the dataset version

Returns:

SamplePoints object of the dataset version

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 dataset version

Returns:

Number of features in the dataset 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:

datasetSchemaId - Unique id of the dataset schema

datasetVersionId - Unique Id of the data-set-version

summaryStats - Summary stats

Throws:

DatabaseHandlerException

updateSamplePoints

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

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

Parameters:

datasetVersionId - Unique Id of the data-set-version

samplePoints - Sample points of this dataset version

Throws:

DatabaseHandlerException

deleteProject

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

Delete the project.

Parameters:

tenantId - ID of the tenant

userName - Username of the tenant

projectId - ID of the project

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

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 - ID of the tenant

userName - Username of the tenant

modelId - ID of the model

Returns:

Validity of the model ID

Throws:

DatabaseHandlerException

isValidModelStatus

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

Check whether the model is in a valid state.

Parameters:

modelId - ID of the model

tenantId - Tenant id

userName - Tenant user name

Returns:

Validity of the model status

Throws:

DatabaseHandlerException

getDatasetVersionIdOfModel

long getDatasetVersionIdOfModel(long modelId)
                         throws DatabaseHandlerException

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

Parameters:

modelId - ID of the model

Returns:

Dataset version ID

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:

Dataset ID

Throws:

DatabaseHandlerException

getDataTypeOfModel

String getDataTypeOfModel(long modelId)
                   throws DatabaseHandlerException

Get the data type of the model.

Parameters:

modelId - ID of the model

Returns:

Data type of the model

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:

Model configuration as a string

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:

Model configuration as a double

Throws:

DatabaseHandlerException

getABooleanModelConfiguration

boolean getABooleanModelConfiguration(long analysisId,
                                      String configKey)
                               throws DatabaseHandlerException

Get a boolean value of model configuration.

Parameters:

analysisId - unique id of the analysis

configKey - model configuration key

Returns:

Model configuration as a double

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:

List of MLHyperParameter objects

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:

String map of model hyper-parameters

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:

Workflow object

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:

MLStorage object

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:

MLProject object

Throws:

DatabaseHandlerException

getProject

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.

Parameters:

tenantId - ID of the tenant

userName - Username of the tenant

projectId - ID of the project

Returns:

MLProject object

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:

List of MLProject objects

Throws:

DatabaseHandlerException

getProjectModels

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

Get all models of a given project.

Parameters:

tenantId - tenant ID

userName - username

projectId - Project ID

Returns:

List of MLModelData objects

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:

List of MLAnalysis objects

Throws:

DatabaseHandlerException

getModel

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

MLModelData object

Throws:

DatabaseHandlerException

getModel

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

MLModelData object

Throws:

DatabaseHandlerException

getAllModels

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

Get all models of the given tenant and username.

Parameters:

tenantId - tenant id

userName - username

Returns:

List of MLModelData objects

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 - ID of the tenant

userName - Username of the tenant

datasetId - dataset schema id

Returns:

List of MLDatasetVersion objects

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 - ID of the tenant

userName - Username of the tenant

Returns:

List of MLDataset objects

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 - ID of the tenant

userName - Username of the tenant

datasetId - Dataset schema ID

Returns:

MLDataset object

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 - ID of the tenant

userName - Username of the tenant

datasetVersionId - ID of the dataset version

Returns:

MLDatasetVersion object

Throws:

DatabaseHandlerException

getVersionSetWithVersion

org.wso2.carbon.ml.commons.domain.MLDatasetVersion getVersionSetWithVersion(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 - 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

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

Throws:

DatabaseHandlerException

getAllModels

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

Get all models of a given analysis.

Parameters:

tenantId - ID of the tenant

userName - Username of the tenant

analysisId - ID of the analysis

Returns:

List of MLModelData objects

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:

ModelSummary object

Throws:

DatabaseHandlerException

updateModelStatus

void updateModelStatus(long modelId,
                       String status)
                throws DatabaseHandlerException

Update model status.

Parameters:

modelId - Unique id of the model

status - Status to be updated

Throws:

DatabaseHandlerException

getAnalysis

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

Get analysis by id.

Parameters:

tenantId - Tenant id

userName - Tenant user name

analysisId - Unique id of the analysis

Returns:

MLAnalysis object

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.

Parameters:

tenantId - Tenant id

userName - Tenant user name

projectId - Unique id of the project

analysisName - Name of the analysis

Returns:

MLAnalysis object

Throws:

DatabaseHandlerException

deleteAnalysis

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

Delete an analysis.

Parameters:

tenantId - Tenant id

userName - Tenant user name

analysisId - Unique id of the analysis

Throws:

DatabaseHandlerException

updateModelError

void updateModelError(long modelId,
                      String error)
               throws DatabaseHandlerException

Update model error.

Parameters:

modelId - Unique id of the model

error - Error value to be updated

Throws:

DatabaseHandlerException

getFeatureNamesInOrder

String getFeatureNamesInOrder(long datasetId,
                              String columnSeparator)
                       throws DatabaseHandlerException

Get feature names of a dataset ordered by feature index.

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

getFeatureNamesInOrderUsingDatasetVersion

String getFeatureNamesInOrderUsingDatasetVersion(long datasetVersionId,
                                                 String columnSeparator)
                                          throws DatabaseHandlerException

Get feature names of a dataset version ordered by feature index.

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

getSummaryStats

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

Get the summary stats of the dataset version.

Parameters:

datasetVersionId - Unique id of the dataset version

Returns:

A map of pairs

Throws:

DatabaseHandlerException

getFeatureNames

List<String> getFeatureNames(long datasetId)
                      throws DatabaseHandlerException

Get feature names of a dataset.

Parameters:

datasetId - Unique id of the dataset.

Returns:

A list of feature names

Throws:

DatabaseHandlerException

shutdown

void shutdown()
       throws DatabaseHandlerException

Executes the SHUTDOWN statement.

Throws:

DatabaseHandlerException