Class ExternalIdentifierProperties

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    MetadataCorrelationProperties

    public class ExternalIdentifierProperties
    extends java.lang.Object
    implements java.io.Serializable
    ExternalIdentifierProperties describes the properties used to pass information about an external identifier.
    See Also:
    Serialized Form
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object objectToCompare)
      Compare the values of the supplied object with those stored in the current object.
      java.lang.String getExternalIdentifier()
      Return the unique identifier used in the external asset manager for this element.
      java.lang.String getExternalIdentifierName()
      Return a short description of the external identifier (such as style or property name).
      java.lang.String getExternalIdentifierSource()
      Return the component (connector/client) that created/maintained this external identifier and its relationship to the open metadata element(s).
      java.lang.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.
      java.util.Map<java.lang.String,​java.lang.String> getMappingProperties()
      Return any additional properties to help with the mapping of the external identifier to open metadata elements.
      java.lang.String getSynchronizationDescription()
      Return optional short description of the asset manager.
      SynchronizationDirection getSynchronizationDirection()
      Return details of the synchronization direction.
      int hashCode()
      Return hash code based on properties.
      void setExternalIdentifier​(java.lang.String externalIdentifier)
      Set up the unique identifier used in the external asset manager for this element.
      void setExternalIdentifierName​(java.lang.String externalIdentifierName)
      Set up a short description of the external identifier (such as style or property name).
      void setExternalIdentifierSource​(java.lang.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​(java.lang.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​(java.util.Map<java.lang.String,​java.lang.String> mappingProperties)
      Set up any additional properties to help with the mapping of the external identifier to open metadata elements.
      void setSynchronizationDescription​(java.lang.String synchronizationDescription)
      Set up optional short description of the asset manager.
      void setSynchronizationDirection​(SynchronizationDirection synchronizationDirection)
      Set up details of the synchronization direction.
      java.lang.String toString()
      Standard toString method.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • ExternalIdentifierProperties

        public ExternalIdentifierProperties()
        Default constructor
      • ExternalIdentifierProperties

        public ExternalIdentifierProperties​(ExternalIdentifierProperties template)
        Copy/clone constructor.
        Parameters:
        template - template object to copy.
    • Method Detail

      • 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 java.lang.String getSynchronizationDescription()
        Return optional short description of the asset manager.
        Returns:
        string summary
      • setSynchronizationDescription

        public void setSynchronizationDescription​(java.lang.String synchronizationDescription)
        Set up optional short description of the asset manager.
        Parameters:
        synchronizationDescription - string summary
      • getExternalIdentifier

        public java.lang.String getExternalIdentifier()
        Return the unique identifier used in the external asset manager for this element.
        Returns:
        string identifier
      • setExternalIdentifier

        public void setExternalIdentifier​(java.lang.String externalIdentifier)
        Set up the unique identifier used in the external asset manager for this element.
        Parameters:
        externalIdentifier - string identifier
      • getExternalIdentifierName

        public java.lang.String getExternalIdentifierName()
        Return a short description of the external identifier (such as style or property name).
        Returns:
        string summary
      • setExternalIdentifierName

        public void setExternalIdentifierName​(java.lang.String externalIdentifierName)
        Set up a short description of the external identifier (such as style or property name).
        Parameters:
        externalIdentifierName - string summary
      • getExternalIdentifierUsage

        public java.lang.String getExternalIdentifierUsage()
        Return a short description of how the external identifier is used.
        Returns:
        string description
      • setExternalIdentifierUsage

        public void setExternalIdentifierUsage​(java.lang.String externalIdentifierUsage)
        Set up a short description of how the external identifier is used.
        Parameters:
        externalIdentifierUsage - string description
      • getExternalIdentifierSource

        public java.lang.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​(java.lang.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 java.util.Map<java.lang.String,​java.lang.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​(java.util.Map<java.lang.String,​java.lang.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 java.lang.String toString()
        Standard toString method.
        Overrides:
        toString in class java.lang.Object
        Returns:
        print out of variables in a JSON-style
      • equals

        public boolean equals​(java.lang.Object objectToCompare)
        Compare the values of the supplied object with those stored in the current object.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        objectToCompare - supplied object
        Returns:
        boolean result of comparison
      • hashCode

        public int hashCode()
        Return hash code based on properties.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        int