Package org.odpi.openmetadata.accessservices.datamanager.properties

Class DatabaseForeignKeyProperties

java.lang.Object

org.odpi.openmetadata.accessservices.datamanager.properties.RelationshipProperties

org.odpi.openmetadata.accessservices.datamanager.properties.DatabaseForeignKeyProperties

All Implemented Interfaces:

Serializable

public class DatabaseForeignKeyProperties
extends RelationshipProperties

DatabaseForeignKeyProperties 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

Constructor Summary

Constructors

Constructor	Description
DatabaseForeignKeyProperties()	Default constructor
DatabaseForeignKeyProperties(DatabaseForeignKeyProperties template)	Copy/clone constructor for an foreign key.

Method Summary

Modifier and Type	Method	Description
boolean	equals(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.
String	getDescription()	Return the description for the foreign key.
String	getName()	Returns the stored display name property for the foreign key.
String	getSource()	Returns the id of the source of the knowledge of the foreign key.
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(String description)	Set up description of the foreign key.
void	setName(String name)	Set up the display name for UIs and reports.
void	setSource(String source)	Set up the id of the source of the knowledge of the foreign key.
void	setSteward(String steward)	Set up the id of the steward who assigned the foreign key (or approved the discovered value).
String	toString()	Standard toString method.

Methods inherited from class org.odpi.openmetadata.accessservices.datamanager.properties.RelationshipProperties

getEffectiveFrom, getEffectiveTo, getExtendedProperties, setEffectiveFrom, setEffectiveTo, setExtendedProperties

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DatabaseForeignKeyProperties

public DatabaseForeignKeyProperties()

Default constructor

DatabaseForeignKeyProperties

public DatabaseForeignKeyProperties(DatabaseForeignKeyProperties template)

Copy/clone constructor for an foreign key.

Parameters:

template - template object to copy.

Method Detail

setName

public void setName(String name)

Set up the display name for UIs and reports.

Parameters:

name - String name

getName

public String getName()

Returns the stored display name property for the foreign key.

Returns:

String name

setDescription

public void setDescription(String description)

Set up description of the foreign key.

Parameters:

description - String

getDescription

public 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(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 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(String source)

Set up the id of the source of the knowledge of the foreign key.

Parameters:

source - String id

getSource

public String getSource()

Returns the id of the source of the knowledge of the foreign key.

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