com.lf.commons.db.exchange

Class DBTableDef

java.lang.Object

com.lf.commons.db.exchange.DBTableDef

public class DBTableDef
extends java.lang.Object

Simple data holding class for database table meta data.

The JDBC API provides detailed pieces of information about databases, their tables, views etc. which can be used to exchange data. the data contained herein is valuable for analysis of relationships between the tables of database schemas. For instance it can be used to determine the best export order of database objects so that they can be imported again without problems.

Since:

1.6

Version:

$Revision: 1.7 $, $Date: 2012/12/28 11:44:25 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
java.util.Hashtable<java.lang.String,java.util.Properties>	cacheFKByColumn The foreign key data provided by the DatabaseMetaData.getImportedKeys() method.
java.util.Vector<java.lang.String>	fkProps The order of foreign keys represented by column names.
java.util.Properties	tableProps The table meta data provided by the DatabaseMetaData.getTables() method.

Constructor Summary

Constructors

Constructor and Description
DBTableDef() Constructor method for i18n purposes only.
DBTableDef(java.util.Properties props) Init functionality.

Method Summary

Methods

Modifier and Type	Method and Description
void	addForeignKey(java.util.Properties fkprops) Add foreign key data provided by the DatabaseMetaData.getImportedKeys() method.
static DBTableDef	createFromMetadata(java.sql.DatabaseMetaData metadata, java.sql.ResultSet rs) Creates a new DBTableDef instance from database meta data.
static java.lang.String	createTableID(java.lang.String catalog, java.lang.String schema, java.lang.String table) Generates the unique table identifier.
boolean	equals(DBTableDef tocheck) Checks wether a given DBTableDef instance is equal to this.
protected void	finalize() Helps the garbage collector.
java.lang.String	getCatalog() Provides the catalog of the table.
java.lang.String[]	getFKColumns() Provides the list of columns with foreign key relations.
java.lang.String	getSchema() Provides the schema of the table.
java.lang.String	getTable() Provides the name of the table.
java.lang.String	toString() Overrides method java.lang.Object.toString.

Methods inherited from class java.lang.Object

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

Field Detail

tableProps

public java.util.Properties tableProps

The table meta data provided by the DatabaseMetaData.getTables() method.

cacheFKByColumn

public java.util.Hashtable<java.lang.String,java.util.Properties> cacheFKByColumn

The foreign key data provided by the DatabaseMetaData.getImportedKeys() method.

fkProps

public java.util.Vector<java.lang.String> fkProps

The order of foreign keys represented by column names.

Constructor Detail

DBTableDef

public DBTableDef()
           throws java.lang.InstantiationException

Constructor method for i18n purposes only.

Can only be used if beans design time is set (e.g. by external tools like the I18NExtractor).

Throws:

java.lang.InstantiationException - Error indication

Since:

1.6

DBTableDef

public DBTableDef(java.util.Properties props)

Init functionality.

Parameters:

props - The table meta data

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Helps the garbage collector.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

addForeignKey

public void addForeignKey(java.util.Properties fkprops)

Add foreign key data provided by the DatabaseMetaData.getImportedKeys() method.

Parameters:

fkprops - The foreign key data

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

toString

public java.lang.String toString()

Overrides method java.lang.Object.toString.

Overrides:

toString in class java.lang.Object

Returns:

The textual representation

Since:

1.6

createTableID

public static java.lang.String createTableID(java.lang.String catalog,
                             java.lang.String schema,
                             java.lang.String table)

Generates the unique table identifier.

Parameters:

catalog - The table catalog (optional)

schema - The table schema (optional)

table - The table name

Returns:

The textual identifier

Since:

1.6

equals

public boolean equals(DBTableDef tocheck)

Checks wether a given DBTableDef instance is equal to this.

Parameters:

tocheck - Instance to be checked

Returns:

The DBTableDef instance to check for equality

Since:

1.6

getCatalog

public java.lang.String getCatalog()

Provides the catalog of the table.

Returns:

The catalog name, may be null

Since:

1.6

getSchema

public java.lang.String getSchema()

Provides the schema of the table.

Returns:

The schema name, may be null

Since:

1.6

getTable

public java.lang.String getTable()

Provides the name of the table.

Returns:

The table name, may be null

Since:

1.6

getFKColumns

public java.lang.String[] getFKColumns()

Provides the list of columns with foreign key relations.

Returns:

The foreign key columns

Since:

1.6

createFromMetadata

public static DBTableDef createFromMetadata(java.sql.DatabaseMetaData metadata,
                            java.sql.ResultSet rs)

Creates a new DBTableDef instance from database meta data.

The result set is never closed. Call the DatabaseMetaData.getTables() method for the tables you like to be processed and pass the open result set pointing to the next table dataset to be converted to a DBTableDef object.

Parameters:

metadata - The database meta data

rs - The result set from DatabaseMetaData.getTables()

Returns:

Container of Java objects from tuple, null as error indication

Throws:

java.lang.NullPointerException - If parameters are invalid

java.lang.IllegalArgumentException - If parameters are invalid

Since:

1.6