Class SchemaElementProperties

java.lang.Object
org.odpi.openmetadata.accessservices.assetowner.properties.ReferenceableProperties
org.odpi.openmetadata.accessservices.assetowner.properties.SchemaElementProperties
Direct Known Subclasses:
SchemaAttributeProperties, SchemaTypeProperties

public abstract class SchemaElementProperties extends ReferenceableProperties
SchemaElementProperties carries the common parameters for creating or updating schema elements such as schema types and attributes.
  • Constructor Details

    • SchemaElementProperties

      public SchemaElementProperties()
      Default constructor
    • SchemaElementProperties

      public SchemaElementProperties(SchemaElementProperties template)
      Copy/clone constructor
      Parameters:
      template - object to copy
  • Method Details

    • getDisplayName

      public String getDisplayName()
      Return the display name of the file
      Returns:
      string name
    • setDisplayName

      public void setDisplayName(String displayName)
      Set up the display name of the file.
      Parameters:
      displayName - string name
    • getDescription

      public String getDescription()
      Return the description of the file.
      Returns:
      string description
    • setDescription

      public void setDescription(String description)
      Set up the description of the file.
      Parameters:
      description - string description
    • getIsDeprecated

      public boolean getIsDeprecated()
      Is the schema element deprecated?
      Returns:
      boolean flag
    • setIsDeprecated

      public void setIsDeprecated(boolean deprecated)
      Set whether the schema element deprecated or not. Default is false.
      Parameters:
      deprecated - boolean flag
    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class ReferenceableProperties
      Returns:
      return string containing the property names and values
    • equals

      public boolean equals(Object objectToCompare)
      Return comparison result based on the content of the properties.
      Overrides:
      equals in class ReferenceableProperties
      Parameters:
      objectToCompare - test object
      Returns:
      result of comparison
    • hashCode

      public int hashCode()
      Return hash code for this object
      Overrides:
      hashCode in class ReferenceableProperties
      Returns:
      int hash code