Class ForeignKeyProperties

  • All Implemented Interfaces:
    java.io.Serializable

    public class ForeignKeyProperties
    extends RelationshipProperties
    ForeignKeyProperties describes a foreign key relationship between two columns in different tables in a database. The foreign key shows where the primary key of one table is used in another table to show they are related. Foreign key relationships are typically discovered from analysis of the values stored in the rows, or asserted by the DBA/steward.
    See Also:
    Serialized Form
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object objectToCompare)
      Compare the values of the supplied object with those stored in the current object.
      int getConfidence()
      Returns the level of confidence that the foreign key is correct.
      java.lang.String getDescription()
      Return the description for the foreign key.
      java.lang.String getName()
      Returns the stored display name property for the foreign key.
      java.lang.String getSource()
      Returns the id of the source of the knowledge of the foreign key.
      java.lang.String getSteward()
      Returns the name of the steward who assigned the foreign key (or approved the discovered value).
      int hashCode()
      Return hash code based on properties.
      void setConfidence​(int confidence)
      Set up the level of confidence that the foreign key is correct.
      void setDescription​(java.lang.String description)
      Set up description of the foreign key.
      void setName​(java.lang.String name)
      Set up the display name for UIs and reports.
      void setSource​(java.lang.String source)
      Set up the id of the source of the knowledge of the foreign key.
      void setSteward​(java.lang.String steward)
      Set up the id of the steward who assigned the foreign key (or approved the discovered value).
      java.lang.String toString()
      Standard toString method.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • ForeignKeyProperties

        public ForeignKeyProperties()
        Default constructor
      • ForeignKeyProperties

        public ForeignKeyProperties​(ForeignKeyProperties template)
        Copy/clone constructor for a foreign key.
        Parameters:
        template - template object to copy.
    • Method Detail

      • setName

        public void setName​(java.lang.String name)
        Set up the display name for UIs and reports.
        Parameters:
        name - String name
      • getName

        public java.lang.String getName()
        Returns the stored display name property for the foreign key.
        Returns:
        String name
      • setDescription

        public void setDescription​(java.lang.String description)
        Set up description of the foreign key.
        Parameters:
        description - String
      • getDescription

        public java.lang.String getDescription()
        Return the description for the foreign key.
        Returns:
        String description
      • setConfidence

        public void setConfidence​(int confidence)
        Set up the level of confidence that the foreign key is correct. This is a value between 0 and 100.
        Parameters:
        confidence - int
      • getConfidence

        public int getConfidence()
        Returns the level of confidence that the foreign key is correct. This is a value between 0 and 100.
        Returns:
        int
      • setSteward

        public void setSteward​(java.lang.String steward)
        Set up the id of the steward who assigned the foreign key (or approved the discovered value).
        Parameters:
        steward - user id or name of steward
      • getSteward

        public java.lang.String getSteward()
        Returns the name of the steward who assigned the foreign key (or approved the discovered value).
        Returns:
        user id or name of steward
      • setSource

        public void setSource​(java.lang.String source)
        Set up the id of the source of the knowledge of the foreign key.
        Parameters:
        source - String id
      • getSource

        public java.lang.String getSource()
        Returns the id of the source of the knowledge of the foreign key.
        Returns:
        String id
      • toString

        public java.lang.String toString()
        Standard toString method.
        Overrides:
        toString in class RelationshipProperties
        Returns:
        print out of variables in a JSON-style
      • equals

        public boolean equals​(java.lang.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