Package org.odpi.openmetadata.frameworks.openmetadata.metadataelements

Class AttributedMetadataElement

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.metadataelements.AttributedMetadataElement
All Implemented Interfaces:
MetadataElement
Direct Known Subclasses:
ActorProfileElement, ActorRoleElement, CollectionElement, DataDefinitionElement, GlossaryCategoryElement, GlossaryElement, GlossaryTermElement, InformationSupplyChainElement, ProjectElement, ToDoElement
public class AttributedMetadataElement extends Object implements MetadataElement
Description of an open metadata element (entity instance) retrieved from the open metadata repositories that is expected to have external references and other elements attached.

  • Constructor Details

    • AttributedMetadataElement

      public AttributedMetadataElement()
      Default constructor used by subclasses

    • AttributedMetadataElement

      public AttributedMetadataElement(AttributedMetadataElement template)
      Copy/clone constructor
      Parameters:
      template - template to copy

  • Method Details

    • getElementHeader

      public ElementHeader getElementHeader()
      Return the element header associated with the properties.
      Specified by:
      getElementHeader in interface MetadataElement
      Returns:
      element header object

    • setElementHeader

      public void setElementHeader(ElementHeader elementHeader)
      Set up the element header associated with the properties.
      Specified by:
      setElementHeader in interface MetadataElement
      Parameters:
      elementHeader - element header object

    • setExternalReferences

      public void setExternalReferences(List<RelatedMetadataElementSummary> externalReferences)
      Set up the list of external references for this element
      Parameters:
      externalReferences - list

    • getExternalReferences

      public List<RelatedMetadataElementSummary> getExternalReferences()
      Return the list of external references for this element.
      Returns:
      list

    • getMemberOfCollections

      public List<RelatedMetadataElementSummary> getMemberOfCollections()
      Return the list of collections that is definition is a member of.
      Returns:
      list

    • setMemberOfCollections

      public void setMemberOfCollections(List<RelatedMetadataElementSummary> memberOfCollections)
      Set up the list of collections that is definition is a member of.
      Parameters:
      memberOfCollections - list

    • getAlsoKnownAs

      public List<RelatedMetadataElementSummary> getAlsoKnownAs()
      Return attached external identifiers.
      Returns:
      list

    • setAlsoKnownAs

      public void setAlsoKnownAs(List<RelatedMetadataElementSummary> alsoKnownAs)
      Set up attached external identifiers.
      Parameters:
      alsoKnownAs - list

    • getSemanticAssignments

      public List<RelatedMetadataElementSummary> getSemanticAssignments()
      Return the glossary terms linked by semantic assignment.
      Returns:
      list

    • setSemanticAssignments

      public void setSemanticAssignments(List<RelatedMetadataElementSummary> semanticAssignments)
      Set up the glossary terms linked by semantic assignment.
      Parameters:
      semanticAssignments - list

    • getAttachedLikes

      public List<RelatedMetadataElementSummary> getAttachedLikes()
      Return the list of likes for this element.
      Returns:
      list

    • setAttachedLikes

      public void setAttachedLikes(List<RelatedMetadataElementSummary> attachedLikes)
      Set up the list of likes for this element.
      Parameters:
      attachedLikes - list

    • getAttachedTags

      public List<RelatedMetadataElementSummary> getAttachedTags()
      Return the attached informal tags.
      Returns:
      list

    • setAttachedTags

      public void setAttachedTags(List<RelatedMetadataElementSummary> attachedTags)
      Set up the attached informal tags.
      Parameters:
      attachedTags - list

    • getAttachedKeywords

      public List<RelatedMetadataElementSummary> getAttachedKeywords()
      Return the attached search keywords.
      Returns:
      list

    • setAttachedKeywords

      public void setAttachedKeywords(List<RelatedMetadataElementSummary> attachedKeywords)
      Set up the attached search keywords.
      Parameters:
      attachedKeywords - list

    • getAttachedComments

      public List<RelatedMetadataElementSummary> getAttachedComments()
      Return the attached comments.
      Returns:
      list

    • setAttachedComments

      public void setAttachedComments(List<RelatedMetadataElementSummary> attachedComments)
      Set up the attached comments.
      Parameters:
      attachedComments - list

    • getAttachedReviews

      public List<RelatedMetadataElementSummary> getAttachedReviews()
      Return the attached reviews (ratings).
      Returns:
      list

    • setAttachedReviews

      public void setAttachedReviews(List<RelatedMetadataElementSummary> attachedReviews)
      Set up the attached reviews (ratings).
      Parameters:
      attachedReviews - list

    • getOtherRelatedElements

      public List<RelatedMetadataElementSummary> getOtherRelatedElements()
      Return details of other related elements retrieved from the repository.
      Returns:
      list

    • setOtherRelatedElements

      public void setOtherRelatedElements(List<RelatedMetadataElementSummary> otherRelatedElements)
      Set up details of other related elements retrieved from the repository.
      Parameters:
      otherRelatedElements - list

    • getRelatedBy

      public RelatedBy getRelatedBy()
      Return details of the relationship used to retrieve this element. Will be null if the element was retrieved directly rather than via a relationship.
      Returns:
      list of element stubs

    • setRelatedBy

      public void setRelatedBy(RelatedBy relatedBy)
      Set up details of the relationship used to retrieve this element. Will be null if the element was retrieved directly rather than via a relationship.
      Parameters:
      relatedBy - relationship details

    • getMermaidGraph

      public String getMermaidGraph()
      Return the mermaid representation of this data structure.
      Returns:
      string markdown

    • setMermaidGraph

      public void setMermaidGraph(String mermaidGraph)
      Set up the mermaid representation of this data structure.
      Parameters:
      mermaidGraph - markdown string

    • 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()
      Create a hash code for this element type.
      Overrides:
      hashCode in class Object
      Returns:
      int hash code