Versions Compared

Old Version 19

changes.mady.by.user Suzanne Deprez

Saved on

compared with

New Version Current

changes.mady.by.user Magnolia International

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

As stated in the Introduction to UML, there are three types of UML diagrams: structure, behavior, and interaction. Useful structure diagrams for Magnolia CMS include class, object, component, composite structure, and package. Useful behavior diagrams include activity. Useful interaction diagrams include sequence and communication (or collaboration). The Wiki's UML article and the Kennesaw's UML Tutorial provide descriptions and examples of these and other UML diagrams.

UML tools

A list of tools that can be used to generate UML diagrams is provided below. Notes for each tool are for the purposes of evaluation by readers. Readers are encouraged to add tools to the list as well as experiences with tools already listed. Please provide a link for any added tools. The evaluations were done using Eclipse Helios unless otherwise specified.

Tool

Notes

eUML2

Eclipse plugin, installed Studio Edition, to create diagrams select New>Other>Eclipse Modeling Framework,eDepend Diagrams, eEMF Diagrams, eUML2 Diagrams. Class and package dependencies under eDepend Diagrams showed relationships for selected class/package. Class diagram under eUML2 Diagrams also showed relationships for selected class(es). Other diagrams were not useful or did not generate.

MyEclipse UML 2

Eclipse plugin, create UML Model file New>Other>MyEclipse>UML>UML1 Model, drag class from Package Explorer to UML Model to create/add to class diagram, can also add using UML>Reverse Engineer UML from Java, only class diagrams can be created from code.

MyEclipse UML 2 is recommended for generating class diagrams of the Magnolia CMS code.

Note

After the initial evaluation, it was discovered that this plugin is an evaluation for a period of 30 days.

The following tools were also evaluated but were not included on the list are not recommended due to not being an Eclipse plugin, low ratings, not free, or not performing as expected: Solution BluePrint, Javadoc as UML View, ModelGoon UML 4, Coffea, UML Lab, MagicDraw, AgileJ StructureViews, Slime UML, MaintainJ, EclipseUML, jSonde, Green, UModel, Rational, Visual Paradigm, eUML2.

Generation recommendation

To install MyEclipse UML 2:

  1. Add software site to http://downloads.myeclipseide.com/downloads/products/eworkbench/helios/enterprise-earlyaccess/ in Eclipse.
  2. Deselect Maven Support for MyEclipse (this conflicts with the Maven Support needed for the development environment) and Spring AJDT Extension during installation.
    Note

    MyEclipse does not cleanly uninstall from Eclipse once it is installed. The MyEclipse perspective remains as well as the WTPJavaEE perspective.

    To create class diagrams:
  3. Click New>Other>MyEclipse>UML>UML1 Model.
  4. Open created model.
  5. Add classes to model by doing one of the following:
    1. Drag class from Package Explorer to model.
    2. Click UML>Reverse Engineer UML from Java in Eclipse. A class can be added to the class diagram created this way by dragging the class from Package Explorer.

A portion of the class diagram for info.magnolia.cms.core is shown here.
Image AddedRecommendations for generating UML diagrams are in progress and will be added in the near future.