Plugin Documentation

Goals available for this plugin:

Goal Description
modelant.uml13..:compare-uml13-models Compare two UML 1.3 models and report the differences, that are needed to convert the source model into the target one.
modelant.uml13..:database-to-uml13 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 TAG_VALUE_DATA_LENGTH and TAG_VALUE_DATA_TYPE_PRECISION these values are bound to the concrete data type.
  2. The TAG_VALUE_DATA_TYPE_PRECISION tagged value is optional. When not provided, the precision should be treated as 0
  3. The 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 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.
modelant.uml13..:xsd-to-uml13 Reverse engineer a XML schema 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:

  • The model elements (classes, association names) that represent elements in the output XML are marked with <<element>> stereotype
  • For representation purposes local types (UML classes) could be introduced for XSD groups, unions, local / inlined types. All of them are marked with <<local type>> stereotype
  • The column types are converted to DataType instances named: <type name>[_<column size>[_<column precision>]]. Additionally as tagged values named TAG_VALUE_DATA_TYPE_SIZE and TAG_VALUE_DATA_TYPE_PRECISION these values are bound to the concrete data type.
  • The TAG_VALUE_DATA_TYPE_PRECISION tagged value is optional. When not provided, the precision should be treated as 0
  • Any comments found while reverse engineering the XSD are bound as 'documentation' tagged values. These tagged values are compatible with the Rose's approach to documentation. They are optional.

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven 2.0
JDK 1.8
Memory No minimum requirement.
Disk Space No minimum requirement.

Usage

You should specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>net.mdatools</groupId>
          <artifactId>modelant.uml13.maven.plugin</artifactId>
          <version>3.3.0</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>net.mdatools</groupId>
        <artifactId>modelant.uml13.maven.plugin</artifactId>
        <version>3.3.0</version>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"