Package org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs

Class TypeDef

java.lang.Object
org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.RepositoryElementHeader
org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefElementHeader
org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefLink
org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefSummary
org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
ClassificationDef, EntityDef, RelationshipDef
public abstract class TypeDef extends TypeDefSummary
The TypeDef is the base class for objects that store the properties of an open metadata type definition (call ed a TypeDef).

The different categories of Typedefs are listed in TypeDefCategory.

See Also:

  • Field Details

  • Constructor Details

    • TypeDef

      protected TypeDef()
      Default constructor

    • TypeDef

      protected TypeDef(TypeDefCategory category)
      Minimal constructor is passed the category of the typedef being constructed. The rest of the properties are null.
      Parameters:
      category - TypeDefCategory enum

    • TypeDef

      protected TypeDef(TypeDef template)
      Copy/clone constructor copies the values from the supplied template.
      Parameters:
      template - TypeDef

  • Method Details

    • cloneFromSubclass

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

    • getSuperType

      public TypeDefLink getSuperType()
      Return the super type for the TypeDef (or null if top-level)
      Returns:
      TypeDefLink for the super type

    • setSuperType

      public void setSuperType(TypeDefLink superType)
      Set up supertype for the TypeDef. Only single inheritance is supported. Use null if this type is top-level.
      Parameters:
      superType - TypeDefLink for the super type

    • getDescription

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

    • setDescription

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

    • getDescriptionGUID

      public String getDescriptionGUID()
      Return the unique identifier (guid) of the valid value definition that describes this TypeDef.
      Returns:
      String guid

    • setDescriptionGUID

      public void setDescriptionGUID(String descriptionGUID)
      Set up the unique identifier (guid) of the valid value definition that describes this TypeDef.
      Parameters:
      descriptionGUID - String guid

    • getDescriptionWiki

      public String getDescriptionWiki()
      Return the URL to the wiki page that gives more information for this type.
      Returns:
      url string

    • setDescriptionWiki

      public void setDescriptionWiki(String descriptionWiki)
      Set up the URL to the wiki page that gives more information for this type.
      Parameters:
      descriptionWiki - url string

    • getOrigin

      public String getOrigin()
      Return the unique identifier for metadata collection id where this TypeDef came from.
      Returns:
      String guid

    • setOrigin

      public void setOrigin(String origin)
      Set up the unique identifier for metadata collection id where this TypeDef came from.
      Parameters:
      origin - String guid

    • getCreatedBy

      public String getCreatedBy()
      Return the user name of the person that created this TypeDef.
      Returns:
      String name

    • setCreatedBy

      public void setCreatedBy(String createdBy)
      Set up the user name of the person that created this TypeDef.
      Parameters:
      createdBy - String name

    • getUpdatedBy

      public String getUpdatedBy()
      Return the user name of the person that last updated this TypeDef.
      Returns:
      String name

    • setUpdatedBy

      public void setUpdatedBy(String updatedBy)
      Set up the user name of the person that last updated this TypeDef.
      Parameters:
      updatedBy - String name

    • getCreateTime

      public Date getCreateTime()
      Return the date/time that this TypeDef was created.
      Returns:
      Date

    • setCreateTime

      public void setCreateTime(Date createTime)
      Set up the date/time that this TypeDef was created.
      Parameters:
      createTime - Date

    • getUpdateTime

      public Date getUpdateTime()
      Return the date/time that this TypeDef was last updated.
      Returns:
      Date

    • setUpdateTime

      public void setUpdateTime(Date updateTime)
      Set up the date/time that this TypeDef was last updated.
      Parameters:
      updateTime - Date

    • getOptions

      public Map<String,String> getOptions()
      Return the options for this TypeDef. These are private properties used by the processors of this TypeDef and ignored by the OMRS.
      Returns:
      Map from String to String

    • setOptions

      public void setOptions(Map<String,String> options)
      Set up the options for this TypeDef. These are private properties used by the processors of this TypeDef and ignored by the OMRS.
      Parameters:
      options - Map from String to String

    • getExternalStandardMappings

      public List<ExternalStandardMapping> getExternalStandardMappings()
      Return the list of mappings to external standards.
      Returns:
      ExternalStandardMappings list

    • setExternalStandardMappings

      public void setExternalStandardMappings(List<ExternalStandardMapping> externalStandardMappings)
      Set up the list of mappings to external standards.
      Parameters:
      externalStandardMappings - ExternalStandardMappings list

    • getValidInstanceStatusList

      public List<InstanceStatus> getValidInstanceStatusList()
      Return the list of valid statuses for an instance of this TypeDef.
      Returns:
      list of valid statuses

    • setValidInstanceStatusList

      public void setValidInstanceStatusList(List<InstanceStatus> validInstanceStatusList)
      Set up the list of valid instance statuses supported by this TypeDef.
      Parameters:
      validInstanceStatusList - InstanceStatus Array

    • getInitialStatus

      public InstanceStatus getInitialStatus()
      Return the initial status setting for an instance of this type.
      Returns:
      InstanceStatus enum

    • setInitialStatus

      public void setInitialStatus(InstanceStatus initialStatus)
      Set up the initial status setting for an instance of this type.
      Parameters:
      initialStatus - InstanceStatus enum

    • getPropertiesDefinition

      public List<TypeDefAttribute> getPropertiesDefinition()
      Return the list of typeDefAttributes that are either new or changing.
      Returns:
      list of TypeDefAttribute

    • setPropertiesDefinition

      public void setPropertiesDefinition(List<TypeDefAttribute> propertiesDefinition)
      Set up the list of AttributeDefs that define the valid properties for this type of classification.
      Parameters:
      propertiesDefinition - AttributeDefs list

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class TypeDefSummary
      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 TypeDefSummary
      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 TypeDefSummary
      Returns:
      in hash code