UML – Daoyuan Li

Generating UML diagram from Java source code

Published 2011/05/02 by Daoyuan Li

Sometimes we may need to generate UML diagrams from source codes. Here’s what I do for Java code: graphviz + ant + UMLGraph. Details below:

1. Install graphviz and ant, download UMLGraph from http://www.umlgraph.org/

2. Place UMLGraph.jar in your project, for example, under
lib/

3. Write or modify your ant script, for example:

<project name="Proxy" default="javadocs" basedir=".">
   <description>
   The specification for the Java-based umlgraph build processes.
</description>
 
   <!-- set global properties for this build -->
   <property name="src" location="src"/>
   <property name="build" location="bin" />
   <property name="javadoc" location="javadocs" />
   <property name="lib" location="lib" />
   <!-- import environment variables -->
   <property environment="env" />
 
   <target name="init">
       <!-- Create the time stamp-->
       <tstamp />
       <!-- Create the build directory structure used by compile -->
       <mkdir dir="${build}" />
       <mkdir dir="${lib}" />
       <mkdir dir="${javadoc}" />
  </target>
 
   <target name="compile" depends="init" description="compile the source, build library ">
       <javac srcdir="${src}" destdir="${build}" debug="true" deprecation="true">
           <classpath>
               <pathelementpath="${classpath}" />
               <fileset dir="lib">
                   <include name="*.jar" />
               </fileset>
          </classpath>
           <compilerarg value="-Xlint" />
       </javac>
   </target>
 
   <target name="javadocs" depends="compile">
       <javadoc sourcepath="${src}" packagenames="com.nomadiclab.*" destdir="${javadoc}"private="true">
           <doclet name="org.umlgraph.doclet.UmlGraphDoc" path="${lib}/UmlGraph.jar">
               <param name="-all" />
               <param name="-inferrel"/>
                <param name="-inferdep" />
               <param name="-collapsible" />
               <param name="-hide" value="java.*"/>
               <param name="-collpackages" value="java.util.*" />
               <param name="-qualify" />
               <param name="-postfixpackage"/>
               <param name="-nodefontsize" value="9" />
               <param name="-nodefontpackagesize" value="7" />
          </doclet>
       </javadoc>
  </target>
 
</project>

The specification for the Java-based umlgraph build processes.

</description>

</target>

<pathelementpath="${classpath}" />

</fileset>

</classpath>

</javac>

</target>

</doclet>

</javadoc>

</target>

</project>

4. Run this ant script.

ant javadocs

1	ant javadocs

5. You will get the UML class diagram as expected in the generated Java docs. Here’s one example (click to enlarge):

UML Review

Published 2010/09/11 by Daoyuan Li

Input and output of different stages in software development:

Stage	Inputs	Outputs
Requirement Analysis	Stackeholders, goals, existing bussiness processes	Business models, use case models, prototypes
Systems Analysis	Business models, use case models, prototypes	Use case definitions, object model, prototypes
Design	Use case definitions, object model, prototypes	Object model, data model, component model, architectural view, interface specifications
Implementation	Object model, data model, component model, architectural view, interface specifications	Source code, complied code, database, interfaces, deployment plan
Testing	Business models, use case models, use case definitions	Fault report, acceptance

Activity diagrams are used to describe flows in a variety of situations, they are flow diagrams and can be used in business modelling, requirements modelling, systems analysis and design.

Use case diagrams are used to show the presentation of functionality of a system and its interaction with the outside world. The diagrams show the boundaries of software systems but do not specify functionalities. They can be used in business modelling and requirements modelling.

Class diagrams show the static structure of a system, with classes and relationships between classes. They are used in business modelling, requirements modelling, systems analysis and design.

Statechart diagrams are used for modelling the internal state changes of and object and are a variant of activity diagrams with largely the same notation. They are used in business modelling, requirements modelling, systems analysis and design.

Sequence diagrams provide a time-ordered mapping of steps in the execution of a scenario into interactions between objects. They are one of the primary tools ofr elaborating use cases in analysis and design. They are used in systems analysis and design.

Collaboration diagrams provide a mapping of steps in the execution of a scenario into interactions between objects, drawn in two dimension in a similar way to class diagrams. They are used for similar purposes to sequence diagrams, but present the information in a different way.

Component diagrams show the implementation structure of the application and are used by the designer to indicate where the objects are implemented and how the components interact.

Reference: Ken Lunn, Software Development with UML, Palgrave Macmillan, New York, 2003, pp362-376

Functional requirements

Published 2010/07/07 by Daoyuan Li

1. Features

1) For general users

a) Simulation of a simple Olympic medal tracking system.
b) The system should allow general users to access the medal tracker pages without requiring them to login. They should be able to see the number of medals (broken down to gold, silver, bronze, and total) won by each country in a sorted list. Users should be able to sort by gold medals and total medals.
c) The system should also enable general users to go to any particular country and check the number of medals the country has collected in each event.
d) Finally a user can go to any athlete and find out the number of medal(s) won by this athlete, broken down by events.
2) For the administrator

a) The system should have admin login functionality for the administrator to input and correct the data.
b) Once an administrator logs into the admin account, the system should provide the capabilities of assigning and removing a medal from any country for any event by any athlete.
c) The system needs to give admin user an option to logoff.
d) Without requiring them to login, the system should also allow general users to access the medal tracker pages. They should be able to see the number of medals (broken down to gold, silver, bronze, and total) won by each country in a sorted list. Users should be able to sort by gold medals and total medals.
e) The system should also enable general users to go to any particular country and check the number of medals the country has collected in each event.
f) Finally a user can go to any athlete and find out the number of medal(s) won by this athlete, broken down by events.
2. Performance

1. The default page for general users should be a rank by gold medals.
2. Web pages should display well in IE version 6.0 or above.
3. Login link for the administrator should be obvious on page.
4. Languages displayed on pages can be decided by the team, English and Chinese are both OK.
5. Scalability is not an important issue.
6. Search function should be obvious and user-friendly.
7. The web page should be free of advertisements.
3. Speed

There are no speed requirements; but the system should respond within the time a regular user could stand.

4. Use cases

Tag: UML

Generating UML diagram from Java source code

UML Review

Functional requirements