Package org.odpi.openmetadata.viewservices.automatedcuration.properties

Class RefDataElementBase

java.lang.Object
org.odpi.openmetadata.viewservices.automatedcuration.properties.RefDataElementBase
Direct Known Subclasses:
CatalogTemplate, ResourceDescription
public class RefDataElementBase extends Object
RefDataElementBase provides the base class for an element that is defined using metadata.

  • Field Details

    • displayName

      protected String displayName

    • description

      protected String description

    • additionalProperties

      protected Map<String,String> additionalProperties

  • Constructor Details

    • RefDataElementBase

      public RefDataElementBase()
      Default constructor

    • RefDataElementBase

      public RefDataElementBase(RefDataElementBase template)
      Default constructor

  • Method Details

    • getDisplayName

      public String getDisplayName()
      Returns the display name property for the element. If no name is available then null is returned.
      Returns:
      String name

    • setDisplayName

      public void setDisplayName(String displayName)
      Set up the name property for the element.
      Parameters:
      displayName - String name

    • getDescription

      public String getDescription()
      Returns the description property for the element. If no description is provided then null is returned.
      Returns:
      description String text

    • setDescription

      public void setDescription(String description)
      Set up the description property associated with the element.
      Parameters:
      description - String text

    • getAdditionalProperties

      public Map<String,String> getAdditionalProperties()
      Return a copy of the additional properties. Null means no additional properties are available.
      Returns:
      AdditionalProperties

    • setAdditionalProperties

      public void setAdditionalProperties(Map<String,String> additionalProperties)
      Set up additional properties.
      Parameters:
      additionalProperties - Additional properties object

    • getSpecification

      public Map<String,List<SpecificationProperty>> getSpecification()
      Return the specification reference data for the attached element.
      Returns:
      specification (attributeName, list[propertyName, propertyValue])

    • setSpecification

      public void setSpecification(Map<String,List<SpecificationProperty>> specification)
      Set up the specification reference data for the attached element.
      Parameters:
      specification - specification

    • getSpecificationMermaidGraph

      public String getSpecificationMermaidGraph()
      Return the mermaid graph of a linked specification if there is one.
      Returns:
      mermaid markdown

    • setSpecificationMermaidGraph

      public void setSpecificationMermaidGraph(String specificationMermaidGraph)
      Set up the mermaid graph of a linked specification if there is one.
      Parameters:
      specificationMermaidGraph - mermaid markdown

    • getRelatedElement

      public MetadataElementSummary getRelatedElement()
      Return the element header associated with the technology type.
      Returns:
      element stub object

    • setRelatedElement

      public void setRelatedElement(MetadataElementSummary relatedElement)
      Set up the element header associated with the technology type.
      Parameters:
      relatedElement - element stub object

    • toString

      public String toString()
      Generate a string containing the properties.
      Overrides:
      toString in class Object
      Returns:
      string value