Package org.odpi.openmetadata.frameworks.connectors.properties

Class 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

    • 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