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

Class DataFieldLink

java.lang.Object
org.odpi.openmetadata.frameworks.discovery.properties.PropertyBase
org.odpi.openmetadata.frameworks.discovery.properties.DataFieldLink
All Implemented Interfaces:
Serializable
public class DataFieldLink extends PropertyBase
DataFieldLink describes the properties of a peer to peer relationship between data fields.
See Also:

  • Constructor Details

    • DataFieldLink

      public DataFieldLink()
      Default constructor

    • DataFieldLink

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

  • Method Details

    • getRelationshipEnd

      public int getRelationshipEnd()
      Return the logical end of the relationship. Use 0 if this does not make sense.
      Returns:
      integer

    • setRelationshipEnd

      public void setRelationshipEnd(int relationshipEnd)
      Set up the logical end of the relationship. Use 0 if this does not make sense.
      Parameters:
      relationshipEnd - integer

    • getRelationshipTypeName

      public String getRelationshipTypeName()
      Return the name of this relationship between data fields.
      Returns:
      string name

    • setRelationshipTypeName

      public void setRelationshipTypeName(String relationshipTypeName)
      Set up the name of this relationship between data fields.
      Parameters:
      relationshipTypeName - string name

    • getName

      public String getName()
      Return the name of this data field link.
      Returns:
      string name

    • setName

      public void setName(String name)
      Set up the name of this data field link.
      Parameters:
      name - string name

    • getDescription

      public String getDescription()
      Return description of this data field link.
      Returns:
      text

    • setDescription

      public void setDescription(String description)
      Set up the description of this data field link.
      Parameters:
      description - text

    • getMinCardinality

      public int getMinCardinality()
      Return this minimum number of instances allowed for this data field link.
      Returns:
      int

    • setMinCardinality

      public void setMinCardinality(int minCardinality)
      Set up the minimum number of instances allowed for this data field link.
      Parameters:
      minCardinality - int

    • getMaxCardinality

      public int getMaxCardinality()
      Return the maximum number of instances allowed for this data field link.
      Returns:
      int (-1 means infinite)

    • setMaxCardinality

      public void setMaxCardinality(int maxCardinality)
      Set up the maximum number of instances allowed for this data field link.
      Parameters:
      maxCardinality - int (-1 means infinite)

    • getAdditionalProperties

      public Map<String,String> getAdditionalProperties()
      Return any additional properties.
      Returns:
      map of property name to property value

    • setAdditionalProperties

      public void setAdditionalProperties(Map<String,String> additionalProperties)
      Set up any additional properties.
      Parameters:
      additionalProperties - map of property name to property value

    • 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