org.odpi.openmetadata.frameworks.connectors.properties

Class AssetExternalIdentifier

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyElementBase

org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyBase

org.odpi.openmetadata.frameworks.connectors.properties.AssetElementHeader

org.odpi.openmetadata.frameworks.connectors.properties.AssetReferenceable

org.odpi.openmetadata.frameworks.connectors.properties.AssetExternalIdentifier

All Implemented Interfaces:

Serializable

public class AssetExternalIdentifier
extends AssetReferenceable

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 ExternalIdentifier	externalIdentifierBean

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetReferenceable

referenceableBean

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyBase

parentAsset

Constructor Summary

Constructors

Constructor and Description
AssetExternalIdentifier(AssetDescriptor parentAsset, AssetExternalIdentifier templateExternalIdentifier) Copy/clone constructor.
AssetExternalIdentifier(AssetDescriptor parentAsset, ExternalIdentifier externalIdentifierBean) Bean constructor with parent asset
AssetExternalIdentifier(ExternalIdentifier externalIdentifierBean) Bean 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.
protected ExternalIdentifier	getExternalIdentifierBean() Return the bean with all of the properties - used in the cloning process.
String	getIdentifier() Return the external identifier for this asset.
KeyPattern	getKeyPattern() Return the key pattern that is used with this external identifier.
AssetReferenceable	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 details 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.AssetReferenceable

getAdditionalProperties, getMeanings, getQualifiedName, getReferenceableBean, setBean

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetElementHeader

getAssetClassifications, getElementHeaderBean, getExtendedProperties, getGUID, getType, getURL, hashCode, setBean

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyBase

getParentAsset, getParentAssetName, getParentAssetTypeName

Methods inherited from class java.lang.Object

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

Field Detail

externalIdentifierBean

protected ExternalIdentifier externalIdentifierBean

Constructor Detail

AssetExternalIdentifier

public AssetExternalIdentifier(ExternalIdentifier externalIdentifierBean)

Bean constructor

Parameters:

externalIdentifierBean - bean containing all of the properties

AssetExternalIdentifier

public AssetExternalIdentifier(AssetDescriptor parentAsset,
                               ExternalIdentifier externalIdentifierBean)

Bean constructor with parent asset

Parameters:

parentAsset - descriptor for parent asset

externalIdentifierBean - bean containing all of the properties

AssetExternalIdentifier

public AssetExternalIdentifier(AssetDescriptor parentAsset,
                               AssetExternalIdentifier templateExternalIdentifier)

Copy/clone constructor.

Parameters:

parentAsset - descriptor for parent asset

templateExternalIdentifier - element to copy

Method Detail

getExternalIdentifierBean

protected ExternalIdentifier getExternalIdentifierBean()

Return the bean with all of the properties - used in the cloning process.

Returns:

ExternalIdentifier bean

getIdentifier

public String getIdentifier()

Return the external identifier for this asset.

Returns:

String identifier

getDescription

public String getDescription()

Return the description of the external identifier.

Returns:

String description

getUsage

public String getUsage()

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

Returns:

String usage

getSource

public String getSource()

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

Returns:

String server

getKeyPattern

public KeyPattern getKeyPattern()

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

Returns:

KeyPattern enum

getScope

public AssetReferenceable 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

getScopeDescription

public String getScopeDescription()

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

Returns:

String scope description

toString

public String toString()

Standard toString method.

Overrides:

toString in class AssetReferenceable

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 AssetReferenceable

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison