com.sptci.rwt
Class ForeignKeyMetaData

java.lang.Object
  com.sptci.rwt.MetaData
      com.sptci.rwt.KeyMetaData
          com.sptci.rwt.ForeignKeyMetaData

All Implemented Interfaces:

Serializable

public class ForeignKeyMetaData
extends KeyMetaData

A metadata object that represents foreign key constraint types.

© Copyright 2007 Sans Pareil Technologies, Inc.

Version:

$Id: ForeignKeyMetaData.java 4123 2008-05-25 21:49:01Z rakesh $

Author:

Rakesh Vidyadharan 2007-09-26

See Also:

Serialized Form

Nested Class Summary

static class	ForeignKeyMetaData.Deferrability The enumeration of deferrability for keys.
static class	ForeignKeyMetaData.Rule The enumeration of UPDATE_RULE and DELETE_RULE values for keys.

Field Summary

private Map<ColumnMetaData,String>	columnMappings The columns that comprise this foreign key and the referenced columns.
private ForeignKeyMetaData.Deferrability	deferrability The DEFERRABILITY of this key.
private ForeignKeyMetaData.Rule	deleteRule The DELETE_RULE for this key.
private String	referencedSchema The schema in which the table whose column this foreign key references exists.
private String	referencedTable The table whose column this foreign key references.
private ForeignKeyMetaData.Rule	updateRule The UPDATE_RULE for this key.

Constructor Summary

ForeignKeyMetaData()

Method Summary

protected void	addColumn(ColumnMetaData cmd, String column) Add the specified values to the KeyMetaData.columns map.
Map<ColumnMetaData,String>	getColumnMappings() Returns KeyMetaData.columns.
String	getDeferrability() Returns deferrability.
String	getDeleteRule() Returns deleteRule.
String	getReferencedSchema() Returns referencedSchema.
String	getReferencedTable() Returns referencedTable.
String	getUpdateRule() Returns updateRule.
protected void	setColumnMappings(Map<ColumnMetaData,String> columns) Set KeyMetaData.columns.
protected void	setDeferrability(ForeignKeyMetaData.Deferrability deferrability) Set deferrability.
protected void	setDeleteRule(ForeignKeyMetaData.Rule deleteRule) Set deleteRule.
protected void	setReferencedSchema(String referencedSchema) Set referencedSchema.
protected void	setReferencedTable(String referencedTable) Set referencedTable.
protected void	setUpdateRule(ForeignKeyMetaData.Rule updateRule) Set updateRule.

Methods inherited from class com.sptci.rwt.KeyMetaData

addColumn, getColumns, getKeySequence, getTable, setColumns, setKeySequence, setTable

Methods inherited from class com.sptci.rwt.MetaData

equals, getName, hashCode, setName, toString

Methods inherited from class java.lang.Object

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

Field Detail

referencedSchema

private String referencedSchema

The schema in which the table whose column this foreign key references exists.

referencedTable

private String referencedTable

The table whose column this foreign key references.

columnMappings

private Map<ColumnMetaData,String> columnMappings

The columns that comprise this foreign key and the referenced columns. The map is defined as <ColumnMetaData,String> with the key indicating the column on the table and the value indicating the referenced column on referencedTable.

updateRule

private ForeignKeyMetaData.Rule updateRule

The UPDATE_RULE for this key.

deleteRule

private ForeignKeyMetaData.Rule deleteRule

The DELETE_RULE for this key.

deferrability

private ForeignKeyMetaData.Deferrability deferrability

The DEFERRABILITY of this key.

Constructor Detail

ForeignKeyMetaData

public ForeignKeyMetaData()

Method Detail

getReferencedTable

public String getReferencedTable()

Returns referencedTable.

Returns:

The value/reference of/to referencedTable.

getReferencedSchema

public String getReferencedSchema()

Returns referencedSchema.

Returns:

The value/reference of/to referencedSchema.

setReferencedSchema

protected void setReferencedSchema(String referencedSchema)

Set referencedSchema.

Parameters:

referencedSchema - The value to set.

setReferencedTable

protected void setReferencedTable(String referencedTable)

Set referencedTable.

Parameters:

referencedTable - The value to set.

getColumnMappings

public Map<ColumnMetaData,String> getColumnMappings()

Returns KeyMetaData.columns.

Returns:

The value/reference of/to columns.

setColumnMappings

protected void setColumnMappings(Map<ColumnMetaData,String> columns)

Set KeyMetaData.columns.

Parameters:

columns - The value to set.

See Also:

KeyMetaData.setColumns(java.util.Collection)

addColumn

protected void addColumn(ColumnMetaData cmd,
                         String column)

Add the specified values to the KeyMetaData.columns map.

Parameters:

cmd - The column meta data key to add.

column - The referenced column name to add.

See Also:

KeyMetaData.setColumns(java.util.Collection)

getUpdateRule

public String getUpdateRule()

Returns updateRule.

Returns:

The value/reference of/to updateRule.

setUpdateRule

protected void setUpdateRule(ForeignKeyMetaData.Rule updateRule)

Set updateRule.

Parameters:

updateRule - The value to set.

getDeleteRule

public String getDeleteRule()

Returns deleteRule.

Returns:

The value/reference of/to deleteRule.

setDeleteRule

protected void setDeleteRule(ForeignKeyMetaData.Rule deleteRule)

Set deleteRule.

Parameters:

deleteRule - The value to set.

getDeferrability

public String getDeferrability()

Returns deferrability.

Returns:

The value/reference of/to deferrability.

setDeferrability

protected void setDeferrability(ForeignKeyMetaData.Deferrability deferrability)

Set deferrability.

Parameters:

deferrability - The value to set.