org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers

Class SchemaTypeHandler

java.lang.Object

org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers.RootHandler

org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers.SchemaTypeHandler

public class SchemaTypeHandler
extends RootHandler

SchemaTypeHandler manages SchemaType objects. It runs server-side in the OMAG Server Platform and retrieves SchemaType entities through the OMRSRepositoryConnector.

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers.RootHandler

invalidParameterHandler, repositoryHandler, repositoryHelper, serverName, serviceName

Constructor Summary

Constructors

Constructor and Description
SchemaTypeHandler(String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper) Construct the handler information needed to interact with the repository services

Method Summary

Modifier and Type	Method and Description
String	addExternalSchemaAttribute(String userId, SchemaAttribute schemaAttribute, String externalSourceGUID, String externalSourceName) Deprecated.
String	addExternalSchemaType(String userId, SchemaType schemaType, String externalSourceGUID, String externalSourceName) Add the schema type from an external source to the repository along with any schema types embedded within it.
ComplexSchemaType	getEmptyComplexSchemaType(String schemaTypeGUID, String schemaTypeName) Return the requested schemaType with the specific type information filled in.
SchemaAttribute	getEmptyTabularColumn() Return a schema attribute object with the type set up.
SchemaAttributeBuilder	getSchemaAttributeBuilder(SchemaAttribute schemaAttribute) Return the appropriate schemaAttribute builder for the supplied schema attribute bean.
String	updateSchemaAttribute(String userId, String existingSchemaAttributeGUID, SchemaAttribute schemaAttribute) Deprecated.
String	updateSchemaType(String userId, String existingSchemaTypeGUID, SchemaType schemaType) Deprecated.

Methods inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers.RootHandler

getRepositoryHelper, getServiceName

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaTypeHandler

public SchemaTypeHandler(String serviceName,
                         String serverName,
                         InvalidParameterHandler invalidParameterHandler,
                         RepositoryHandler repositoryHandler,
                         OMRSRepositoryHelper repositoryHelper)

Construct the handler information needed to interact with the repository services

Parameters:

serviceName - name of this service

serverName - name of the local server

invalidParameterHandler - handler for managing parameter errors

repositoryHandler - manages calls to the repository services

repositoryHelper - provides utilities for manipulating the repository services objects

Method Detail

getEmptyComplexSchemaType

public ComplexSchemaType getEmptyComplexSchemaType(String schemaTypeGUID,
                                                   String schemaTypeName)

Return the requested schemaType with the specific type information filled in. There is no validation of the type name and the bean is assumed to be for the local cohort.

Parameters:

schemaTypeGUID - unique identifier of the required type

schemaTypeName - unique name of the required type

Returns:

new object

getEmptyTabularColumn

public SchemaAttribute getEmptyTabularColumn()

Return a schema attribute object with the type set up. This is for columns that are created in the local cohort only.

Returns:

new object

addExternalSchemaAttribute

@Deprecated
public String addExternalSchemaAttribute(String userId,
                                                     SchemaAttribute schemaAttribute,
                                                     String externalSourceGUID,
                                                     String externalSourceName)
                                              throws InvalidParameterException,
                                                     PropertyServerException,
                                                     UserNotAuthorizedException

Deprecated.

Add the schema type from an external source to the repository. This call is deprecated because it is no longer necessary. Change caller to use addSchemaAttribute and delete this method when no longer used.

Parameters:

userId - calling userId

schemaAttribute - object to add

externalSourceGUID - unique identifier(guid) for the external source.

externalSourceName - unique name for the external source.

Returns:

unique identifier of the schemaAttribute in the repository.

Throws:

InvalidParameterException - the schemaAttribute bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

updateSchemaAttribute

@Deprecated
public String updateSchemaAttribute(String userId,
                                                String existingSchemaAttributeGUID,
                                                SchemaAttribute schemaAttribute)
                                         throws InvalidParameterException,
                                                PropertyServerException,
                                                UserNotAuthorizedException

Deprecated.

Update a stored schema attribute. This method is deprecated because the provenance information is not available.

Parameters:

userId - userId

existingSchemaAttributeGUID - unique identifier of the existing schemaAttribute entity

schemaAttribute - new schemaAttribute values

Returns:

unique identifier of the schemaAttribute in the repository.

Throws:

InvalidParameterException - the schemaAttribute bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getSchemaAttributeBuilder

public SchemaAttributeBuilder getSchemaAttributeBuilder(SchemaAttribute schemaAttribute)

Return the appropriate schemaAttribute builder for the supplied schema attribute bean.

Parameters:

schemaAttribute - object with properties

Returns:

builder object.

addExternalSchemaType

public String addExternalSchemaType(String userId,
                                    SchemaType schemaType,
                                    String externalSourceGUID,
                                    String externalSourceName)
                             throws InvalidParameterException,
                                    PropertyServerException,
                                    UserNotAuthorizedException

Add the schema type from an external source to the repository along with any schema types embedded within it.

Parameters:

userId - calling userId

schemaType - object to add

externalSourceGUID - unique identifier(guid) for the external source

externalSourceName - unique name for the external source

Returns:

unique identifier of the schemaType in the repository.

Throws:

InvalidParameterException - the schemaType bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

updateSchemaType

@Deprecated
public String updateSchemaType(String userId,
                                           String existingSchemaTypeGUID,
                                           SchemaType schemaType)
                                    throws InvalidParameterException,
                                           PropertyServerException,
                                           UserNotAuthorizedException

Deprecated.

Update a stored schemaType. This method is deprecated because it does not pass provenance information - assuming local cohort provenance.

Parameters:

userId - userId

existingSchemaTypeGUID - unique identifier of the existing schemaType entity

schemaType - new schemaType values

Returns:

GUID of existing schema type

Throws:

InvalidParameterException - the schemaType bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server