Class ExternalReferenceLinkElement

  • All Implemented Interfaces:
    java.io.Serializable, MetadataElement

    public class ExternalReferenceLinkElement
    extends java.lang.Object
    implements MetadataElement, java.io.Serializable
    ExternalReferenceLinkElement stores information about an link to an external resource that is relevant to this element.
    See Also:
    Serialized Form
    • Constructor Detail

      • ExternalReferenceLinkElement

        public ExternalReferenceLinkElement()
        Default Constructor
      • ExternalReferenceLinkElement

        public ExternalReferenceLinkElement​(ExternalReferenceLinkElement template)
        Copy/clone Constructor - the resulting object.
        Parameters:
        template - object being copied
    • Method Detail

      • setElementHeader

        public void setElementHeader​(ElementHeader elementHeader)
        Set up the element header associated with the properties.
        Specified by:
        setElementHeader in interface MetadataElement
        Parameters:
        elementHeader - element header object
      • getCorrelationHeaders

        public java.util.List<MetadataCorrelationHeader> getCorrelationHeaders()
        Return the details of the external identifier and other correlation properties about the metadata source. There is one entry in the list for each element in the third party technology that maps to the single open source element.
        Specified by:
        getCorrelationHeaders in interface MetadataElement
        Returns:
        list of correlation properties objects
      • setCorrelationHeaders

        public void setCorrelationHeaders​(java.util.List<MetadataCorrelationHeader> correlationHeaders)
        Set up the details of the external identifier and other correlation properties about the metadata source. There is one entry in the list for each element in the third party technology that maps to the single open source element.
        Specified by:
        setCorrelationHeaders in interface MetadataElement
        Parameters:
        correlationHeaders - list of correlation properties objects
      • getLink

        public ExternalReferenceLinkProperties getLink()
        Return the specific link properties used to identify this link to the attached element.
        Returns:
        link properties
      • setLink

        public void setLink​(ExternalReferenceLinkProperties link)
        Set up the specific link properties used to identify this link to the attached element.
        Parameters:
        link - properties
      • getProperties

        public ExternalReferenceProperties getProperties()
        Return the link to external documentation that are relevant to this element.
        Returns:
        list of external references
      • setProperties

        public void setProperties​(ExternalReferenceProperties properties)
        Set up the list of links to external documentation that are relevant to this element.
        Parameters:
        properties - of external references
      • toString

        public java.lang.String toString()
        JSON-style toString.
        Overrides:
        toString in class java.lang.Object
        Returns:
        list of properties and their values.
      • equals

        public boolean equals​(java.lang.Object objectToCompare)
        Equals method that returns true if containing properties are the same.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        objectToCompare - object to compare
        Returns:
        boolean result of comparison
      • hashCode

        public int hashCode()
        Hash of properties
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        int