net.mdatools.modelant.uml13.maven.plugin.reverse

Class ReverseEngineerDatabaseMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

net.mdatools.modelant.uml13.maven.plugin.reverse.ReverseEngineerDatabaseMojo

All Implemented Interfaces:

ContextEnabled, Mojo

@Mojo(name="database-to-uml13",
      defaultPhase=COMPILE)
 @Execute(phase=COMPILE)
public class ReverseEngineerDatabaseMojo
extends AbstractMojo

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 net.mdatools.modelant.uml13.metamodel.Convention.TAG_VALUE_DATA_LENGTH and net.mdatools.modelant.uml13.metamodel.Convention.TAG_VALUE_DATA_TYPE_PRECISION these values are bound to the concrete data type.
2. The net.mdatools.modelant.uml13.metamodel.Convention.TAG_VALUE_DATA_TYPE_PRECISION tagged value is optional. When not provided, the precision should be treated as 0
3. The net.mdatools.modelant.uml13.metamodel.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 net.mdatools.modelant.uml13.metamodel.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 org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
ReverseEngineerDatabaseMojo()

Method Summary

Modifier and Type	Method and Description
void	execute() Performs the reverse engineering of the database by describing the database schema into the repository provided.

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Constructor Detail

ReverseEngineerDatabaseMojo

public ReverseEngineerDatabaseMojo()

Method Detail

execute

public void execute()
             throws MojoExecutionException

Performs the reverse engineering of the database by describing the database schema into the repository provided.

Throws:

MojoExecutionException