org.clazzes.jdbc2xml.schema
Class ForeignKeyInfo

java.lang.Object
  extended by org.clazzes.jdbc2xml.schema.ForeignKeyInfo

public class ForeignKeyInfo
extends java.lang.Object

This class implements all infos we need to describe a foreign key.

Author:
wglas

Constructor Summary
ForeignKeyInfo()
          Default constructor.
ForeignKeyInfo(org.xml.sax.Attributes atts)
          Initialize this object from SAX attributes.
ForeignKeyInfo(java.lang.String name, java.lang.String columns, java.lang.String foreignTable, java.lang.String foreignColumns)
          Constructor using name, table and columns.
 
Method Summary
 void addColumn(java.lang.String column)
           
 void addForeignColumn(java.lang.String column)
           
 java.util.List<java.lang.String> getColumns()
           
 short getDeferrability()
           
 short getDeleteRule()
           
 java.util.List<java.lang.String> getForeignColumns()
           
 java.lang.String getForeignTable()
           
 java.lang.String getName()
           
 java.lang.String getPkName()
           
 short getUpdateRule()
           
 void setColumns(java.util.List<java.lang.String> columns)
           
 void setDeferrability(short deferrability)
           
 void setDeleteRule(short deleteRule)
           
 void setForeignColumns(java.util.List<java.lang.String> foreignColumns)
           
 void setForeignTable(java.lang.String foreignTable)
           
 void setName(java.lang.String name)
           
 void setPkName(java.lang.String pkName)
           
 void setUpdateRule(short updateRule)
           
 org.xml.sax.Attributes toAttributes(SqlIdentifierMapper mapper)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ForeignKeyInfo

public ForeignKeyInfo()
Default constructor.


ForeignKeyInfo

public ForeignKeyInfo(java.lang.String name,
                      java.lang.String columns,
                      java.lang.String foreignTable,
                      java.lang.String foreignColumns)
Constructor using name, table and columns.

Parameters:
name - The name of the foreign key.
columns - A comma-separated list of columns in the own table.
foreignTable - The name of the referenced foreign table.
foreignColumns - The referenced columns of the foreign table (comma-separated).

ForeignKeyInfo

public ForeignKeyInfo(org.xml.sax.Attributes atts)
Initialize this object from SAX attributes.

Parameters:
atts - A SAX attributes bag to set to this object.
Method Detail

toAttributes

public org.xml.sax.Attributes toAttributes(SqlIdentifierMapper mapper)
Returns:
A SAX Attributes bag filled with the information about this private key.

getName

public java.lang.String getName()
Returns:
the name of the primary key.

setName

public void setName(java.lang.String name)
Parameters:
name - the name to set

getColumns

public java.util.List<java.lang.String> getColumns()
Returns:
the columns

setColumns

public void setColumns(java.util.List<java.lang.String> columns)
Parameters:
columns - the columns to set

addColumn

public void addColumn(java.lang.String column)
Parameters:
column - The column name to add to the list of columns.

getPkName

public java.lang.String getPkName()
Returns:
the pkName

setPkName

public void setPkName(java.lang.String pkName)
Parameters:
pkName - the pkName to set

getForeignTable

public java.lang.String getForeignTable()
Returns:
the foreignTable

setForeignTable

public void setForeignTable(java.lang.String foreignTable)
Parameters:
foreignTable - the foreignTable to set

getForeignColumns

public java.util.List<java.lang.String> getForeignColumns()
Returns:
the foreignColumns

setForeignColumns

public void setForeignColumns(java.util.List<java.lang.String> foreignColumns)
Parameters:
foreignColumns - the foreignColumns to set

addForeignColumn

public void addForeignColumn(java.lang.String column)
Parameters:
column - The column name to add to the list of foreign columns.

getUpdateRule

public short getUpdateRule()
Returns:
the updateRule
See Also:
DatabaseMetaData.importedKeyCascade, DatabaseMetaData.importedKeyNoAction, DatabaseMetaData.importedKeyRestrict, DatabaseMetaData.importedKeySetDefault, DatabaseMetaData.importedKeySetNull

setUpdateRule

public void setUpdateRule(short updateRule)
Parameters:
updateRule - the updateRule to set

getDeleteRule

public short getDeleteRule()
Returns:
the deleteRule
See Also:
DatabaseMetaData.importedKeyCascade, DatabaseMetaData.importedKeyNoAction, DatabaseMetaData.importedKeyRestrict, DatabaseMetaData.importedKeySetDefault, DatabaseMetaData.importedKeySetNull

setDeleteRule

public void setDeleteRule(short deleteRule)
Parameters:
deleteRule - the deleteRule to set

getDeferrability

public short getDeferrability()
Returns:
The deferrability.
See Also:
DatabaseMetaData.importedKeyInitiallyDeferred, DatabaseMetaData.importedKeyNotDeferrable, DatabaseMetaData.importedKeyInitiallyImmediate

setDeferrability

public void setDeferrability(short deferrability)
Parameters:
deferrability - The deferrability to set.


Copyright © 2010. All Rights Reserved.