org.odpi.openmetadata.accessservices.analyticsmodeling.server

Class AnalyticsModelingRestServices

java.lang.Object

org.odpi.openmetadata.accessservices.analyticsmodeling.server.AnalyticsModelingRestServices

public class AnalyticsModelingRestServices
extends Object

Server-side implementation of the Analytics Modeling OMAS interface for modeling.

Constructor Summary

Constructors

Constructor and Description
AnalyticsModelingRestServices()

Method Summary

Modifier and Type	Method and Description
AnalyticsModelingOMASAPIResponse	getDatabases(String serverName, String userId, Integer startFrom, Integer pageSize) Get databases available on the server for the user.
RESTExceptionHandler	getExceptionHandler()
AnalyticsModelingInstanceHandler	getHandler()
InvalidParameterHandler	getInvalidParameterHandler()
AnalyticsModelingOMASAPIResponse	getModule(String serverName, String userId, String databaseGuid, String catalog, String schema) Build module for the schema.
AnalyticsModelingOMASAPIResponse	getSchemas(String serverName, String userId, String databaseGuid, Integer startFrom, Integer pageSize) Get schema defined by database GUID.
AnalyticsModelingOMASAPIResponse	getTables(String serverName, String userId, String databaseGuid, String schema) Get tables for the schema.
void	validateUrlParameters(String serverName, String userId, String guid, String guidParamName, Integer startFrom, Integer pageSize, String methodName) Validate path and query parameters from URL.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnalyticsModelingRestServices

public AnalyticsModelingRestServices()

Method Detail

getExceptionHandler

public RESTExceptionHandler getExceptionHandler()

getHandler

public AnalyticsModelingInstanceHandler getHandler()

getInvalidParameterHandler

public InvalidParameterHandler getInvalidParameterHandler()

getDatabases

public AnalyticsModelingOMASAPIResponse getDatabases(String serverName,
                                                     String userId,
                                                     Integer startFrom,
                                                     Integer pageSize)

Get databases available on the server for the user.

Parameters:

serverName - of the server.

userId - of the user.

startFrom - starting element (used in paging through large result sets)

pageSize - maximum number of results to return

Returns:

list of databases for the requested server/user.

getSchemas

public AnalyticsModelingOMASAPIResponse getSchemas(String serverName,
                                                   String userId,
                                                   String databaseGuid,
                                                   Integer startFrom,
                                                   Integer pageSize)

Get schema defined by database GUID.

Parameters:

serverName - of the request.

userId - of the request.

databaseGuid - of the requested database.

startFrom - starting element (used in paging through large result sets)

pageSize - maximum number of results to return

Returns:

list of schemas for the requested database.

getTables

public AnalyticsModelingOMASAPIResponse getTables(String serverName,
                                                  String userId,
                                                  String databaseGuid,
                                                  String schema)

Get tables for the schema.

Parameters:

serverName - of the request.

userId - of the request.

databaseGuid - of the requested database.

schema - schema name on the database.

Returns:

list of tables for the requested schema.

getModule

public AnalyticsModelingOMASAPIResponse getModule(String serverName,
                                                  String userId,
                                                  String databaseGuid,
                                                  String catalog,
                                                  String schema)

Build module for the schema.

Parameters:

serverName - of the request.

userId - of the request.

databaseGuid - of the requested database.

catalog - catalog name of the database.

schema - schema name of the database.

Returns:

module for the requested schema.

validateUrlParameters

public void validateUrlParameters(String serverName,
                                  String userId,
                                  String guid,
                                  String guidParamName,
                                  Integer startFrom,
                                  Integer pageSize,
                                  String methodName)
                           throws InvalidParameterException

Validate path and query parameters from URL.

Parameters:

serverName - mandatory path parameter of the base URL.

userId - mandatory path parameter of the base URL.

guid - optional path parameter.

guidParamName - name of GUID parameter in URL.

startFrom - optional query parameter.

pageSize - optional query parameter.

methodName - for message.

Throws:

InvalidParameterException - if validation failed. To validate guid the guidParamName must not be null.