Package org.odpi.openmetadata.frameworks.openmetadata.properties.glossaries

Class GlossaryTermRelationship

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.properties.RelationshipProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.glossaries.GlossaryTermRelationship
public class GlossaryTermRelationship extends RelationshipProperties
GlossaryTermRelationship describes a type of relationship between two glossary terms in a glossary.

  • Constructor Details

    • GlossaryTermRelationship

      public GlossaryTermRelationship()
      Default constructor

    • GlossaryTermRelationship

      public GlossaryTermRelationship(GlossaryTermRelationship template)
      Copy/clone constructor.
      Parameters:
      template - template object to copy.

  • Method Details

    • setExpression

      public void setExpression(String expression)
      Set up the expression that describes the relationship.
      Parameters:
      expression - String name

    • getExpression

      public String getExpression()
      Returns the expression that describes the relationship.
      Returns:
      String name

    • setDescription

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

    • getDescription

      public String getDescription()
      Return the description for the relationship.
      Returns:
      String description

    • getConfidence

      public int getConfidence()
      Return the level of confidence that the relationship is correct. 0 means unassigned. Typical assigned values are usually between 1-100 as a percentage scale.
      Returns:
      int

    • setConfidence

      public void setConfidence(int confidence)
      Set up the level of confidence that the relationship is correct. 0 means unassigned. Typical assigned values are usually between 1-100 as a percentage scale.
      Parameters:
      confidence - int

    • setStatus

      public void setStatus(GlossaryTermRelationshipStatus status)
      Set up whether this relationship should be used.
      Parameters:
      status - status enum (draft, active, deprecated, obsolete, other)

    • getStatus

      public GlossaryTermRelationshipStatus getStatus()
      Returns whether this relationship should be used.
      Returns:
      status enum (draft, active, deprecated, obsolete, other)

    • setSteward

      public void setSteward(String steward)
      Set up the id of the steward who assigned the relationship (or approved the discovered value).
      Parameters:
      steward - user id or name of steward

    • getSteward

      public String getSteward()
      Returns the name of the steward who assigned the relationship (or approved the discovered value).
      Returns:
      user id or name of steward

    • setSource

      public void setSource(String source)
      Set up the id of the source of the knowledge of the relationship.
      Parameters:
      source - String id

    • getSource

      public String getSource()
      Returns the id of the source of the knowledge of the relationship.
      Returns:
      String id

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class RelationshipProperties
      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 RelationshipProperties
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Return hash code based on properties.
      Overrides:
      hashCode in class RelationshipProperties
      Returns:
      int