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

Class BitolSynonym

java.lang.Object
org.odpi.openmetadata.frameworks.integration.bitol.common.BitolSynonym
public class BitolSynonym extends Object
This class represents an alternative name for a data product, schema object or schema property, recorded so that catalogs, AI tools and natural language interfaces can resolve business vocabulary to the underlying element (ODCS v3.2.0 and ODPS v1.1.0, RFC 0041).

  • Constructor Details

    • BitolSynonym

      public BitolSynonym()
      Default constructor

  • Method Details

    • getId

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

    • setId

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

    • getSynonym

      public String getSynonym()
      Return the synonymous term.
      Returns:
      String

    • setSynonym

      public void setSynonym(String synonym)
      Set up the synonymous term.
      Parameters:
      synonym - String

    • getDescription

      public String getDescription()
      Return a short note about when or why this synonym is used.
      Returns:
      String

    • setDescription

      public void setDescription(String description)
      Set up a short note about when or why this synonym is used.
      Parameters:
      description - String

    • getLocale

      public String getLocale()
      Return the BCP 47 language tag when the synonym is language-specific.
      Returns:
      String

    • setLocale

      public void setLocale(String locale)
      Set up the BCP 47 language tag when the synonym is language-specific.
      Parameters:
      locale - String

    • getSource

      public String getSource()
      Return the origin of the synonym, for example glossary or legacy-system.
      Returns:
      String

    • setSource

      public void setSource(String source)
      Set up the origin of the synonym, for example glossary or legacy-system.
      Parameters:
      source - String

    • getStatus

      public String getStatus()
      Return the lifecycle status of the synonym, for example active or deprecated.
      Returns:
      String

    • setStatus

      public void setStatus(String status)
      Set up the lifecycle status of the synonym, for example active or deprecated.
      Parameters:
      status - String

    • getCustomProperties

      public List<BitolCustomProperty> getCustomProperties()
      Return the custom properties of the synonym.
      Returns:
      List

    • setCustomProperties

      public void setCustomProperties(List<BitolCustomProperty> customProperties)
      Set up the custom properties of the synonym.
      Parameters:
      customProperties - List

    • 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