Reverse-engineer Source Code into UML Diagrams

The last version that is compatible with Java 1.4 is UmlGraph package version 2.10.  It is available on the downloads page.  Look at the documentation of that version for what features were supported at that time.

Hi Meera,

Thanks a lot for this article, and efharisto to Mr. Spinellis too!

I managed to change my build script which builds locally on the command line (Win XP) and it works perfectly.

On the CI server (Linux) I have a little problem still, and I was hoping you guys could help me out...

The build script is exactly the same as my local script, but during the execution of the <apply executable="dot"...> bit, some errors occur of which this is one of them...

java.io.IOException: Cannot run program "dot": java.io.IOException: error=2, No such file or directory

Do you have any idea?

Gian

p.s. the error list is much longer, but I didn't include it for readability... 

I find that the suggestions here for using the Maven UMLGraph plugin all fail.  This almost works for me, reverse engineered from browsing the Maven repository.  Specifically, while gr.spinellis might have been renamed to org.umlgraph, but that doesn't seem to exist in the central Maven repository.  Also, someone mentioned that 5.0 was released, but in the gr.spinellis section of the central repository, the maximum version is 4.6.  So here's some XM Hell:

            <plugin>
                <artifactId>maven-javadoc-plugin</artifactId>
                <version>2.3</version>
                <configuration>
                    <doclet>org.umlgraph.doclet.UmlGraphDoc</doclet>
                    <docletArtifact>
                        <groupId>gr.spinellis</groupId>
                        <artifactId>UmlGraph</artifactId>
                        <version>4.6</version>
                    </docletArtifact>
                    <additionalparam>
                        -inferrel -inferdep -quiet -hide java.* -collpackages java.util.* -qualify -postfixpackage -nodefontsize 9
                        -nodefontpackagesize 7
                    </additionalparam>
                </configuration>
            </plugin>

 The reason this ultimately fails is:

Embedded error: Error rendering Maven report: Exit code: 1 - javadoc: error - Cannot find doclet class org.umlgraph.doclet.UmlGraphDoc

I thought Maven plugins were supposed to know their own dependencies.

I got it to work in Maven by upgrading to maven 2.0.9 and using:

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                <configuration>
                    <doclet>org.umlgraph.doclet.UmlGraphDoc</doclet>
                    <docletPath>path\to\UmlGraph.jar</docletPath>
                    <additionalparam>-views</additionalparam>
                </configuration>
            </plugin>
 

It's worth reading and try. 

Finally, i'm able to pull this using Maven. I think, UMLgraph and GraphViz works with both Maven 2.0.8 and 2.0.9. I've used UMLGraph 5.1, graphviz 2.21 using JDK 6. 

Here is the maven snippet and don't forget to run the "site" lifecycle. "mvn  clean compile site"

<-------------->

     <reporting>

        <plugins>

            <plugin>

                <groupId>org.apache.maven.plugins</groupId>

                <artifactId>maven-javadoc-plugin</artifactId>

                <reportSets>

                    <reportSet>

                        <id>uml</id>

                        <configuration>

                            <doclet>org.umlgraph.doclet.UmlGraphDoc</doclet>

                            <docletArtifact>

                                <groupId>org.umlgraph</groupId>

                                <artifactId>doclet</artifactId>

                                <version>5.1</version>

                            </docletArtifact>

                            <additionalparam>-operations</additionalparam>

                            <additionalparam>-qualify</additionalparam>

                            <additionalparam>-types</additionalparam>

                            <additionalparam>-visibility</additionalparam>

                            <additionalparam>-collpackages</additionalparam>

                            <destDir>withUML</destDir>

                            <show>private</show>

                        </configuration>

                        <reports>

                            <report>javadoc</report>

                        </reports>

                    </reportSet>

                </reportSets>

            </plugin>

        </plugins>

    </reporting>    

<---------------> 

 - Sundar

I appreciate your work, but I still have this problem: java.io.IOException: Cannot run program "dot": CreateProcess error=2. note that the Graphviz is  installed 

So how can I resolve this pb?

other question how the java.classpath is defined in the ant file.

thnx 

Please verify that you can run dot from the command line.

Hello ; of course I fully understand that the replacement of Graphviz in UMLGraph would at least not be easy, starting from scratch to develop this functionnality inside UMLGraph.

I was just asking if somone was aware of a Java project capable of transforming .dot to .png (or .jpg, ...) in pure Java rather than relying on a platform dependent tool. Some kind of a JGraphViz, or at least a subset of the GraphViz functionnalities - juste what is needed for the conversionof the .dot. The idea would have been to keep UMLGraph exactly like it is, but to use something else to convert .dot to .png (even if developping a tool for doing this may be rather difficult, too).

I think the ant cannot execute the "dot" because my project is in disk d:\ and Graphviz is installed in c:\

when I copy class.dot file to c:\ and run the dot I get a class.png, Any help?

this is a great article but somehow i am a novice in this field and its not working for me... please can someone send a full package. I will be very greatful.

This article is really good. It helps a lot for reverse engineering. Thanks Adesh

If you want to reverse engineer a java program to generate sequence diagrams you can use the Java Call Tracer tool on SourceForge

 http://sourceforge.net/projects/javacalltracer/

do I need to install eclipse? then try......? "To compile the Java doclet from the source code run ant on the build.xml file. Copy the UmlGraph.jar file to your projects library." where's the ant file & how to run it on build.xml? also how to copy .jar to project library? I'm poor in java but I need it. please help me.

I just released version 5.4.  This version creates clickable diagram elements in HTML content, makes the generation of diamond shapes compatible with GraphViz 2.27, and includes a fix to ensure that class images only appear once in the generated diagrams. Many thanks to all the contributors.

Hi,

I use last version of UMLGraph (5.4) and try to make an ANT task to process javadoc after a compilation in Netbeans. All is fine, but UMLgraph not takes @opt values that i give in my classes, but in your release comments (5.3), you say "UmlGraphDoc will obey the options specified through @opt tags within Java files. (Contributed by Laird Nelson.)". What must I do ?

A class with @opt :

/**
 * @opt all
 * @opt nodefillcolor lightblue
 * @has 1 - 1 FenetreSansBarre
 * @has 1 - 4 FenetreAvecBarre
 * @depend - - - ScreenInfo
 * 
 */
public class Main {
   ...
}

My ant task :

 <target name="-post-compile">
  <property name="src.dir" location="src"/>
  <property name="reports.dir" location="reports"/>
  <property name="umlgraph.dir" location="${user.home}/Dropbox/_DEV/Java/ExtraLibs/umlgraph/lib"/>
  <property name="dot.dir" location="/usr/local/bin"/>
  
  <mkdir dir="${reports.dir}/javadoc" />
  <javadoc
  sourcepath="${src.dir}"
  packagenames="app.*"
  destdir="${reports.dir}/javadoc" >
 <tag name="tagvalue" description="UMLGraph additional annotation:" />
  <tag name="has" description="UMLGraph relationship information:" />
  <tag name="depend" description="UMLGraph relationship information:" />
  <tag name="hidden" description="UMLGraph hidden entity:" />
  <tag name="stereotype" description="UMLGraph stereotype information:" />
  <tag name="match" description="UMLGraph name matching pattern:" />
  <tag name="opt" description="UMLGraph view option:" />
  <tag name="view" description="UMLGraph view:" />
  
  <doclet name="org.umlgraph.doclet.UmlGraphDoc" path="${umlgraph.dir}/UmlGraph.jar" >
  <param name="-dotexecutable" value="${dot.dir}/dot" />
  <param name="-all" />
  <param name="-private" />
  <param name="-horizontal" />
  <param name="-nodefontclassname" value="Monaco"/>
  <param name="-nodefontclasssize" value="14"/>
  <param name="-nodefontname" value="Monaco"/>
  <param name="-nodefontsize" value="10" />
  <param name="-nodefillcolor" value="mistyrose" />
  </doclet>
  </javadoc>
  <apply executable="${dot.dir}/dot" dest="${reports.dir}" parallel="false">
  <arg value="-Tpng"/>
  <arg value="-o"/>
  <arg value="-Gratio=0.7"/>
  <arg value="-Eminlen=2"/>
  <targetfile/>
  <srcfile/>
  <fileset dir="${reports.dir}" includes="*.dot"/>
  <mapper type="glob" from="*.dot" to="*.png"/>
  </apply>
  </target>

Thanks for answer.