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

Class DataProduct

java.lang.Object
org.odpi.openmetadata.frameworks.integration.bitol.common.BitolDocument
org.odpi.openmetadata.frameworks.integration.bitol.odps.DataProduct
public class DataProduct extends BitolDocument
This class represents an Open Data Product Standard (ODPS) data product as defined by the Bitol project (https://bitol-io.github.io/open-data-product-standard/). It is used internally in Egeria to pass this information to the integration connectors and view services. A data product describes the data it consumes (input ports) and provides (output ports), each described by an Open Data Contract Standard (ODCS) data contract, along with its management ports, support channels and team. The fundamentals shared with the Open Data Contract Standard are inherited from BitolDocument.

  • Field Details

    • CURRENT_API_VERSION

      public static final String CURRENT_API_VERSION
      The version of the Open Data Product Standard that this bean is aligned with. It is the default apiVersion for new documents.
      See Also:

    • SUPPORTED_API_VERSION_PREFIXES

      public static final List<String> SUPPORTED_API_VERSION_PREFIXES
      The prefixes of the apiVersion values that this bean is able to represent. The v0.9.0 pre-release has the same structure as v1.0.0.

  • Constructor Details

    • DataProduct

      public DataProduct()
      Default constructor

  • Method Details

    • getInputPorts

      public List<DataProductInputPort> getInputPorts()
      Return the list of input ports (data consumed by the data product).
      Returns:
      list of input ports

    • setInputPorts

      public void setInputPorts(List<DataProductInputPort> inputPorts)
      Set up the list of input ports (data consumed by the data product).
      Parameters:
      inputPorts - list of input ports

    • getOutputPorts

      public List<DataProductOutputPort> getOutputPorts()
      Return the list of output ports (data provided by the data product).
      Returns:
      list of output ports

    • setOutputPorts

      public void setOutputPorts(List<DataProductOutputPort> outputPorts)
      Set up the list of output ports (data provided by the data product).
      Parameters:
      outputPorts - list of output ports

    • getManagementPorts

      public List<DataProductManagementPort> getManagementPorts()
      Return the list of management ports.
      Returns:
      list of management ports

    • setManagementPorts

      public void setManagementPorts(List<DataProductManagementPort> managementPorts)
      Set up the list of management ports.
      Parameters:
      managementPorts - list of management ports

    • getSupport

      public List<BitolSupportChannel> getSupport()
      Return the list of support and communication channels.
      Returns:
      list of support channels

    • setSupport

      public void setSupport(List<BitolSupportChannel> support)
      Set up the list of support and communication channels.
      Parameters:
      support - list of support channels

    • getTeam

      public BitolTeam getTeam()
      Return the team responsible for the data product.
      Returns:
      team structure

    • setTeam

      public void setTeam(BitolTeam team)
      Set up the team responsible for the data product.
      Parameters:
      team - team structure

    • getProductCreatedTs

      public String getProductCreatedTs()
      Return the timestamp (UTC, ISO 8601) when the data product was created.
      Returns:
      string timestamp

    • setProductCreatedTs

      public void setProductCreatedTs(String productCreatedTs)
      Set up the timestamp (UTC, ISO 8601) when the data product was created.
      Parameters:
      productCreatedTs - string timestamp

    • hasSupportedApiVersion

      public boolean hasSupportedApiVersion()
      Return whether the apiVersion of this document is one that this bean is able to represent.
      Specified by:
      hasSupportedApiVersion in class BitolDocument
      Returns:
      boolean flag

    • getType

      public String getType()
      Return the architectural type of the data product, for example sourceAligned, aggregate or consumerAligned.
      Returns:
      String

    • setType

      public void setType(String type)
      Set up the architectural type of the data product, for example sourceAligned, aggregate or consumerAligned.
      Parameters:
      type - String

    • getDeprecated

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

    • setDeprecated

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

    • getSynonyms

      public List<BitolSynonym> getSynonyms()
      Return the alternative names for this data product.
      Returns:
      List

    • setSynonyms

      public void setSynonyms(List<BitolSynonym> synonyms)
      Set up the alternative names for this data product.
      Parameters:
      synonyms - List

    • toString

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

    • hashCode

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