net.mdatools.modelant.uml13.reverse

Class ReverseDatabaseOperation

java.lang.Object

net.mdatools.modelant.uml13.reverse.ReverseDatabaseOperation

All Implemented Interfaces:

Function<Connection,javax.jmi.reflect.RefPackage>

public class ReverseDatabaseOperation
extends Object
implements Function<Connection,javax.jmi.reflect.RefPackage>

Reverse engineering logic for database schemas and storing the results as UML 1.3 objects. The model produced is in fact a Platform Specific Model, which might need additional processing and tuning. Conventions for the model produced:

1. The database column types are converted to DataType instances named: <type name>[_<column size>[_<column precision>]]. Additionally as tagged values named Convention.TAG_VALUE_DATA_LENGTH and Convention.TAG_VALUE_DATA_TYPE_PRECISION these values are bound to the concrete data type.
2. The Convention.TAG_VALUE_DATA_TYPE_PRECISION tagged value is optional. When not provided, the precision should be treated as 0
3. The Convention.TAG_VALUE_DATA_LENGTH tagged value is mandatory.
4. Any comments found while reverse engineering the database are bound as 'documentation' tagged values. These tagged values are compatible with the Rose's approach to documentation. They are optional.
5. Each attribute pertaining to the table's primary key is bound a Convention.TAG_VALUE_PRIMARY_KEY tagged value with "Primaty Key" value. Its value is the sequence order of the column in the tible's primary key.

Author:

Rusi Popov (popovr@mdatools.net)

Field Summary

Fields inherited from interface net.mdatools.modelant.core.api.Function

IDENTITY

Constructor Summary

Constructors

Constructor and Description
ReverseDatabaseOperation(ModelRepository modelRepository, String... schemes)

Method Summary

Modifier and Type	Method and Description
protected void	dumpResultSet(ResultSet resultSet) Prints the contents of the result set provided and closes it.
javax.jmi.reflect.RefPackage	execute(Connection connection)
protected void	processRelationships(List<UmlClass> tables, DatabaseMetaData metadata, String schema) This method processes all relationhips in the schemes and registers associations for them into the extent provided.
protected List<UmlClass>	processTables(DatabaseMetaData metadata, String schema) This method processes all tables in the schemes and registers classes for them into the extent provided

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.mdatools.modelant.core.api.Function

toString

Constructor Detail

ReverseDatabaseOperation

public ReverseDatabaseOperation(ModelRepository modelRepository,
                                String... schemes)

Parameters:

modelRepository - not null

schemes - not null, not empty name of the schemes to reverse engineer. NOTE: It might be case sensitive.

Method Detail

processTables

protected List<UmlClass> processTables(DatabaseMetaData metadata,
                                       String schema)
                                throws SQLException

This method processes all tables in the schemes and registers classes for them into the extent provided

Parameters:

metadata - is the database metadata to reverse engineer

schema - the name of the DB schema to reverse engineer

Returns:

non-null list of registered tables

Throws:

SQLException

processRelationships

protected void processRelationships(List<UmlClass> tables,
                                    DatabaseMetaData metadata,
                                    String schema)
                             throws SQLException

This method processes all relationhips in the schemes and registers associations for them into the extent provided. The relationships are identified on class-by-class basis.

Parameters:

tables - non-null list of regitered tables

metadata - is the database metadata to reverse engineer

schema - the name of the DB schemes to reverse engineer

Throws:

SQLException

dumpResultSet

protected void dumpResultSet(ResultSet resultSet)
                      throws SQLException

Prints the contents of the result set provided and closes it.

Parameters:

resultSet -

Throws:

SQLException

execute

public javax.jmi.reflect.RefPackage execute(Connection connection)
                                     throws IllegalArgumentException

Specified by:

execute in interface Function<Connection,javax.jmi.reflect.RefPackage>

Parameters:

connection - not null

Returns:

not null extent with the model of the database schemes

Throws:

IllegalArgumentException

See Also:

Function.execute(java.lang.Object)