org.odpi.openmetadata.accessservices.assetmanager.properties

Class MetadataCorrelationProperties

java.lang.Object

org.odpi.openmetadata.accessservices.assetmanager.properties.MetadataCorrelationProperties

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MetadataCorrelationHeader

public class MetadataCorrelationProperties
extends Object
implements Serializable

MetadataCorrelationProperties describes the common properties used to pass the properties of metadata elements to the metadata repositories (aka properties server). It includes details of the external source of the metadata and any properties that assists in the mapping of the open metadata elements to the external asset manager's copy.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MetadataCorrelationProperties() Default constructor
MetadataCorrelationProperties(MetadataCorrelationProperties template) Copy/clone constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Compare the values of the supplied object with those stored in the current object.
String	getAssetManagerGUID() Return the unique identifier of the software server capability that represents the asset manager.
String	getAssetManagerName() Return the qualified name of the software server capability that represents the asset manager.
String	getExternalIdentifier() Return the unique identifier used in the external asset manager for this element.
String	getExternalIdentifierName() Return a short description of the external identifier (such as style or property name).
String	getExternalIdentifierSource() Return the component (connector/client) that created/maintained this external identifier and its relationship to the open metadata element(s).
String	getExternalIdentifierUsage() Return a short description of how the external identifier is used.
KeyPattern	getKeyPattern() Returns the key pattern used in the asset manager for the external identifier.
Map<String,String>	getMappingProperties() Return any additional properties to help with the mapping of the external identifier to open metadata elements.
String	getSynchronizationDescription() Return optional short description of the asset manager.
SynchronizationDirection	getSynchronizationDirection() Return details of the synchronization direction.
int	hashCode() Return has code based on properties.
void	setAssetManagerGUID(String assetManagerGUID) Set up the unique identifier of the software server capability that represents the asset manager.
void	setAssetManagerName(String assetManagerName) Set up the qualified name of the software server capability that represents the asset manager.
void	setExternalIdentifier(String externalIdentifier) Set up the unique identifier used in the external asset manager for this element.
void	setExternalIdentifierName(String externalIdentifierName) Set up a short description of the external identifier (such as style or property name).
void	setExternalIdentifierSource(String externalIdentifierSource) Set up the component (connector/client) that created/maintained this external identifier and its relationship to the open metadata element(s).
void	setExternalIdentifierUsage(String externalIdentifierUsage) Set up a short description of how the external identifier is used.
void	setKeyPattern(KeyPattern keyPattern) Set up the key pattern used in the asset manager for the external identifier.
void	setMappingProperties(Map<String,String> mappingProperties) Set up any additional properties to help with the mapping of the external identifier to open metadata elements.
void	setSynchronizationDescription(String synchronizationDescription) Set up optional short description of the asset manager.
void	setSynchronizationDirection(SynchronizationDirection synchronizationDirection) Set up details of the synchronization direction.
String	toString() Standard toString method.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MetadataCorrelationProperties

public MetadataCorrelationProperties()

Default constructor

MetadataCorrelationProperties

public MetadataCorrelationProperties(MetadataCorrelationProperties template)

Copy/clone constructor.

Parameters:

template - template object to copy.

Method Detail

getAssetManagerGUID

public String getAssetManagerGUID()

Return the unique identifier of the software server capability that represents the asset manager.

Returns:

string guid

setAssetManagerGUID

public void setAssetManagerGUID(String assetManagerGUID)

Set up the unique identifier of the software server capability that represents the asset manager.

Parameters:

assetManagerGUID - string guid

getAssetManagerName

public String getAssetManagerName()

Return the qualified name of the software server capability that represents the asset manager.

Returns:

string name

setAssetManagerName

public void setAssetManagerName(String assetManagerName)

Set up the qualified name of the software server capability that represents the asset manager.

Parameters:

assetManagerName - string name

getSynchronizationDirection

public SynchronizationDirection getSynchronizationDirection()

Return details of the synchronization direction.

Returns:

enum

setSynchronizationDirection

public void setSynchronizationDirection(SynchronizationDirection synchronizationDirection)

Set up details of the synchronization direction.

Parameters:

synchronizationDirection - enum

getSynchronizationDescription

public String getSynchronizationDescription()

Return optional short description of the asset manager.

Returns:

string summary

setSynchronizationDescription

public void setSynchronizationDescription(String synchronizationDescription)

Set up optional short description of the asset manager.

Parameters:

synchronizationDescription - string summary

getExternalIdentifier

public String getExternalIdentifier()

Return the unique identifier used in the external asset manager for this element.

Returns:

string identifier

setExternalIdentifier

public void setExternalIdentifier(String externalIdentifier)

Set up the unique identifier used in the external asset manager for this element.

Parameters:

externalIdentifier - string identifier

getExternalIdentifierName

public String getExternalIdentifierName()

Return a short description of the external identifier (such as style or property name).

Returns:

string summary

setExternalIdentifierName

public void setExternalIdentifierName(String externalIdentifierName)

Set up a short description of the external identifier (such as style or property name).

Parameters:

externalIdentifierName - string summary

getExternalIdentifierUsage

public String getExternalIdentifierUsage()

Return a short description of how the external identifier is used.

Returns:

string description

setExternalIdentifierUsage

public void setExternalIdentifierUsage(String externalIdentifierUsage)

Set up a short description of how the external identifier is used.

Parameters:

externalIdentifierUsage - string description

getExternalIdentifierSource

public String getExternalIdentifierSource()

Return the component (connector/client) that created/maintained this external identifier and its relationship to the open metadata element(s).

Returns:

component name

setExternalIdentifierSource

public void setExternalIdentifierSource(String externalIdentifierSource)

Set up the component (connector/client) that created/maintained this external identifier and its relationship to the open metadata element(s).

Parameters:

externalIdentifierSource - component name

setKeyPattern

public void setKeyPattern(KeyPattern keyPattern)

Set up the key pattern used in the asset manager for the external identifier.

Parameters:

keyPattern - String name

getKeyPattern

public KeyPattern getKeyPattern()

Returns the key pattern used in the asset manager for the external identifier.

Returns:

String name

getMappingProperties

public Map<String,String> getMappingProperties()

Return any additional properties to help with the mapping of the external identifier to open metadata elements.

Returns:

name-value pairs

setMappingProperties

public void setMappingProperties(Map<String,String> mappingProperties)

Set up any additional properties to help with the mapping of the external identifier to open metadata elements.

Parameters:

mappingProperties - name-value pairs

toString

public String toString()

Standard toString method.

Overrides:

toString in class Object

Returns:

print out of variables in a JSON-style

equals

public boolean equals(Object objectToCompare)

Compare the values of the supplied object with those stored in the current object.

Overrides:

equals in class Object

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison

hashCode

public int hashCode()

Return has code based on properties.

Overrides:

hashCode in class Object

Returns:

int