Package org.odpi.openmetadata.accessservices.assetmanager.metadataelements

Class ExternalReferenceElement

java.lang.Object
org.odpi.openmetadata.accessservices.assetmanager.metadataelements.ExternalReferenceElement
All Implemented Interfaces:
CorrelatedMetadataElement
public class ExternalReferenceElement extends Object implements CorrelatedMetadataElement
ExternalReferenceElement stores information about an link to an external resource that is relevant to this element.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ExternalReferenceElement()
    Default Constructor
    ExternalReferenceElement(ExternalReferenceElement template)
    Copy/clone Constructor - the resulting object.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object objectToCompare)
    Equals method that returns true if containing properties are the same.
    List<org.odpi.openmetadata.frameworks.governanceaction.properties.MetadataCorrelationHeader>
    getCorrelationHeaders()
    Return the details of the external identifier and other correlation properties about the metadata source.
    org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader
    getElementHeader()
    Return the element header associated with the properties.
    org.odpi.openmetadata.frameworks.openmetadata.properties.externalreferences.ExternalReferenceProperties
    getProperties()
    Return the link to external documentation that are relevant to this element.
    int
    hashCode()
    Hash of properties
    void
    setCorrelationHeaders(List<org.odpi.openmetadata.frameworks.governanceaction.properties.MetadataCorrelationHeader> correlationHeaders)
    Set up the details of the external identifier and other correlation properties about the metadata source.
    void
    setElementHeader(org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader elementHeader)
    Set up the element header associated with the properties.
    void
    setProperties(org.odpi.openmetadata.frameworks.openmetadata.properties.externalreferences.ExternalReferenceProperties properties)
    Set up the list of links to external documentation that are relevant to this element.
    String
    toString()
    JSON-style toString.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ExternalReferenceElement

      public ExternalReferenceElement()
      Default Constructor

    • ExternalReferenceElement

      public ExternalReferenceElement(ExternalReferenceElement template)
      Copy/clone Constructor - the resulting object.
      Parameters:
      template - object being copied

  • Method Details

    • getElementHeader

      public org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader getElementHeader()
      Return the element header associated with the properties.
      Specified by:
      getElementHeader in interface CorrelatedMetadataElement
      Returns:
      element header object

    • setElementHeader

      public void setElementHeader(org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader elementHeader)
      Set up the element header associated with the properties.
      Specified by:
      setElementHeader in interface CorrelatedMetadataElement
      Parameters:
      elementHeader - element header object

    • getCorrelationHeaders

      public List<org.odpi.openmetadata.frameworks.governanceaction.properties.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 CorrelatedMetadataElement
      Returns:
      list of correlation properties objects

    • setCorrelationHeaders

      public void setCorrelationHeaders(List<org.odpi.openmetadata.frameworks.governanceaction.properties.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 CorrelatedMetadataElement
      Parameters:
      correlationHeaders - list of correlation properties objects

    • getProperties

      public org.odpi.openmetadata.frameworks.openmetadata.properties.externalreferences.ExternalReferenceProperties getProperties()
      Return the link to external documentation that are relevant to this element.
      Returns:
      list of external references

    • setProperties

      public void setProperties(org.odpi.openmetadata.frameworks.openmetadata.properties.externalreferences.ExternalReferenceProperties properties)
      Set up the list of links to external documentation that are relevant to this element.
      Parameters:
      properties - of external references

    • toString

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

    • equals

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

    • hashCode

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