org.tentackle.sql.metadata

Class ForeignKeyMetaData

java.lang.Object

org.tentackle.sql.metadata.ForeignKeyMetaData

public class ForeignKeyMetaData
extends Object

Meta data for foreign keys.

Tentackle uses foreign keys only for simple columns (ID).

Author:

harald

Constructor Summary

Constructors

Constructor and Description
ForeignKeyMetaData(TableMetaData tableMetaData) Creates foreign key meta data.

Method Summary

Modifier and Type	Method and Description
void	addForeignKeyColumn(ForeignKeyColumnMetaData column) Adds a column to the fk.
boolean	equals(Object obj)
ForeignKeyAction	getDeleteRule() Gets the delete rule.
List<ForeignKeyColumnMetaData>	getForeignKeyColumns() Gets the columns.
String	getForeignKeyName() Gets the name of the foreign key.
String	getForeignKeySchema() Geths the schema of the referencing column.
String	getForeignKeyTable() Gets the referencing table.
String	getFullForeignKeyTableName() Gets the full foreign key tablename including optional schema.
String	getFullPrimaryKeyTableName() Gets the full primary key tablename including optional schema.
String	getPrimaryKeySchema() Gets the schema of the referenced column.
String	getPrimaryKeyTable() Gets the referenced table.
TableMetaData	getTableMetaData() Gets the table this foreign key belongs to.
ForeignKeyAction	getUpdateRule() Gets the update rule.
int	hashCode()
void	setupForeignKeyFromMetaData(ResultSet resultSet) Sets up the foreign key from the database meta data result.
String	toString()
void	validate() Validates and postprocesses the foreign key data.

Methods inherited from class java.lang.Object

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

Constructor Detail

ForeignKeyMetaData

public ForeignKeyMetaData(TableMetaData tableMetaData)

Creates foreign key meta data.

Parameters:

tableMetaData - the tablethis fk belongs to

Method Detail

addForeignKeyColumn

public void addForeignKeyColumn(ForeignKeyColumnMetaData column)

Adds a column to the fk.

Parameters:

column - the column

getForeignKeyColumns

public List<ForeignKeyColumnMetaData> getForeignKeyColumns()

Gets the columns.

Returns:

the columns ordered by position

getTableMetaData

public TableMetaData getTableMetaData()

Gets the table this foreign key belongs to.

Returns:

the table

getForeignKeyName

public String getForeignKeyName()

Gets the name of the foreign key.

Returns:

the fk name

getForeignKeySchema

public String getForeignKeySchema()

Geths the schema of the referencing column.

Returns:

the referencing schema, null if default

getForeignKeyTable

public String getForeignKeyTable()

Gets the referencing table.

Returns:

the table name

getFullForeignKeyTableName

public String getFullForeignKeyTableName()

Gets the full foreign key tablename including optional schema.

Returns:

the full tablename

getPrimaryKeySchema

public String getPrimaryKeySchema()

Gets the schema of the referenced column.

Returns:

the referenced schema, null if default

getPrimaryKeyTable

public String getPrimaryKeyTable()

Gets the referenced table.

Returns:

the table name

getFullPrimaryKeyTableName

public String getFullPrimaryKeyTableName()

Gets the full primary key tablename including optional schema.

Returns:

the full tablename

getUpdateRule

public ForeignKeyAction getUpdateRule()

Gets the update rule.

Returns:

the update rule

getDeleteRule

public ForeignKeyAction getDeleteRule()

Gets the delete rule.

Returns:

the delete rule

setupForeignKeyFromMetaData

public void setupForeignKeyFromMetaData(ResultSet resultSet)
                                 throws SQLException

Sets up the foreign key from the database meta data result.

Parameters:

resultSet - the foreign key column result set

Throws:

SQLException - the processing the result set failed

validate

public void validate()

Validates and postprocesses the foreign key data.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object