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

Class BitolCustomProperty

java.lang.Object
org.odpi.openmetadata.frameworks.integration.bitol.common.BitolCustomProperty
public class BitolCustomProperty extends Object
This class represents a custom (key/value) property that can be attached to most elements of a Bitol Open Data Contract Standard (ODCS) or Open Data Product Standard (ODPS) document. It is used internally in Egeria to pass this information to the integration connectors and view services.

  • Constructor Summary

    Constructors
    Constructor
    Description
    BitolCustomProperty()
    Default constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object objectToCompare)
    Compare the values of the supplied object with those stored in the current object.
    String
    getDescription()
    Return the description of the custom property.
    String
    getId()
    Return the stable identifier of this element (alphanumeric, hyphen and underscore characters only).
    String
    getProperty()
    Return the name of the property.
    Object
    getValue()
    Return the value of the property.
    String
    getVendor()
    Return the vendor, provider or external system associated with this custom property (a stable lowercase identifier such as confluent or soda).
    int
    hashCode()
    Return hash code based on properties.
    void
    setDescription(String description)
    Set up the description of the custom property.
    void
    setId(String id)
    Set up the stable identifier of this element (alphanumeric, hyphen and underscore characters only).
    void
    setProperty(String property)
    Set up the name of the property.
    void
    setValue(Object value)
    Set up the value of the property.
    void
    setVendor(String vendor)
    Set up the vendor, provider or external system associated with this custom property (a stable lowercase identifier such as confluent or soda).
    String
    toString()
    Standard toString method.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • BitolCustomProperty

      public BitolCustomProperty()
      Default constructor

  • Method Details

    • getId

      public String getId()
      Return the stable identifier of this element (alphanumeric, hyphen and underscore characters only).
      Returns:
      string identifier

    • setId

      public void setId(String id)
      Set up the stable identifier of this element (alphanumeric, hyphen and underscore characters only).
      Parameters:
      id - string identifier

    • getProperty

      public String getProperty()
      Return the name of the property. The Bitol standards recommend camelCase names.
      Returns:
      string property name

    • setProperty

      public void setProperty(String property)
      Set up the name of the property. The Bitol standards recommend camelCase names.
      Parameters:
      property - string property name

    • getValue

      public Object getValue()
      Return the value of the property. This may be a string, number, boolean, list or map.
      Returns:
      property value

    • setValue

      public void setValue(Object value)
      Set up the value of the property. This may be a string, number, boolean, list or map.
      Parameters:
      value - property value

    • getDescription

      public String getDescription()
      Return the description of the custom property.
      Returns:
      string description

    • setDescription

      public void setDescription(String description)
      Set up the description of the custom property.
      Parameters:
      description - string description

    • getVendor

      public String getVendor()
      Return the vendor, provider or external system associated with this custom property (a stable lowercase identifier such as confluent or soda).
      Returns:
      String

    • setVendor

      public void setVendor(String vendor)
      Set up the vendor, provider or external system associated with this custom property (a stable lowercase identifier such as confluent or soda).
      Parameters:
      vendor - String

    • 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