com.ontimize.db.sql

Class SQLForeignKey

java.lang.Object

com.ontimize.db.sql.SQLConstraint

com.ontimize.db.sql.SQLForeignKey

All Implemented Interfaces:

Serializable

public class SQLForeignKey
extends SQLConstraint

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	FOREIGN_KEY
protected List	foreignColumns The list of columns of the referenced table in where the constraint is applied.
protected static String	REFERENCES
protected String	secondaryTable The name of the referenced table

Fields inherited from class com.ontimize.db.sql.SQLConstraint

columns, CONSTRAINT, constraintName

Constructor Summary

Constructors

Constructor and Description
SQLForeignKey(String constraintName)
SQLForeignKey(String secondaryTable, Hashtable keys)
SQLForeignKey(String constraintName, String secondaryTable, Hashtable keys)

Method Summary

Methods

Modifier and Type	Method and Description
List	getForeignColumns() This method returns the list of column/s of the referenced table that are going to be used into the constraint.
String	getSecondaryTable() Returns the name of the referenced table.
void	setKeys(Hashtable keys)
void	setSecondaryTable(String secondaryTable) This method sets the name of the referenced table of the Foreign key.
String	toString() This method returns the SQL Statement to add a Foreign Key constraint to a database table.

Methods inherited from class com.ontimize.db.sql.SQLConstraint

getColumnList, getColumns, getConstraintName, setConstraintName

Methods inherited from class java.lang.Object

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

Field Detail

FOREIGN_KEY

protected static final String FOREIGN_KEY

See Also:

Constant Field Values

REFERENCES

protected static final String REFERENCES

See Also:

Constant Field Values

secondaryTable

protected String secondaryTable

The name of the referenced table

foreignColumns

protected List foreignColumns

The list of columns of the referenced table in where the constraint is applied.

Constructor Detail

SQLForeignKey

public SQLForeignKey(String secondaryTable,
             Hashtable keys)

Parameters:

secondaryTable - The table, in which the restriction is made,

keys - Must contains a pair key-value, where key is the table column and value is the name of reference column.

SQLForeignKey

public SQLForeignKey(String constraintName,
             String secondaryTable,
             Hashtable keys)

Parameters:

constraintName - The name of the constraint.

secondaryTable - The table, in which the restriction is made,

keys - Must contains a pair key-value, where key is the table column and value is the name of reference column.

SQLForeignKey

public SQLForeignKey(String constraintName)

Parameters:

constraintName - The name of the constraint.

Method Detail

getForeignColumns

public List getForeignColumns()

This method returns the list of column/s of the referenced table that are going to be used into the constraint.

Returns:

a String with the column/s between parenthesis

setKeys

public void setKeys(Hashtable keys)

Parameters:

keys - Must contains a pair key-value, where key is the table column and value is the name of reference column.

getSecondaryTable

public String getSecondaryTable()

Returns the name of the referenced table. The table, in which the restriction is made.

Returns:

a String with the name of the referenced table.

setSecondaryTable

public void setSecondaryTable(String secondaryTable)

This method sets the name of the referenced table of the Foreign key.

Parameters:

secondaryTable - String with the name of the referenced table.

toString

public String toString()

This method returns the SQL Statement to add a Foreign Key constraint to a database table. Returns a String with the SQL Statement

Overrides:

toString in class Object