Package org.odpi.openmetadata.frameworks.governanceaction.properties

Class OpenMetadataAttributeTypeDef

java.lang.Object
org.odpi.openmetadata.frameworks.governanceaction.properties.OpenMetadataTypeDefElementHeader
org.odpi.openmetadata.frameworks.governanceaction.properties.OpenMetadataAttributeTypeDef
Direct Known Subclasses:
OpenMetadataCollectionDef, OpenMetadataEnumDef, OpenMetadataPrimitiveDef
public abstract class OpenMetadataAttributeTypeDef extends OpenMetadataTypeDefElementHeader
The OpenMetadataAttributeTypeDef class is used to identify the type of an attribute. These can be:
  • OpenMetadataPrimitiveDef
  • OpenMetadataCollectionDef
  • OpenMetadataEnumDef

  • Field Details

  • Constructor Details

    • OpenMetadataAttributeTypeDef

      protected OpenMetadataAttributeTypeDef()
      Default constructor

    • OpenMetadataAttributeTypeDef

      protected OpenMetadataAttributeTypeDef(OpenMetadataAttributeTypeDefCategory category)
      Minimal constructor is passed the category of the attribute type. Note that since OpenMetadataAttributeTypeDef is an abstract class, this method can only be called from a subclass.
      Parameters:
      category - category of this OpenMetadataTypeDef

    • OpenMetadataAttributeTypeDef

      protected OpenMetadataAttributeTypeDef(OpenMetadataAttributeTypeDefCategory category, String guid, String name)
      Typical constructor is passed the values that describe the type. Note that since OpenMetadataAttributeTypeDef is an abstract class, this method can only be called from a subclass.
      Parameters:
      category - category of this OpenMetadataTypeDef
      guid - unique id for the OpenMetadataTypeDef
      name - unique name for the OpenMetadataTypeDef

    • OpenMetadataAttributeTypeDef

      protected OpenMetadataAttributeTypeDef(OpenMetadataAttributeTypeDef template)
      Copy/clone constructor copies the values from the supplied template. Note that since OpenMetadataAttributeTypeDef is an abstract class, this method can only be called from a subclass.
      Parameters:
      template - OpenMetadataAttributeTypeDef

  • Method Details

    • cloneFromSubclass

      public abstract OpenMetadataAttributeTypeDef cloneFromSubclass()
      Delegate the process of cloning to the subclass.
      Returns:
      subclass of OpenMetadataAttributeTypeDef

    • getVersion

      public long getVersion()
      Return the version of the OpenMetadataAttributeTypeDef. Versions are created when an OpenMetadataAttributeTypeDef's properties are changed. If a description is updated, then this does not create a new version.
      Returns:
      String version number

    • setVersion

      public void setVersion(long version)
      Set up the version of the OpenMetadataAttributeTypeDef. Versions are created when an OpenMetadataAttributeTypeDef's properties are changed. If a description is updated, then this does not create a new version.
      Parameters:
      version - long version number

    • getVersionName

      public String getVersionName()
      Return the version name, which is a more of a human readable form of the version number. It can be used to show whether the change is a minor or major update.
      Returns:
      String version name

    • setVersionName

      public void setVersionName(String versionName)
      Set up the version name, which is a more of a human readable form of the version number. It can be used to show whether the change is a minor or major update.
      Parameters:
      versionName - String version name

    • getCategory

      public OpenMetadataAttributeTypeDefCategory getCategory()
      Return the category of the OpenMetadataTypeDef.
      Returns:
      OpenMetadataAttributeTypeDefCategory enum

    • setCategory

      public void setCategory(OpenMetadataAttributeTypeDefCategory category)
      Set up the category of the OpenMetadataTypeDef.
      Parameters:
      category - OpenMetadataAttributeTypeDefCategory enum

    • getGUID

      public String getGUID()
      Return the unique identifier for this OpenMetadataTypeDef.
      Returns:
      String guid

    • setGUID

      public void setGUID(String guid)
      Set up the unique identifier for this OpenMetadataTypeDef.
      Parameters:
      guid - String guid

    • getName

      public String getName()
      Return the type name for this OpenMetadataTypeDef. In simple environments, the type name is unique but where metadata repositories from different vendors are in operation it is possible that 2 types may have a name clash. The GUID is the reliable unique identifier.
      Returns:
      String name

    • setName

      public void setName(String name)
      Set up the type name for this OpenMetadataTypeDef. In simple environments, the type name is unique but where metadata repositories from different vendors are in operation it is possible that 2 types may have a name clash. The GUID is the reliable unique identifier.
      Parameters:
      name - String name

    • getDescription

      public String getDescription()
      Return the short description of this OpenMetadataAttributeTypeDef.
      Returns:
      String description

    • setDescription

      public void setDescription(String description)
      Set up the short description of this OpenMetadataAttributeTypeDef.
      Parameters:
      description - String description

    • getDescriptionGUID

      public String getDescriptionGUID()
      Return the unique identifier of the glossary term that describes this OpenMetadataAttributeTypeDef. Null means there is no known glossary term.
      Returns:
      String guid

    • setDescriptionGUID

      public void setDescriptionGUID(String descriptionGUID)
      Set up the unique identifier of the glossary term that describes this OpenMetadataAttributeTypeDef. Null means there is no known glossary term.
      Parameters:
      descriptionGUID - String guid

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Object
      Returns:
      JSON style description of variables.

    • equals

      public boolean equals(Object objectToCompare)
      Validate that an object is equal depending on their stored values.
      Overrides:
      equals in class Object
      Parameters:
      objectToCompare - object
      Returns:
      boolean result

    • hashCode

      public int hashCode()
      Return a hash code based on the values of this object.
      Overrides:
      hashCode in class Object
      Returns:
      in hash code