org.sql.generation.api.grammar.definition.table
Interface ForeignKeyConstraint

All Superinterfaces:

TableConstraint, org.atp.api.Typeable<TableConstraint>

public interface ForeignKeyConstraint
extends TableConstraint

This syntax element represents the FOREIGN KEY(col1, col2, ...) ... table constraint in table definition.

Author:

Stanislav Muhametsin

See Also:

TableConstraint, TableDefinition

Method Summary

MatchType	getMatchType() Returns the match type for this foreign key.
ReferentialAction	getOnDelete() Returns the referential action of deleting the rows.
ReferentialAction	getOnUpdate() Returns the referential action of updating the rows.
ColumnNameList	getSourceColumns() Returns the list of column names in this table.
ColumnNameList	getTargetColumns() Returns the list of column names in target table.
TableName	getTargetTableName() Returns the name of the table where the columns in this table are referencing to.

Methods inherited from interface org.atp.api.Typeable

getImplementedType

Method Detail

getSourceColumns

ColumnNameList getSourceColumns()

Returns the list of column names in this table.

Returns:

The list of column names in this table.

getTargetTableName

TableName getTargetTableName()

Returns the name of the table where the columns in this table are referencing to.

Returns:

The name of the table where the columns in this table are referencing to.

getTargetColumns

ColumnNameList getTargetColumns()

Returns the list of column names in target table. Will be null if none specified.

Returns:

The list of column names in target table. Will be null if none specified.

getMatchType

MatchType getMatchType()

Returns the match type for this foreign key. May be null if no match type is specified.

Returns:

The match type for this foreign key. May be null if no match type is specified.

getOnUpdate

ReferentialAction getOnUpdate()

Returns the referential action of updating the rows. May be null if none specified.

Returns:

The referential action of updating the rows. May be null if none specified.

See Also:

ReferentialAction

getOnDelete

ReferentialAction getOnDelete()

Returns the referential action of deleting the rows. May be null if none specified.

Returns:

The referential action of deleting the rows. May be null if none specified.

See Also:

ReferentialAction