org.odpi.openmetadata.frameworks.connectors.properties.beans

Class ExternalIdentifier

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase

org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader

org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable

org.odpi.openmetadata.frameworks.connectors.properties.beans.ExternalIdentifier

All Implemented Interfaces:

Serializable

public class ExternalIdentifier
extends Referenceable

ExternalIdentifier stores information about an identifier for the asset that is used in an external system. This is used for correlating information about the asset across different systems.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description
protected String	identifier
protected KeyPattern	keyPattern
protected Referenceable	scope
protected String	scopeDescription
protected String	source
protected String	usage

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable

additionalProperties, confidenceGovernanceClassification, confidentialityGovernanceClassification, criticalityGovernanceClassification, latestChange, latestChangeDetails, meanings, qualifiedName, retentionGovernanceClassification, searchKeywords, securityTags

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader

classifications, extendedProperties, guid, type, url

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase

CURRENT_AUDIT_HEADER_VERSION

Constructor Summary

Constructors

Constructor and Description
ExternalIdentifier() Default constructor
ExternalIdentifier(ExternalIdentifier templateExternalIdentifier) 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	getDescription() Return the description of the external identifier.
String	getIdentifier() Return the external identifier for this asset.
KeyPattern	getKeyPattern() Return the key pattern that is used with this external identifier.
Referenceable	getScope() Return the scope of this external identifier.
String	getScopeDescription() Return the text description of the scope for this external identifier.
String	getSource() Return details of the source system where this external identifier comes from.
String	getUsage() Return a description of how, where and when this external identifier is used.
int	hashCode() Hash of properties
void	setDescription(String description) Set up the description of the external identifier.
void	setIdentifier(String identifier) Set up the external identifier for this asset.
void	setKeyPattern(KeyPattern keyPattern) Set up the key pattern that is used with this external identifier.
void	setScope(Referenceable scope) Set up the scope of this external identifier.
void	setScopeDescription(String scopeDescription) Set up the text description of the scope for this external identifier.
void	setSource(String source) Set up details of the source system where this external identifier comes from.
void	setUsage(String usage) Set up a description of how, where and when this external identifier is used.
String	toString() Standard toString method.

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable

getAdditionalProperties, getConfidenceGovernanceClassification, getConfidentialityGovernanceClassification, getCriticalityGovernanceClassification, getLatestChange, getLatestChangeDetails, getMeanings, getQualifiedName, getRetentionGovernanceClassification, getSearchKeywords, getSecurityTags, setAdditionalProperties, setConfidenceGovernanceClassification, setConfidentialityGovernanceClassification, setCriticalityGovernanceClassification, setLatestChange, setLatestChangeDetails, setMeanings, setQualifiedName, setRetentionGovernanceClassification, setSearchKeywords, setSecurityTags

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader

getClassifications, getExtendedProperties, getGUID, getType, getURL, setClassifications, setExtendedProperties, setGUID, setType, setURL

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase

getHeaderVersion, setHeaderVersion

Methods inherited from class java.lang.Object

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

Field Detail

identifier

protected String identifier

description

protected String description

usage

protected String usage

source

protected String source

keyPattern

protected KeyPattern keyPattern

scope

protected Referenceable scope

scopeDescription

protected String scopeDescription

Constructor Detail

ExternalIdentifier

public ExternalIdentifier()

Default constructor

ExternalIdentifier

public ExternalIdentifier(ExternalIdentifier templateExternalIdentifier)

Copy/clone constructor.

Parameters:

templateExternalIdentifier - element to copy

Method Detail

getIdentifier

public String getIdentifier()

Return the external identifier for this asset.

Returns:

String identifier

setIdentifier

public void setIdentifier(String identifier)

Set up the external identifier for this asset.

Parameters:

identifier - String identifier

getDescription

public String getDescription()

Return the description of the external identifier.

Returns:

String text

setDescription

public void setDescription(String description)

Set up the description of the external identifier.

Parameters:

description - String text

getUsage

public String getUsage()

Return a description of how, where and when this external identifier is used.

Returns:

String usage description

setUsage

public void setUsage(String usage)

Set up a description of how, where and when this external identifier is used.

Parameters:

usage - String usage description

getSource

public String getSource()

Return details of the source system where this external identifier comes from.

Returns:

String server identifier

setSource

public void setSource(String source)

Set up details of the source system where this external identifier comes from.

Parameters:

source - String server identifier

getKeyPattern

public KeyPattern getKeyPattern()

Return the key pattern that is used with this external identifier.

Returns:

KeyPattern enum

setKeyPattern

public void setKeyPattern(KeyPattern keyPattern)

Set up the key pattern that is used with this external identifier.

Parameters:

keyPattern - KeyPattern enum

getScope

public Referenceable getScope()

Return the scope of this external identifier. This depends on the key pattern. It may be a server definition, a reference data set or glossary term.

Returns:

Referenceable scope

setScope

public void setScope(Referenceable scope)

Set up the scope of this external identifier. This depends on the key pattern. It may be a server definition, a reference data set or glossary term.

Parameters:

scope - Referenceable object defining the scope of this external identifier.

getScopeDescription

public String getScopeDescription()

Return the text description of the scope for this external identifier.

Returns:

String scope description

setScopeDescription

public void setScopeDescription(String scopeDescription)

Set up the text description of the scope for this external identifier.

Parameters:

scopeDescription - String scope description

toString

public String toString()

Standard toString method.

Overrides:

toString in class Referenceable

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 Referenceable

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison

hashCode

public int hashCode()

Hash of properties

Overrides:

hashCode in class Referenceable

Returns:

int