org.andromda.schema2xmi

Class SchemaTransformer

java.lang.Object

org.andromda.schema2xmi.SchemaTransformer

public class SchemaTransformer
extends Object

Performs the transformation of database schema to XMI. TODO This class really should have the functionality it uses (writing model elements) moved to the metafacades. TODO This class should be refactored into smaller classes.

Author:

Chad Brandon, Joel Kozikowski

Constructor Summary

Constructors

Constructor and Description
SchemaTransformer(String jdbcDriver, String jdbcConnectionUrl, String jdbcUser, String jdbcPassword) Constructs a new instance of this SchemaTransformer.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addForeignKey(String tableName, String columnName) Adds a foreign key column name to the foreignKeys Map.
protected Collection	createAssociations(DatabaseMetaData metadata, org.omg.uml.foundation.core.CorePackage corePackage, String tableName) Creates and returns a collection of associations by determining foreign tables to the table having the given tableName.
protected org.omg.uml.foundation.datatypes.Multiplicity	createAttributeMultiplicity(org.omg.uml.foundation.datatypes.DataTypesPackage dataTypes, boolean required) Creates an attributes multiplicity, if required is true, then multiplicity is set to 1, if required is false, then multiplicity is set to 0..1.
protected Collection	createAttributes(DatabaseMetaData metadata, org.omg.uml.foundation.core.CorePackage corePackage, String tableName) Creates and returns a collection of attributes from creating an attribute from every column on the table having the give tableName.
protected org.omg.uml.foundation.core.UmlClass	createClass(org.omg.uml.modelmanagement.UmlPackage modelPackage, DatabaseMetaData metadata, org.omg.uml.foundation.core.CorePackage corePackage, String tableName) Creates and returns a UmlClass with the given name using the corePackage to create it.
protected void	createClasses(Connection connection, org.omg.uml.foundation.core.CorePackage corePackage, org.omg.uml.modelmanagement.UmlPackage modelPackage) Creates all classes from the tables found in the schema.
protected org.omg.uml.foundation.datatypes.Multiplicity	createMultiplicity(org.omg.uml.foundation.datatypes.DataTypesPackage dataTypes, int lower, int upper) Creates a multiplicity, from lower and upper ranges.
protected org.omg.uml.foundation.core.TaggedValue	createTaggedValue(org.omg.uml.foundation.core.CorePackage corePackage, String name, String value) Creates a tagged value given the specified name.
String	getMetaColumnColumnSize()
String	getMetaColumnDecPlaces()
String	getMetaColumnTypeName()
protected org.omg.uml.foundation.core.DataType	getOrCreateDataType(org.omg.uml.foundation.core.CorePackage corePackage, String type) Gets or creates a new data type instance having the given fully qualified type name.
protected org.omg.uml.modelmanagement.UmlPackage	getOrCreatePackage(org.omg.uml.modelmanagement.ModelManagementPackage modelManagementPackage, org.omg.uml.modelmanagement.UmlPackage modelPackage, String packageName) Gets or creates a package having the specified packageName using the given modelManagementPackage, places it on the model and returns the last leaf package.
protected Collection	getOrCreateStereotypes(org.omg.uml.foundation.core.CorePackage corePackage, String names, String baseClass) Gets or creates a stereotypes given the specified comma separated list of names.
protected Collection	getPrimaryKeyColumns(DatabaseMetaData metadata, String tableName) Returns a collection of all primary key column names for the given tableName.
protected boolean	hasForeignKey(String tableName, String columnName) Returns true if the table with the given tableName has a foreign key with the specified columnName.
protected boolean	isColumnNullable(DatabaseMetaData metadata, String tableName, String columnName) This method just checks to see if a column is null able or not, if so, returns true, if not returns false.
void	setAttributeTaggedValues(String taggedValues)
void	setClassStereotypes(String classStereotypes) Sets the stereotype name for the new classes.
void	setColumnNamePattern(String columnNamePattern) Sets the regular expression pattern to match on when deciding what attributes to create in the XMI.
void	setColumnTaggedValue(String columnTaggedValue) Sets the name of the column tagged value to use for storing the name of the column.
void	setIdentifierStereotypes(String identifierStereotypes) Sets the stereotype name for the identifiers on the new classes.
void	setMetaColumnColumnSize(String metaColumnColumnSize)
void	setMetaColumnDecPlaces(String metaColumnDecPlaces)
void	setMetaColumnTypeName(String metaColumnTypeName)
void	setPackageName(String packageName) Sets the name of the package to which the model elements will be created.
void	setSchema(String schema) Sets the name of the schema (where the tables can be found).
void	setTableNamePattern(String tableNamePattern) Sets the regular expression pattern to match on when deciding what table names to add to the transformed XMI.
void	setTableTaggedValue(String tableTaggedValue) Sets the name of the table tagged value to use for storing the name of the table.
void	setTypeMappings(String typeMappingsUri) Sets the mappingsUri which is the URI to the sql types to model type mappings.
void	setXmiVersion(String xmiVersion) Sets the version of XMI that will be produced.
void	transform(String inputModel, String outputLocation) Transforms the Schema file and writes it to the location given by outputLocation.

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaTransformer

public SchemaTransformer(String jdbcDriver,
                 String jdbcConnectionUrl,
                 String jdbcUser,
                 String jdbcPassword)

Constructs a new instance of this SchemaTransformer.

Parameters:

jdbcDriver -

jdbcConnectionUrl -

jdbcUser -

jdbcPassword -

Method Detail

transform

public void transform(String inputModel,
             String outputLocation)

Transforms the Schema file and writes it to the location given by outputLocation. The inputModel must be a valid URL, otherwise an exception will be thrown.

Parameters:

inputModel - the location of the input model to start with (if there is one)

outputLocation - The location to where the transformed output will be written.

setTypeMappings

public void setTypeMappings(String typeMappingsUri)

Sets the mappingsUri which is the URI to the sql types to model type mappings.

Parameters:

typeMappingsUri - The typeMappings to set.

setPackageName

public void setPackageName(String packageName)

Sets the name of the package to which the model elements will be created.

Parameters:

packageName - The packageName to set.

setSchema

public void setSchema(String schema)

Sets the name of the schema (where the tables can be found).

Parameters:

schema - The schema to set.

setTableNamePattern

public void setTableNamePattern(String tableNamePattern)

Sets the regular expression pattern to match on when deciding what table names to add to the transformed XMI.

Parameters:

tableNamePattern - The tableNamePattern to set.

setColumnNamePattern

public void setColumnNamePattern(String columnNamePattern)

Sets the regular expression pattern to match on when deciding what attributes to create in the XMI.

Parameters:

columnNamePattern - The pattern for filtering the column name.

setClassStereotypes

public void setClassStereotypes(String classStereotypes)

Sets the stereotype name for the new classes.

Parameters:

classStereotypes - The classStereotypes to set.

setIdentifierStereotypes

public void setIdentifierStereotypes(String identifierStereotypes)

Sets the stereotype name for the identifiers on the new classes.

Parameters:

identifierStereotypes - The identifierStereotypes to set.

setColumnTaggedValue

public void setColumnTaggedValue(String columnTaggedValue)

Sets the name of the column tagged value to use for storing the name of the column.

Parameters:

columnTaggedValue - The columnTaggedValue to set.

setTableTaggedValue

public void setTableTaggedValue(String tableTaggedValue)

Sets the name of the table tagged value to use for storing the name of the table.

Parameters:

tableTaggedValue - The tableTaggedValue to set.

setAttributeTaggedValues

public void setAttributeTaggedValues(String taggedValues)

Parameters:

taggedValues -

setXmiVersion

public void setXmiVersion(String xmiVersion)

Sets the version of XMI that will be produced.

Parameters:

xmiVersion - The xmiVersion to set.

getOrCreatePackage

protected org.omg.uml.modelmanagement.UmlPackage getOrCreatePackage(org.omg.uml.modelmanagement.ModelManagementPackage modelManagementPackage,
                                                        org.omg.uml.modelmanagement.UmlPackage modelPackage,
                                                        String packageName)

Gets or creates a package having the specified packageName using the given modelManagementPackage, places it on the model and returns the last leaf package.

Parameters:

modelManagementPackage - from which we retrieve the UmlPackageClass to create a UmlPackage.

modelPackage - the root UmlPackage

packageName -

Returns:

modelPackage

createClasses

protected void createClasses(Connection connection,
                 org.omg.uml.foundation.core.CorePackage corePackage,
                 org.omg.uml.modelmanagement.UmlPackage modelPackage)
                      throws SQLException

Creates all classes from the tables found in the schema.

Parameters:

connection - the Connection used to retrieve the schema metadata.

corePackage - the CorePackage instance we use to create the classes.

modelPackage - the package which the classes are added.

Throws:

SQLException

createClass

protected org.omg.uml.foundation.core.UmlClass createClass(org.omg.uml.modelmanagement.UmlPackage modelPackage,
                                               DatabaseMetaData metadata,
                                               org.omg.uml.foundation.core.CorePackage corePackage,
                                               String tableName)

Creates and returns a UmlClass with the given name using the corePackage to create it.

Parameters:

modelPackage -

metadata -

corePackage - used to create the class.

tableName - to tableName for which we'll create the appropriate class.

Returns:

the UmlClass

createAttributes

protected Collection createAttributes(DatabaseMetaData metadata,
                          org.omg.uml.foundation.core.CorePackage corePackage,
                          String tableName)
                               throws SQLException

Creates and returns a collection of attributes from creating an attribute from every column on the table having the give tableName.

Parameters:

metadata - the DatabaseMetaData from which to retrieve the columns.

corePackage - used to create the class.

tableName - the tableName for which to find columns.

Returns:

the collection of new attributes.

Throws:

SQLException

setMetaColumnDecPlaces

public void setMetaColumnDecPlaces(String metaColumnDecPlaces)

Parameters:

metaColumnDecPlaces -

getMetaColumnDecPlaces

public String getMetaColumnDecPlaces()

Returns:

metaColumnDecPlaces

setMetaColumnColumnSize

public void setMetaColumnColumnSize(String metaColumnColumnSize)

Parameters:

metaColumnColumnSize -

getMetaColumnColumnSize

public String getMetaColumnColumnSize()

Returns:

metaColumnColumnSize

setMetaColumnTypeName

public void setMetaColumnTypeName(String metaColumnTypeName)

Parameters:

metaColumnTypeName -

getMetaColumnTypeName

public String getMetaColumnTypeName()

Returns:

metaColumnTypeName

getOrCreateDataType

protected org.omg.uml.foundation.core.DataType getOrCreateDataType(org.omg.uml.foundation.core.CorePackage corePackage,
                                                       String type)

Gets or creates a new data type instance having the given fully qualified type name.

Parameters:

corePackage - the core package

type - the fully qualified type name.

Returns:

the DataType

isColumnNullable

protected boolean isColumnNullable(DatabaseMetaData metadata,
                       String tableName,
                       String columnName)
                            throws SQLException

This method just checks to see if a column is null able or not, if so, returns true, if not returns false.

Parameters:

metadata - the DatabaseMetaData instance used to retrieve the column information.

tableName - the name of the table on which the column exists.

columnName - the name of the column.

Returns:

true/false on whether or not column is nullable.

Throws:

SQLException

getPrimaryKeyColumns

protected Collection getPrimaryKeyColumns(DatabaseMetaData metadata,
                              String tableName)
                                   throws SQLException

Returns a collection of all primary key column names for the given tableName.

Parameters:

metadata -

tableName -

Returns:

collection of primary key names.

Throws:

SQLException

createAssociations

protected Collection createAssociations(DatabaseMetaData metadata,
                            org.omg.uml.foundation.core.CorePackage corePackage,
                            String tableName)
                                 throws SQLException

Creates and returns a collection of associations by determining foreign tables to the table having the given tableName.

Parameters:

metadata - the DatabaseMetaData from which to retrieve the columns.

corePackage - used to create the class.

tableName - the tableName for which to find columns.

Returns:

the collection of new attributes.

Throws:

SQLException

createTaggedValue

protected org.omg.uml.foundation.core.TaggedValue createTaggedValue(org.omg.uml.foundation.core.CorePackage corePackage,
                                                        String name,
                                                        String value)

Creates a tagged value given the specified name.

Parameters:

corePackage -

name - the name of the tagged value to create.

value - the value to populate on the tagged value.

Returns:

returns the new TaggedValue

getOrCreateStereotypes

protected Collection getOrCreateStereotypes(org.omg.uml.foundation.core.CorePackage corePackage,
                                String names,
                                String baseClass)

Gets or creates a stereotypes given the specified comma separated list of names. If any of the stereotypes can't be found, they will be created.

Parameters:

corePackage -

names - comma separated list of stereotype names

baseClass - the base class for which the stereotype applies.

Returns:

Collection of Stereotypes

addForeignKey

protected void addForeignKey(String tableName,
                 String columnName)

Adds a foreign key column name to the foreignKeys Map. The map stores a collection of foreign key names keyed by the given tableName

Parameters:

tableName - the name of the table for which to store the keys.

columnName - the name of the foreign key column name.

hasForeignKey

protected boolean hasForeignKey(String tableName,
                    String columnName)

Returns true if the table with the given tableName has a foreign key with the specified columnName.

Parameters:

tableName - the name of the table to check for the foreign key

columnName - the name of the foreign key column.

Returns:

true/false depending on whether or not the table has the foreign key with the given columnName.

createAttributeMultiplicity

protected org.omg.uml.foundation.datatypes.Multiplicity createAttributeMultiplicity(org.omg.uml.foundation.datatypes.DataTypesPackage dataTypes,
                                                                        boolean required)

Creates an attributes multiplicity, if required is true, then multiplicity is set to 1, if required is false, then multiplicity is set to 0..1.

Parameters:

dataTypes - used to create the Multiplicity

required - whether or not the attribute is required therefore determining the multiplicity value created.

Returns:

the new Multiplicity

createMultiplicity

protected org.omg.uml.foundation.datatypes.Multiplicity createMultiplicity(org.omg.uml.foundation.datatypes.DataTypesPackage dataTypes,
                                                               int lower,
                                                               int upper)

Creates a multiplicity, from lower and upper ranges.

Parameters:

dataTypes - used to create the Multiplicity

lower - the lower range of the multiplicity

upper - the upper range of the multiplicity

Returns:

the new Multiplicity