Package org.odpi.openmetadata.frameworks.integration.bitol.odps

Class DataProductInputPort

java.lang.Object
org.odpi.openmetadata.frameworks.integration.bitol.odps.DataProductInputPort
public class DataProductInputPort extends Object
This class represents an input port of an Open Data Product Standard (ODPS) data product. An input port identifies data that the data product consumes, described by an Open Data Contract Standard (ODCS) data contract.

  • Constructor Details

    • DataProductInputPort

      public DataProductInputPort()
      Default constructor

  • Method Details

    • getName

      public String getName()
      Return the name of the input port.
      Returns:
      string name

    • setName

      public void setName(String name)
      Set up the name of the input port.
      Parameters:
      name - string name

    • getVersion

      public String getVersion()
      Return the version of the input port.
      Returns:
      string version

    • setVersion

      public void setVersion(String version)
      Set up the version of the input port.
      Parameters:
      version - string version

    • getContractId

      public String getContractId()
      Return the identifier of the data contract that describes the data consumed through this port.
      Returns:
      string contract identifier

    • setContractId

      public void setContractId(String contractId)
      Set up the identifier of the data contract that describes the data consumed through this port.
      Parameters:
      contractId - string contract identifier

    • getTags

      public List<String> getTags()
      Return the list of tags attached to this element.
      Returns:
      list of tag strings

    • setTags

      public void setTags(List<String> tags)
      Set up the list of tags attached to this element.
      Parameters:
      tags - list of tag strings

    • getCustomProperties

      public List<BitolCustomProperty> getCustomProperties()
      Return the list of custom (key/value) properties attached to this element.
      Returns:
      list of custom properties

    • setCustomProperties

      public void setCustomProperties(List<BitolCustomProperty> customProperties)
      Set up the list of custom (key/value) properties attached to this element.
      Parameters:
      customProperties - list of custom properties

    • getAuthoritativeDefinitions

      public List<BitolAuthoritativeDefinition> getAuthoritativeDefinitions()
      Return the list of links to sources that provide more details about this element.
      Returns:
      list of authoritative definitions

    • setAuthoritativeDefinitions

      public void setAuthoritativeDefinitions(List<BitolAuthoritativeDefinition> authoritativeDefinitions)
      Set up the list of links to sources that provide more details about this element.
      Parameters:
      authoritativeDefinitions - list of authoritative definitions

    • getId

      public String getId()
      Return the stable identifier of this port.
      Returns:
      String

    • setId

      public void setId(String id)
      Set up the stable identifier of this port.
      Parameters:
      id - String

    • getDeprecated

      public Boolean getDeprecated()
      Return whether this port is deprecated and should not be used in new implementations.
      Returns:
      Boolean

    • setDeprecated

      public void setDeprecated(Boolean deprecated)
      Set up whether this port is deprecated and should not be used in new implementations.
      Parameters:
      deprecated - Boolean

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Object
      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 Object
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison

    • hashCode

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