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

Class DataContractSchemaElement

java.lang.Object
org.odpi.openmetadata.frameworks.integration.bitol.odcs.DataContractSchemaElement
Direct Known Subclasses:
DataContractSchemaObject, DataContractSchemaProperty
public class DataContractSchemaElement extends Object
This class represents the properties shared by the schema objects and schema properties of an Open Data Contract Standard (ODCS) data contract. It is the base class for DataContractSchemaObject and DataContractSchemaProperty.

  • Constructor Details

    • DataContractSchemaElement

      public DataContractSchemaElement()
      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

    • getName

      public String getName()
      Return the name of the schema element.
      Returns:
      string name

    • setName

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

    • getPhysicalName

      public String getPhysicalName()
      Return the name of the schema element in the physical data source.
      Returns:
      string name

    • setPhysicalName

      public void setPhysicalName(String physicalName)
      Set up the name of the schema element in the physical data source.
      Parameters:
      physicalName - string name

    • getPhysicalType

      public String getPhysicalType()
      Return the data type of the schema element in the physical data source.
      Returns:
      string type name

    • setPhysicalType

      public void setPhysicalType(String physicalType)
      Set up the data type of the schema element in the physical data source.
      Parameters:
      physicalType - string type name

    • getBusinessName

      public String getBusinessName()
      Return the business name of the schema element.
      Returns:
      string name

    • setBusinessName

      public void setBusinessName(String businessName)
      Set up the business name of the schema element.
      Parameters:
      businessName - string name

    • getDescription

      public String getDescription()
      Return the description of the schema element.
      Returns:
      string description

    • setDescription

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

    • 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

    • getDeprecated

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

    • setDeprecated

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

    • getSynonyms

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

    • setSynonyms

      public void setSynonyms(List<BitolSynonym> synonyms)
      Set up the alternative names for this element.
      Parameters:
      synonyms - 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