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

Class BitolDescription

java.lang.Object
org.odpi.openmetadata.frameworks.integration.bitol.common.BitolDescription
public class BitolDescription extends Object
This class represents the high-level description of a Bitol Open Data Contract Standard (ODCS) data contract or Open Data Product Standard (ODPS) data product.

  • Constructor Details

    • BitolDescription

      public BitolDescription()
      Default constructor

  • Method Details

    • getPurpose

      public String getPurpose()
      Return the intended purpose of the data.
      Returns:
      string description

    • setPurpose

      public void setPurpose(String purpose)
      Set up the intended purpose of the data.
      Parameters:
      purpose - string description

    • getLimitations

      public String getLimitations()
      Return the technical, compliance and legal limitations on the use of the data.
      Returns:
      string description

    • setLimitations

      public void setLimitations(String limitations)
      Set up the technical, compliance and legal limitations on the use of the data.
      Parameters:
      limitations - string description

    • getUsage

      public String getUsage()
      Return the recommended usage of the data.
      Returns:
      string description

    • setUsage

      public void setUsage(String usage)
      Set up the recommended usage of the data.
      Parameters:
      usage - string description

    • 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

    • 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

    • 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