`UMLGraph dds`

UMLGraph - Declarative Drawing of UML Diagrams

UMLGraph allows the declarative specification and drawing of UML class and sequence diagrams. The current features are part of an ongoing effort aiming to provide support for all types UML diagrams. An IEEE Software article titled On the declarative specification of models explains the rationale behind this approach. The tehnology behind UMLGraph was used to draw many of the diagrams appearing in the books Code Quality: The Open Source Perspective (Addison Wesley, 2006) and Code Reading: The Open Source Perspective (Addison Wesley, 2003). In addition, the UMLGraphDoc doclet included in this distribution automatically adds UML diagrams to javadoc documentation.

Many programs build on UMLGraph; follow this link for more details. In addition, Martin Fowler, the author of UML Distilled, writes:

I thought I'd send you a note saying how much I enjoyed discovering UML Graph. I've long fancied a text based way of describing UML diagrams, but never felt sufficiently time-rich to develop anything.

Martin has created a bliki entry describing his ideas of what an ideal textual language might look like.

Class Diagrams

One specifies a class diagram using the Java syntax complemented by javadoc tags. Running the UmlGraph doclet on the specification will generate a Graphviz diagram specification that can be automatically processed to create Postscript, GIF, SVG, JPEG, fig, or Framemaker drawings.

The following is an example of a class diagram specification and the resulting UML diagram:

class Person {
	String Name;
}

class Employee extends Person {}

class Client extends Person {}

Sequence Diagrams

One specifies a sequence diagram using pic macros to define objects and method invocations. The GNU plotutils pic2plot program can then process the sequence diagram to create a PNG, PNM, (pseudo)GIF, SVG, AI, Postscript, CGM, FIG, PCL, HPGL, Regis, or TEK drawing.

The following is an example of a sequence diagram specification and the resulting UML diagram:

# Define the objects
object(O,"o:Toolkit");
placeholder_object(P);
step();

# Activation and messages
active(O);
message(O,O,"callbackLoop()");
create_message(O,P,"p:Peer");
message(O,P,"handleExpose()");
active(P);
return_message(P,O,"");
inactive(P);
destroy_message(O,P);
inactive(O);

# Complete the lifeline of O
step();
complete(O);

Download and Links

UMLGraph is hereby made freely available as Open Source Software. The current version of UMLGraph is VERSION. You can download UMLGraph and its documentation from the following links:

UmlGraph package version VERSION - .tar.gz (compressed tar file containing the source code, the compiled doclet, and the complete documentation in HTML format).
UmlGraph package version VERSION - .zip (zip file containing the source code, the compiled doclet, and the complete documentation in HTML format).
User documentation (table of contents - suitable for web browsing).
Printable user documentation (the above as a single printable page).
Doclet technical documentation (javadoc table of contents).
Version history
freshmeat.net page (use it to subscribe and post comments).
UmlGraph binary - UmlGraph-VERSION.jar (jar file containing only the UmlGraph classes; please use this only for pulling UmlGraph into other projects).
MD5 checksums for each of the above .zip, .tar.gz, and jar archives.
Older UMLGraph versions (useful if you run an older JRE).
Frequently asked questions

Diomidis Spinellis home page

Unless otherwise expressly stated, all original material on this page created by Diomidis Spinellis is licensed under a Creative Commons Attribution-Noncommercial-No Derivative Works 2.5 License.
Last modified: $Date$