Package org.odpi.openmetadata.adapters.repositoryservices.postgres.repositoryconnector.schema

Enum Class RepositoryForeignKey

java.lang.Object

java.lang.Enum<RepositoryForeignKey>

org.odpi.openmetadata.adapters.repositoryservices.postgres.repositoryconnector.schema.RepositoryForeignKey

All Implemented Interfaces:

Serializable, Comparable<RepositoryForeignKey>, Constable, org.odpi.openmetadata.adapters.connectors.resource.jdbc.ddl.postgres.PostgreSQLForeignKey

public enum RepositoryForeignKey
extends Enum<RepositoryForeignKey>
implements org.odpi.openmetadata.adapters.connectors.resource.jdbc.ddl.postgres.PostgreSQLForeignKey

Defines a foreign key relationship between two tables.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
VALID_CLASSIFICATION_NAME
VALID_END_1_GUID
VALID_END_2_GUID
VALID_ENTITY_GUID
VALID_RELATIONSHIP_GUID

Method Summary

Modifier and Type	Method	Description
String	getConstraintName()	Return the name of the constraint.
org.odpi.openmetadata.adapters.connectors.resource.jdbc.ddl.postgres.PostgreSQLColumn	getForeignKeyColumn()	Return the column in the table that is the foreign key.
org.odpi.openmetadata.adapters.connectors.resource.jdbc.ddl.postgres.PostgreSQLColumn	getReferenceColumn()	Return the primary key column in the reference table.
org.odpi.openmetadata.adapters.connectors.resource.jdbc.ddl.postgres.PostgreSQLTable	getReferenceTable()	Return details of the table where the primary key is located.
boolean	isDeleteCascade()	If the row with the primary key is deleted, should the rows with the foreign key also be deleted?
boolean	isUpdateCascade()	If the primary key value is changed, should the foreign key values change too?
static RepositoryForeignKey	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RepositoryForeignKey[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

VALID_ENTITY_GUID

public static final RepositoryForeignKey VALID_ENTITY_GUID

VALID_END_1_GUID

public static final RepositoryForeignKey VALID_END_1_GUID

VALID_END_2_GUID

public static final RepositoryForeignKey VALID_END_2_GUID

VALID_RELATIONSHIP_GUID

public static final RepositoryForeignKey VALID_RELATIONSHIP_GUID

VALID_CLASSIFICATION_NAME

public static final RepositoryForeignKey VALID_CLASSIFICATION_NAME

Method Details

values

public static RepositoryForeignKey[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static RepositoryForeignKey valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getConstraintName

public String getConstraintName()

Return the name of the constraint.

Specified by:

getConstraintName in interface org.odpi.openmetadata.adapters.connectors.resource.jdbc.ddl.postgres.PostgreSQLForeignKey

Returns:

name

getForeignKeyColumn

public org.odpi.openmetadata.adapters.connectors.resource.jdbc.ddl.postgres.PostgreSQLColumn getForeignKeyColumn()

Return the column in the table that is the foreign key.

Specified by:

getForeignKeyColumn in interface org.odpi.openmetadata.adapters.connectors.resource.jdbc.ddl.postgres.PostgreSQLForeignKey

Returns:

column

getReferenceTable

public org.odpi.openmetadata.adapters.connectors.resource.jdbc.ddl.postgres.PostgreSQLTable getReferenceTable()

Return details of the table where the primary key is located.

Specified by:

getReferenceTable in interface org.odpi.openmetadata.adapters.connectors.resource.jdbc.ddl.postgres.PostgreSQLForeignKey

Returns:

table

getReferenceColumn

public org.odpi.openmetadata.adapters.connectors.resource.jdbc.ddl.postgres.PostgreSQLColumn getReferenceColumn()

Return the primary key column in the reference table.

Specified by:

getReferenceColumn in interface org.odpi.openmetadata.adapters.connectors.resource.jdbc.ddl.postgres.PostgreSQLForeignKey

Returns:

column

isDeleteCascade

public boolean isDeleteCascade()

If the row with the primary key is deleted, should the rows with the foreign key also be deleted?

Specified by:

isDeleteCascade in interface org.odpi.openmetadata.adapters.connectors.resource.jdbc.ddl.postgres.PostgreSQLForeignKey

Returns:

boolean

isUpdateCascade

public boolean isUpdateCascade()

If the primary key value is changed, should the foreign key values change too?

Specified by:

isUpdateCascade in interface org.odpi.openmetadata.adapters.connectors.resource.jdbc.ddl.postgres.PostgreSQLForeignKey

Returns:

boolean