Package org.odpi.openmetadata.frameworks.opengovernance.properties

Class CatalogTarget

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.properties.RelationshipProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.RelationshipBeanProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.assets.processes.connectors.CatalogTargetProperties
org.odpi.openmetadata.frameworks.opengovernance.properties.CatalogTarget
Direct Known Subclasses:
RequestedCatalogTarget
public class CatalogTarget extends CatalogTargetProperties
CatalogTarget contains the properties for one of the integration connector's catalog targets. Each integration connector is optionally linked via the CatalogTarget relationship to one or more elements that the integration connector is working on. The catalogTargetElement contains details of the entity that represents the catalog target. It is extracted from entity proxy two of the catalog target relationship.

The element is held as it was retrieved with the catalog target: its header and properties, and the relationship that makes it a target. What is attached to the element is not retrieved with it. A caller that needs to see the attachments reads them on demand - and says how much - through the getters on RequestedCatalogTarget in the Open Integration Framework, which is where every catalog target that a connector processes ends up.

  • Constructor Details

    • CatalogTarget

      public CatalogTarget()
      Default constructor

    • CatalogTarget

      public CatalogTarget(CatalogTarget template)
      Copy/clone constructor
      Parameters:
      template - object to copy

    • CatalogTarget

      public CatalogTarget(CatalogTargetProperties catalogTargetProperties, OpenMetadataRootElement element)
      Copy/clone constructor
      Parameters:
      catalogTargetProperties - object to copy
      element - object to copy

  • Method Details

    • getRelationshipGUID

      public String getRelationshipGUID()
      Return the unique identifier of the CatalogTarget relationship. This is useful if the values in this relationship need to be updated.
      Returns:
      string guid

    • setRelationshipGUID

      public void setRelationshipGUID(String relationshipGUID)
      Set up the unique identifier of the CatalogTarget relationship. This is useful if the values in this relationship need to be updated.
      Parameters:
      relationshipGUID - string guid

    • getRelationshipVersions

      public ElementVersions getRelationshipVersions()
      Return the latest version information from the catalog target relationship.
      Returns:
      version info

    • setRelationshipVersions

      public void setRelationshipVersions(ElementVersions relationshipVersions)
      Set up the latest version information from the catalog target relationship.
      Parameters:
      relationshipVersions - version info

    • getCatalogTargetElement

      public OpenMetadataRootElement getCatalogTargetElement()
      Return the catalog target element as it was retrieved with the catalog target: header, properties and the catalog target relationship, with nothing attached.
      Returns:
      element, with its attachments not populated

    • setCatalogTargetElement

      public void setCatalogTargetElement(OpenMetadataRootElement catalogTargetElement)
      Set up details of the catalog target element.
      Parameters:
      catalogTargetElement - element stub

    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class CatalogTargetProperties
      Returns:
      return string containing the property names and values

    • equals

      public boolean equals(Object objectToCompare)
      Return comparison result based on the content of the properties.
      Overrides:
      equals in class CatalogTargetProperties
      Parameters:
      objectToCompare - test object
      Returns:
      result of comparison

    • hashCode

      public int hashCode()
      Return hash code for this object
      Overrides:
      hashCode in class CatalogTargetProperties
      Returns:
      int hash code