org.odpi.openmetadata.integrationservices.catalog.connector

Class SchemaExchangeService

java.lang.Object

org.odpi.openmetadata.integrationservices.catalog.connector.SchemaExchangeService

Direct Known Subclasses:

DataAssetExchangeService, LineageExchangeService

public class SchemaExchangeService
extends Object

LineageExchangeService is the context for managing process definitions and lineage linkage.

Method Summary

Modifier and Type	Method and Description
void	clearColumnAsPrimaryKey(String schemaAttributeGUID, String schemaAttributeExternalIdentifier) Remove the primary key designation from the schema attribute.
void	clearForeignKeyRelationship(String primaryKeyGUID, String foreignKeyGUID) Remove the foreign key relationship between two schema elements.
void	clearSchemaElementAsCalculatedValue(String schemaElementGUID, String schemaElementExternalIdentifier) Remove the calculated value designation from the schema element.
void	clearSchemaTypeParent(String schemaTypeGUID, String parentElementGUID, String parentElementTypeName) Remove the relationship between a schema type and its parent data asset, process or port.
String	createSchemaAttribute(boolean assetManagerIsHome, String schemaElementGUID, String schemaAttributeExternalIdentifier, String schemaAttributeExternalIdentifierName, String schemaAttributeExternalIdentifierUsage, KeyPattern schemaAttributeExternalIdentifierKeyPattern, Map<String,String> mappingProperties, SchemaAttributeProperties schemaAttributeProperties) Create a new metadata element to represent a schema attribute.
String	createSchemaAttributeFromTemplate(boolean assetManagerIsHome, String schemaElementGUID, String templateGUID, String schemaAttributeExternalIdentifier, String schemaAttributeExternalIdentifierName, String schemaAttributeExternalIdentifierUsage, KeyPattern schemaAttributeExternalIdentifierKeyPattern, Map<String,String> mappingProperties, TemplateProperties templateProperties) Create a new metadata element to represent a schema attribute using an existing metadata element as a template.
String	createSchemaType(boolean assetManagerIsHome, String schemaTypeExternalIdentifier, String schemaTypeExternalIdentifierName, String schemaTypeExternalIdentifierUsage, KeyPattern schemaTypeExternalIdentifierKeyPattern, Map<String,String> mappingProperties, SchemaTypeProperties schemaTypeProperties) Create a new metadata element to represent a schema type.
String	createSchemaTypeFromTemplate(boolean assetManagerIsHome, String templateGUID, String schemaTypeExternalIdentifier, String schemaTypeExternalIdentifierName, String schemaTypeExternalIdentifierUsage, KeyPattern schemaTypeExternalIdentifierKeyPattern, Map<String,String> mappingProperties, TemplateProperties templateProperties) Create a new metadata element to represent a schema type using an existing metadata element as a template.
List<SchemaAttributeElement>	findSchemaAttributes(String searchString, int startFrom, int pageSize) Retrieve the list of schema attribute metadata elements that contain the search string.
List<SchemaTypeElement>	findSchemaType(String searchString, int startFrom, int pageSize) Retrieve the list of schema type metadata elements that contain the search string.
List<SchemaAttributeElement>	getAttributesForSchemaType(String schemaTypeGUID, int startFrom, int pageSize) Retrieve the list of schema attributes associated with a schemaType.
SchemaAttributeElement	getSchemaAttributeByGUID(String schemaAttributeGUID) Retrieve the schema attribute metadata element with the supplied unique identifier.
List<SchemaAttributeElement>	getSchemaAttributesByName(String name, int startFrom, int pageSize) Retrieve the list of schema attribute metadata elements with a matching qualified or display name.
SchemaTypeElement	getSchemaTypeByGUID(String schemaTypeGUID) Retrieve the schema type metadata element with the supplied unique identifier.
List<SchemaTypeElement>	getSchemaTypeByName(String name, int startFrom, int pageSize) Retrieve the list of schema type metadata elements with a matching qualified or display name.
SchemaTypeElement	getSchemaTypeForElement(String parentElementGUID, String parentElementTypeName) Return the schema type associated with a specific open metadata element (data asset, process or port).
ElementHeader	getSchemaTypeParent(String schemaTypeGUID) Retrieve the header of the metadata element connected to a schema type.
void	removeSchemaAttribute(String schemaAttributeGUID, String schemaAttributeExternalIdentifier) Remove the metadata element representing a schema attribute.
void	removeSchemaType(String schemaTypeGUID, String schemaTypeExternalIdentifier) Remove the metadata element representing a schema type.
void	setSchemaElementAsCalculatedValue(boolean assetManagerIsHome, String schemaElementGUID, String schemaElementExternalIdentifier, String formula) Classify the schema type (or attribute if type is embedded) to indicate that it is a calculated value.
void	setupColumnAsPrimaryKey(String userId, String assetManagerGUID, String assetManagerName, boolean assetManagerIsHome, String schemaAttributeGUID, String schemaAttributeExternalIdentifier, String primaryKeyName, KeyPattern primaryKeyPattern) Classify the column schema attribute to indicate that it describes a primary key.
void	setupForeignKeyRelationship(boolean assetManagerIsHome, String primaryKeyGUID, String foreignKeyGUID, ForeignKeyProperties foreignKeyProperties) Link two schema attributes together to show a foreign key relationship.
void	setupSchemaTypeParent(boolean assetManagerIsHome, String schemaTypeGUID, String parentElementGUID, String parentElementTypeName) Connect a schema type to a data asset, process or port.
void	updateForeignKeyRelationship(String userId, String assetManagerGUID, String assetManagerName, String primaryKeyGUID, String foreignKeyGUID, ForeignKeyProperties foreignKeyProperties) Update the relationship properties for the query target.
void	updateSchemaAttribute(String schemaAttributeGUID, String schemaAttributeExternalIdentifier, boolean isMergeUpdate, SchemaAttributeProperties schemaAttributeProperties) Update the properties of the metadata element representing a schema attribute.
void	updateSchemaType(String schemaTypeGUID, String schemaTypeExternalIdentifier, boolean isMergeUpdate, SchemaTypeProperties schemaTypeProperties) Update the metadata element representing a schema type.

Methods inherited from class java.lang.Object

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

Method Detail

createSchemaType

public String createSchemaType(boolean assetManagerIsHome,
                               String schemaTypeExternalIdentifier,
                               String schemaTypeExternalIdentifierName,
                               String schemaTypeExternalIdentifierUsage,
                               KeyPattern schemaTypeExternalIdentifierKeyPattern,
                               Map<String,String> mappingProperties,
                               SchemaTypeProperties schemaTypeProperties)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Create a new metadata element to represent a schema type.

Parameters:

assetManagerIsHome - ensure that only the asset manager can update this schema element

schemaTypeExternalIdentifier - unique identifier of the schema type in the external asset manager

schemaTypeExternalIdentifierName - name of property for the external identifier in the external asset manager

schemaTypeExternalIdentifierUsage - optional usage description for the external identifier when calling the external asset manager

schemaTypeExternalIdentifierKeyPattern - pattern for the external identifier within the external asset manager (default is LOCAL_KEY)

mappingProperties - additional properties to help with the mapping of the elements in the external asset manager and open metadata

schemaTypeProperties - properties about the schema type to store

Returns:

unique identifier of the new schema type

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createSchemaTypeFromTemplate

public String createSchemaTypeFromTemplate(boolean assetManagerIsHome,
                                           String templateGUID,
                                           String schemaTypeExternalIdentifier,
                                           String schemaTypeExternalIdentifierName,
                                           String schemaTypeExternalIdentifierUsage,
                                           KeyPattern schemaTypeExternalIdentifierKeyPattern,
                                           Map<String,String> mappingProperties,
                                           TemplateProperties templateProperties)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException

Create a new metadata element to represent a schema type using an existing metadata element as a template.

Parameters:

assetManagerIsHome - ensure that only the asset manager can update this schema element

templateGUID - unique identifier of the metadata element to copy

schemaTypeExternalIdentifier - unique identifier of the schema type in the external asset manager

schemaTypeExternalIdentifierName - name of property for the external identifier in the external asset manager

schemaTypeExternalIdentifierUsage - optional usage description for the external identifier when calling the external asset manager

schemaTypeExternalIdentifierKeyPattern - pattern for the external identifier within the external asset manager (default is LOCAL_KEY)

mappingProperties - additional properties to help with the mapping of the elements in the external asset manager and open metadata

templateProperties - properties that override the template

Returns:

unique identifier of the new schema type

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateSchemaType

public void updateSchemaType(String schemaTypeGUID,
                             String schemaTypeExternalIdentifier,
                             boolean isMergeUpdate,
                             SchemaTypeProperties schemaTypeProperties)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Update the metadata element representing a schema type.

Parameters:

schemaTypeGUID - unique identifier of the metadata element to update

schemaTypeExternalIdentifier - unique identifier of the schema type in the external asset manager

isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?

schemaTypeProperties - new properties for the metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

setupSchemaTypeParent

public void setupSchemaTypeParent(boolean assetManagerIsHome,
                                  String schemaTypeGUID,
                                  String parentElementGUID,
                                  String parentElementTypeName)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Connect a schema type to a data asset, process or port.

Parameters:

assetManagerIsHome - ensure that only the asset manager can update this relationship

schemaTypeGUID - unique identifier of the schema type to connect

parentElementGUID - unique identifier of the open metadata element that this schema type is to be connected to

parentElementTypeName - unique type name of the open metadata element that this schema type is to be connected to

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

clearSchemaTypeParent

public void clearSchemaTypeParent(String schemaTypeGUID,
                                  String parentElementGUID,
                                  String parentElementTypeName)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Remove the relationship between a schema type and its parent data asset, process or port.

Parameters:

schemaTypeGUID - unique identifier of the schema type to connect

parentElementGUID - unique identifier of the open metadata element that this schema type is to be connected to

parentElementTypeName - unique type name of the open metadata element that this schema type is to be connected to

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeSchemaType

public void removeSchemaType(String schemaTypeGUID,
                             String schemaTypeExternalIdentifier)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Remove the metadata element representing a schema type.

Parameters:

schemaTypeGUID - unique identifier of the metadata element to remove

schemaTypeExternalIdentifier - unique identifier of the schema type in the external asset manager

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findSchemaType

public List<SchemaTypeElement> findSchemaType(String searchString,
                                              int startFrom,
                                              int pageSize)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException

Retrieve the list of schema type metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getSchemaTypeForElement

public SchemaTypeElement getSchemaTypeForElement(String parentElementGUID,
                                                 String parentElementTypeName)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException

Return the schema type associated with a specific open metadata element (data asset, process or port).

Parameters:

parentElementGUID - unique identifier of the open metadata element that this schema type is to be connected to

parentElementTypeName - unique type name of the open metadata element that this schema type is to be connected to

Returns:

metadata element describing the schema type associated with the requested parent element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getSchemaTypeByName

public List<SchemaTypeElement> getSchemaTypeByName(String name,
                                                   int startFrom,
                                                   int pageSize)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException

Retrieve the list of schema type metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getSchemaTypeByGUID

public SchemaTypeElement getSchemaTypeByGUID(String schemaTypeGUID)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException

Retrieve the schema type metadata element with the supplied unique identifier.

Parameters:

schemaTypeGUID - unique identifier of the requested metadata element

Returns:

requested metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getSchemaTypeParent

public ElementHeader getSchemaTypeParent(String schemaTypeGUID)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException

Retrieve the header of the metadata element connected to a schema type.

Parameters:

schemaTypeGUID - unique identifier of the requested metadata element

Returns:

header for parent element (data asset, process, port)

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createSchemaAttribute

public String createSchemaAttribute(boolean assetManagerIsHome,
                                    String schemaElementGUID,
                                    String schemaAttributeExternalIdentifier,
                                    String schemaAttributeExternalIdentifierName,
                                    String schemaAttributeExternalIdentifierUsage,
                                    KeyPattern schemaAttributeExternalIdentifierKeyPattern,
                                    Map<String,String> mappingProperties,
                                    SchemaAttributeProperties schemaAttributeProperties)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Create a new metadata element to represent a schema attribute.

Parameters:

assetManagerIsHome - ensure that only the asset manager can update this schema attribute

schemaElementGUID - unique identifier of the schemaType or Schema Attribute where the schema attribute is connected to

schemaAttributeExternalIdentifier - unique identifier of the schema attribute in the external asset manager

schemaAttributeExternalIdentifierName - name of property for the external identifier in the external asset manager

schemaAttributeExternalIdentifierUsage - optional usage description for the external identifier when calling the external asset manager

schemaAttributeExternalIdentifierKeyPattern - pattern for the external identifier within the external asset manager (default is LOCAL_KEY)

mappingProperties - additional properties to help with the mapping of the elements in the external asset manager and open metadata

schemaAttributeProperties - properties for the schema attribute

Returns:

unique identifier of the new metadata element for the schema attribute

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createSchemaAttributeFromTemplate

public String createSchemaAttributeFromTemplate(boolean assetManagerIsHome,
                                                String schemaElementGUID,
                                                String templateGUID,
                                                String schemaAttributeExternalIdentifier,
                                                String schemaAttributeExternalIdentifierName,
                                                String schemaAttributeExternalIdentifierUsage,
                                                KeyPattern schemaAttributeExternalIdentifierKeyPattern,
                                                Map<String,String> mappingProperties,
                                                TemplateProperties templateProperties)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException

Create a new metadata element to represent a schema attribute using an existing metadata element as a template.

Parameters:

assetManagerIsHome - ensure that only the asset manager can update this schema element

schemaElementGUID - unique identifier of the schemaType or Schema Attribute where the schema attribute is connected to

templateGUID - unique identifier of the metadata element to copy

schemaAttributeExternalIdentifier - unique identifier of the schema attribute in the external asset manager

schemaAttributeExternalIdentifierName - name of property for the external identifier in the external asset manager

schemaAttributeExternalIdentifierUsage - optional usage description for the external identifier when calling the external asset manager

schemaAttributeExternalIdentifierKeyPattern - pattern for the external identifier within the external asset manager (default is LOCAL_KEY)

mappingProperties - additional properties to help with the mapping of the elements in the external asset manager and open metadata

templateProperties - properties that override the template

Returns:

unique identifier of the new metadata element for the schema attribute

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateSchemaAttribute

public void updateSchemaAttribute(String schemaAttributeGUID,
                                  String schemaAttributeExternalIdentifier,
                                  boolean isMergeUpdate,
                                  SchemaAttributeProperties schemaAttributeProperties)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Update the properties of the metadata element representing a schema attribute.

Parameters:

schemaAttributeGUID - unique identifier of the schema attribute to update

schemaAttributeExternalIdentifier - unique identifier of the schema attribute in the external asset manager

isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?

schemaAttributeProperties - new properties for the schema attribute

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

setSchemaElementAsCalculatedValue

public void setSchemaElementAsCalculatedValue(boolean assetManagerIsHome,
                                              String schemaElementGUID,
                                              String schemaElementExternalIdentifier,
                                              String formula)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException

Classify the schema type (or attribute if type is embedded) to indicate that it is a calculated value.

Parameters:

assetManagerIsHome - ensure that only the asset manager can update this schema attribute

schemaElementGUID - unique identifier of the metadata element to update

schemaElementExternalIdentifier - unique identifier of the schema element in the external asset manager

formula - description of how the value is calculated

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

clearSchemaElementAsCalculatedValue

public void clearSchemaElementAsCalculatedValue(String schemaElementGUID,
                                                String schemaElementExternalIdentifier)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException

Remove the calculated value designation from the schema element.

Parameters:

schemaElementGUID - unique identifier of the metadata element to update

schemaElementExternalIdentifier - unique identifier of the schema element in the external asset manager

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

setupColumnAsPrimaryKey

public void setupColumnAsPrimaryKey(String userId,
                                    String assetManagerGUID,
                                    String assetManagerName,
                                    boolean assetManagerIsHome,
                                    String schemaAttributeGUID,
                                    String schemaAttributeExternalIdentifier,
                                    String primaryKeyName,
                                    KeyPattern primaryKeyPattern)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Classify the column schema attribute to indicate that it describes a primary key.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

assetManagerIsHome - ensure that only the asset manager can update this classification

schemaAttributeGUID - unique identifier of the metadata element to update

schemaAttributeExternalIdentifier - unique identifier of the schema attribute in the external asset manager

primaryKeyName - name of the primary key (if different from the column name)

primaryKeyPattern - key pattern used to maintain the primary key

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

clearColumnAsPrimaryKey

public void clearColumnAsPrimaryKey(String schemaAttributeGUID,
                                    String schemaAttributeExternalIdentifier)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Remove the primary key designation from the schema attribute.

Parameters:

schemaAttributeGUID - unique identifier of the metadata element to update

schemaAttributeExternalIdentifier - unique identifier of the schema attribute in the external asset manager

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

setupForeignKeyRelationship

public void setupForeignKeyRelationship(boolean assetManagerIsHome,
                                        String primaryKeyGUID,
                                        String foreignKeyGUID,
                                        ForeignKeyProperties foreignKeyProperties)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Link two schema attributes together to show a foreign key relationship.

Parameters:

assetManagerIsHome - ensure that only the asset manager can update this relationship

primaryKeyGUID - unique identifier of the derived schema element

foreignKeyGUID - unique identifier of the query target schema element

foreignKeyProperties - properties for the foreign key relationship

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateForeignKeyRelationship

public void updateForeignKeyRelationship(String userId,
                                         String assetManagerGUID,
                                         String assetManagerName,
                                         String primaryKeyGUID,
                                         String foreignKeyGUID,
                                         ForeignKeyProperties foreignKeyProperties)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException

Update the relationship properties for the query target.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

primaryKeyGUID - unique identifier of the derived schema element

foreignKeyGUID - unique identifier of the query target schema element

foreignKeyProperties - properties for the foreign key relationship

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

clearForeignKeyRelationship

public void clearForeignKeyRelationship(String primaryKeyGUID,
                                        String foreignKeyGUID)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Remove the foreign key relationship between two schema elements.

Parameters:

primaryKeyGUID - unique identifier of the derived schema element

foreignKeyGUID - unique identifier of the query target schema element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeSchemaAttribute

public void removeSchemaAttribute(String schemaAttributeGUID,
                                  String schemaAttributeExternalIdentifier)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Remove the metadata element representing a schema attribute.

Parameters:

schemaAttributeGUID - unique identifier of the metadata element to remove

schemaAttributeExternalIdentifier - unique identifier of the schema attribute in the external asset manager

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findSchemaAttributes

public List<SchemaAttributeElement> findSchemaAttributes(String searchString,
                                                         int startFrom,
                                                         int pageSize)
                                                  throws InvalidParameterException,
                                                         UserNotAuthorizedException,
                                                         PropertyServerException

Retrieve the list of schema attribute metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getAttributesForSchemaType

public List<SchemaAttributeElement> getAttributesForSchemaType(String schemaTypeGUID,
                                                               int startFrom,
                                                               int pageSize)
                                                        throws InvalidParameterException,
                                                               UserNotAuthorizedException,
                                                               PropertyServerException

Retrieve the list of schema attributes associated with a schemaType.

Parameters:

schemaTypeGUID - unique identifier of the schemaType of interest

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of associated metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getSchemaAttributesByName

public List<SchemaAttributeElement> getSchemaAttributesByName(String name,
                                                              int startFrom,
                                                              int pageSize)
                                                       throws InvalidParameterException,
                                                              UserNotAuthorizedException,
                                                              PropertyServerException

Retrieve the list of schema attribute metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getSchemaAttributeByGUID

public SchemaAttributeElement getSchemaAttributeByGUID(String schemaAttributeGUID)
                                                throws InvalidParameterException,
                                                       UserNotAuthorizedException,
                                                       PropertyServerException

Retrieve the schema attribute metadata element with the supplied unique identifier.

Parameters:

schemaAttributeGUID - unique identifier of the requested metadata element

Returns:

matching metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)