Skip to content

Jessianngeorge/UmlGeneratorTool

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

UmlGenerator

UML Generator provides APIs for generating UML diagrams from java source. The UML Generator uses plantuml and graphviz liraries for generating diagrams. The utility outputs UML in following format files:

  • Plantuml text file (.plantuml) - Any plantuml standard viewer can be used to view the UML diagram.
  • Diagram UML file (.png)

The library supports following UML diagrams:

Class Diagram

![ScreenShot](https://github.com/suken/UmlGeneratorTool/blob/master/UmlGeneratorTool/icons/ClassDiagramIcon.png) The class diagram generates the followings:
  • Fields if {@code fieldsIncluded} set to TRUE
  • Methods if {@code methodIncluded} set TRUE
  • Parent class depedencies
  • Implemented interfaces
  • Composite class dependencies
![ScreenShot](https://github.com/suken/UmlGeneratorTool/blob/master/Resources/SampleClassDiagram.png)

Spring Dependency Diagram

![ScreenShot](https://github.com/suken/UmlGeneratorTool/blob/master/UmlGeneratorTool/icons/SpringIcon.png) In addition to plain class diagram, the spring class diagram also generates followings:
  • Autowired depedencies
  • Required depedencies
  • Resource depedencies
  • Component classes
  • Controller classes
  • Service classes
  • Repository classes
  • Bean classes
  • Configuration classes
  • Additional comments are provided for class level annotations.
![ScreenShot](https://github.com/suken/UmlGeneratorTool/blob/master/Resources/SampleSpringDependencyDiagram.png)

JPA Mapping diagram

![ScreenShot](https://github.com/suken/UmlGeneratorTool/blob/master/UmlGeneratorTool/icons/JPAIcon.png) The JPA mapping diagram utility can be used to identify the relationship between persistent classes. The utility generates the following:
  • Persistent entity types (ENTITY, TABLE or MAPPED SUPER CLASSES)
  • Inheritance of persistent entities.
  • Mapped relationships (OntToOne, ManyToOne, OneToMany)
  • Database table name
  • Mapped database columns
  • Identifier columns
Following is the sample generated JPA mapping diagram. ![ScreenShot](https://github.com/suken/UmlGeneratorTool/blob/master/Resources/SampleJPAMappingDiagram.png)

Component Diagram (Maven)

![ScreenShot](https://github.com/suken/UmlGeneratorTool/blob/master/UmlGeneratorTool/icons/ComponentDiagramIcon.png) The method recursively inspects the given source directory to parse all POM files.
![ScreenShot](https://github.com/suken/UmlGeneratorTool/blob/master/Resources/SampleComponentDiagram.png)

Warning

If the UML diagram is too complicated then the GraphViz may not generate the PNG file. Try opening the plantuml file in plantuml eclipse plugin.

UmlGeneratorTool

The UmlGeneratorTool is an Eclipse plugin to allow developers to generate UML diagrams from eclipse projects. The Eclipse plugin is compatible with Eclipse 3.5+ distributions. If you are using older version of Eclipse than God Bless You ;)

Installation Guilde

Under construction. I am still setting up the maven repository for the two UML projects. Its too early for me to start releasing versions officially. But if you really feel like trying the tool out then simply import UmlGeneratorTool project in you eclipse and then export it as "Deployable plug-ins and fragments" into your eclipse plugin directory.

How to Generate UML diagrams

All the available UML diagrams can be generated from project contextual menu. Here is a screen shot:
![ScreenShot](https://github.com/suken/UmlGeneratorTool/blob/master/Resources/UmlGeneratorMenu.png)

Each diagram has its own options for UML generation. Please refer to the following:

Class Diagram and Spring Depedency Diagram

Component Diagram and JPA Mapping diagram

About

Java software development tool for Spring, JPA, class diagrams etc

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 100.0%