Package org.odpi.openmetadata.frameworks.discovery.properties

Class RelationshipAdviceAnnotation

java.lang.Object
org.odpi.openmetadata.frameworks.discovery.properties.PropertyBase
org.odpi.openmetadata.frameworks.discovery.properties.Annotation
org.odpi.openmetadata.frameworks.discovery.properties.DataFieldAnnotation
org.odpi.openmetadata.frameworks.discovery.properties.RelationshipAdviceAnnotation
All Implemented Interfaces:
Serializable
public class RelationshipAdviceAnnotation extends DataFieldAnnotation
RelationshipAdviceAnnotation is used to record a recommendation that a new relationship should be made from this data field to another object in the open metadata types.
See Also:

  • Constructor Details

    • RelationshipAdviceAnnotation

      public RelationshipAdviceAnnotation()
      Default constructor

    • RelationshipAdviceAnnotation

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

  • Method Details

    • getRelatedEntityGUID

      public String getRelatedEntityGUID()
      Return the unique identifier of the object to connect to.
      Returns:
      string guid

    • setRelatedEntityGUID

      public void setRelatedEntityGUID(String relatedEntityGUID)
      Set up the unique identifier of the object to connect to.
      Parameters:
      relatedEntityGUID - string guid

    • getRelationshipTypeName

      public String getRelationshipTypeName()
      Return the type of relationship to create.
      Returns:
      type name

    • setRelationshipTypeName

      public void setRelationshipTypeName(String relationshipTypeName)
      Set up the type of relationship to create.
      Parameters:
      relationshipTypeName - type name

    • getRelationshipProperties

      public Map<String,String> getRelationshipProperties()
      Return the properties that should be stored in the relationship.
      Returns:
      map of property names to property values

    • setRelationshipProperties

      public void setRelationshipProperties(Map<String,String> relationshipProperties)
      Set up the properties that should be stored in the relationship.
      Parameters:
      relationshipProperties - map of property names to property values

    • toString

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