com.agimatec.sql.meta

Class ForeignKeyDescription

java.lang.Object

com.agimatec.sql.meta.A_IntegrityRuleDescription

com.agimatec.sql.meta.ForeignKeyDescription

All Implemented Interfaces:

Serializable, Cloneable

public class ForeignKeyDescription
extends A_IntegrityRuleDescription

Description: Hold information about a foreign key in the database
Copyright: Copyright (c) 2007

See Also:

Serialized Form

Field Summary

Fields inherited from class com.agimatec.sql.meta.A_IntegrityRuleDescription

tableName, tableSpace

Constructor Summary

Constructors

Constructor and Description
ForeignKeyDescription()

Method Summary

Methods

Modifier and Type	Method and Description
void	addColumnPair(String column, String refColumn)
boolean	containsColumn(String columnName)
ForeignKeyDescription	deepCopy()
String	getColumn(int i)
int	getColumn(String columnName)
List<String>	getColumns()
int	getColumnSize()
String	getComment()
String	getConstraintName()
String	getOnDeleteRule()
String	getRefColumn(int i)
int	getRefColumn(String columnName)
List<String>	getRefColumns()
String	getRefTableName()
boolean	isNullable(TableDescription aTable)
boolean	isSimilarTo(ForeignKeyDescription other) do NOT compare the constraintName, but the columns, refColumns, tables (independent of sequence)
void	setComment(String aComment)
void	setConstraintName(String aConstraintName)
void	setOnDeleteRule(String string)
void	setRefTableName(String aRefTableName)
String	toString()

Methods inherited from class com.agimatec.sql.meta.A_IntegrityRuleDescription

getTableName, getTableSpace, setTableName, setTableSpace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ForeignKeyDescription

public ForeignKeyDescription()

Method Detail

deepCopy

public ForeignKeyDescription deepCopy()

isSimilarTo

public boolean isSimilarTo(ForeignKeyDescription other)

do NOT compare the constraintName, but the columns, refColumns, tables (independent of sequence)

Parameters:

other -

Returns:

true when similar, false otherwise

isNullable

public boolean isNullable(TableDescription aTable)

Parameters:

aTable - - the tableDescription of My Table

Returns:

true when all of my columns are nullable

getConstraintName

public String getConstraintName()

setConstraintName

public void setConstraintName(String aConstraintName)

getRefTableName

public String getRefTableName()

setRefTableName

public void setRefTableName(String aRefTableName)

getComment

public String getComment()

setComment

public void setComment(String aComment)

getColumn

public int getColumn(String columnName)

getRefColumn

public int getRefColumn(String columnName)

getColumn

public String getColumn(int i)

Specified by:

getColumn in class A_IntegrityRuleDescription

getRefColumn

public String getRefColumn(int i)

getColumnSize

public int getColumnSize()

Specified by:

getColumnSize in class A_IntegrityRuleDescription

getColumns

public List<String> getColumns()

getRefColumns

public List<String> getRefColumns()

addColumnPair

public void addColumnPair(String column,
                 String refColumn)

toString

public String toString()

Overrides:

toString in class Object

containsColumn

public boolean containsColumn(String columnName)

setOnDeleteRule

public void setOnDeleteRule(String string)

getOnDeleteRule

public String getOnDeleteRule()