4 | 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: 5 |
-
6 |
- Plantuml text file (.plantuml) - Any plantuml standard viewer can be used to view the UML diagram.
7 | - Diagram UML file (.png) 8 |
Class Diagram
14 |  15 | The class diagram generates the followings:16 |
-
17 |
- Fields if {@code fieldsIncluded} set to TRUE 18 |
- Methods if {@code methodIncluded} set TRUE 19 |
- Parent class depedencies 20 |
- Implemented interfaces 21 |
- Composite class dependencies 22 |
Spring Dependency Diagram
26 |  27 | In addition to plain class diagram, the spring class diagram also generates followings: 28 |-
29 |
- Autowired depedencies 30 |
- Required depedencies 31 |
- Resource depedencies 32 |
- Component classes 33 |
- Controller classes 34 |
- Service classes 35 |
- Repository classes 36 |
- Bean classes 37 |
- Configuration classes 38 |
- Additional comments are provided for class level annotations. 39 |
JPA Mapping diagram
45 |  46 | The JPA mapping diagram utility can be used to identify the relationship between persistent classes. The utility generates the following: 47 |-
48 |
- Persistent entity types (ENTITY, TABLE or MAPPED SUPER CLASSES) 49 |
- Inheritance of persistent entities. 50 |
- Mapped relationships (OntToOne, ManyToOne, OneToMany) 51 |
- Database table name 52 |
- Mapped database columns 53 |
- Identifier columns 54 |
Component Diagram (Maven)
60 |  61 | The method recursively inspects the given source directory to parse all POM files.62 |  63 | 64 | 65 |
Warning
66 | 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. 67 | 68 | 69 | UmlGeneratorTool 70 | ================== 71 | 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 ;) 72 | 73 |Installation Guilde
74 | 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. 75 | 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. 76 | 77 |How to Generate UML diagrams
78 | All the available UML diagrams can be generated from project contextual menu. Here is a screen shot:79 |  80 | 81 | Each diagram has its own options for UML generation. Please refer to the following:
82 | 83 | Class Diagram and Spring Depedency Diagram
84 |
85 |
86 | Component Diagram and JPA Mapping diagram87 |
88 |
--------------------------------------------------------------------------------
/UmlGenerator/src/main/java/com/uml/generator/jpa/models/JpaClassModel.java:
--------------------------------------------------------------------------------
1 | /**
2 | *
3 | */
4 | package com.uml.generator.jpa.models;
5 |
6 | import java.util.List;
7 | import java.util.Map;
8 | import java.util.Map.Entry;
9 |
10 | import lombok.Setter;
11 |
12 | import com.google.common.collect.Lists;
13 | import com.google.common.collect.Maps;
14 | import com.uml.generator.classDiagram.models.ClassModel;
15 | import com.uml.generator.classDiagram.models.ClassType;
16 |
17 | /**
18 | * @author SShah
19 | */
20 | public class JpaClassModel extends ClassModel {
21 |
22 | private static final String TABEL = " << (T,#BB3255) TABLE >> ";
23 | private static final String MAPPED_SUPER_CLASS = " << (M,#CD45FF) MAPPED SUPER CLASS >> ";
24 | private static final String ENTITY_CLASS = " << (E,#ACFFFF) ENTITY >> ";
25 | private static final String COLUMNS_SEPARATOR = "__COLUMNS__";
26 | private static final String ID_COLUMNS_SEPARATOR ="__ID COLUMNS__";
27 | private static final String TABLE_NAME_SEPARATOR = "__TABLE__";
28 | private static final String ONE_TO_ONE_UML_STR = "--";
29 |
30 | @Setter
31 | private String tableName;
32 | @Setter
33 | private JpaEntityType jpaEntityType;
34 | private final Map-
35 | *
- plant uml text file (*.plantuml) 36 | *
- class diagram UML file (*.png) 37 | *
-
41 | *
- Fields if {@code fieldsIncluded} set to TRUE 42 | *
- Methods if {@code methodIncluded} set TRUE 43 | *
- Parent class depedencies 44 | *
- Implemented interfaces 45 | *
- Composite class dependencies 46 | *
49 | * If the component diagram is too complicated then the GraphViz may not generate the PNG file. Try opening the plantuml file in plantuml eclipse plugin. 50 | *
51 | * 52 | * @param projectJarUrl URL of the project jar for which the class diagram is to be generated. 53 | * @param jarURLs dependent jars 54 | * @param packagesIncluded Are packages included? 55 | * @param fieldsIncluded Are fields included? 56 | * @param methodsIncluded Are methods included? 57 | * @param testIncluded Are tests included? 58 | * @param projectName name of the project 59 | * @param umlDirPath Output directory path 60 | * @throws Exception If anything goes wrong just raise it to the caller. 61 | */ 62 | public static void generateClassDiagram(URL projectJarUrl, URL[] jarURLs, String projectName, String umlDirPath, UmlOptions options) throws Exception { 63 | ClassLoader loader = Thread.currentThread().getContextClassLoader(); 64 | try { 65 | // parse all the classes from the jars 66 | URLClassLoader classLoader = new URLClassLoader(jarURLs); 67 | Thread.currentThread().setContextClassLoader(classLoader); 68 | ClassDiagramModel classDiagramModel = ClassDiagramGenerator.generateClassDependencies(classLoader, projectJarUrl, options); 69 | String uml = classDiagramModel.getUml().replace("$", "_Inner"); 70 | 71 | // generate the UML and plant uml text files 72 | String sourceFilePath = exportToPlantUMLFile(projectName, umlDirPath, uml, "_ClassDiagram"); 73 | exportToFile(projectName, umlDirPath, sourceFilePath, "_ClassDiagram", options.getFileFormat()); 74 | } 75 | finally { 76 | Thread.currentThread().setContextClassLoader(loader); 77 | } 78 | } 79 | 80 | /** 81 | * Generate the Spring class diagram for the given project jar. The method generates following: 82 | *
-
83 | *
- plant uml text file (*.plantuml) 84 | *
- class diagram UML file (*.png) 85 | *
-
89 | *
- Autowired depedencies 90 | *
- Required depedencies 91 | *
- Resource depedencies 92 | *
- Component classes 93 | *
- Controller classes 94 | *
- Service classes 95 | *
- Repository classes 96 | *
- Bean classes 97 | *
- Configuration classes 98 | *
- Additional comments are provided for class level annotations. 99 | *
102 | * If the component diagram is too complicated then the GraphViz may not generate the PNG file. Try opening the plantuml file in plantuml eclipse plugin. 103 | *
104 | * 105 | * @param projectJarUrl URL of the project jar for which the class diagram is to be generated. 106 | * @param jarURLs dependent jars 107 | * @param packagesIncluded Are packages included? 108 | * @param fieldsIncluded Are fields included? 109 | * @param methodsIncluded Are methods included? 110 | * @param testIncluded Are tests included? 111 | * @param projectName name of the project 112 | * @param umlDirPath Output directory path 113 | * @throws Exception If anything goes wrong just raise it to the caller. 114 | */ 115 | public static void generateSpringClassDiagram(URL projectJarUrl, URL[] jarURLs, String projectName, String umlDirPath, UmlOptions options) throws IOException { 116 | ClassLoader loader = Thread.currentThread().getContextClassLoader(); 117 | try { 118 | // parse all the classes from the jars 119 | URLClassLoader classLoader = new URLClassLoader(jarURLs); 120 | Thread.currentThread().setContextClassLoader(classLoader); 121 | String uml = SpringDependencyDiagramGenerator.generateSpringDependencies(classLoader, projectJarUrl, options).replace("$", "_Inner"); 122 | 123 | // generate the UML and plant uml text files 124 | exportToPlantUMLFile(projectName, umlDirPath, uml, "_SpringDependencyDiagram"); 125 | exportToFile(projectName, umlDirPath, uml, "_SpringDependencyDiagram", options.getFileFormat()); 126 | } 127 | finally { 128 | Thread.currentThread().setContextClassLoader(loader); 129 | } 130 | } 131 | 132 | /** 133 | * Generates the component diagram for the given MAVEN project. The method generates the following: 134 | *
-
135 | *
- plantuml text file (*.plantuml) 136 | *
- component diagram image file (*.png) 137 | *
140 | * The method recursively inspects the given source directory to parse all POM files. 141 | *
142 | *
143 | * Warning
144 | * If the component diagram is too complicated then the GraphViz may not generate the PNG file. Try opening the plantuml file in plantuml eclipse plugin.
145 | *
146 | * @param srcDir directory which contains the POM files.
147 | * @param projectName Name of the project for which the component diagram is to be generated.
148 | * @param includePatterns regular expression of included artifact id patterns
149 | * @param excludePatterns regular expression of excluded artifact id patterns
150 | * @param umlDirPath output directory to write UML
151 | * @throws Exception If anything goes wrong then raise it to the caller.
152 | */
153 | public static void generateComponentDiagram(String srcDir, String projectName, String umlDirPath, UmlOptions options) throws Exception {
154 | String uml = ComponentDiagramGenerator.generateComponentDiagram(srcDir, options);
155 | // generate the UML and plant uml text files
156 | exportToPlantUMLFile(projectName, umlDirPath, uml, "_ComponentDiagram");
157 | exportToFile(projectName, umlDirPath, uml, "_ComponentDiagram", options.getFileFormat());
158 | }
159 |
160 | /**
161 | * Generates the JPA mapping diagram for the given project. The method generates the following:
162 | *
-
163 | *
- plantuml text file (*.plantuml) 164 | *
- component diagram image file (*.png) 165 | *
168 | * If the component diagram is too complicated then the GraphViz may not generate the PNG file. Try opening the plantuml file in plantuml eclipse plugin. 169 | * 170 | * @param srcDir directory which contains the POM files. 171 | * @param projectName Name of the project for which the component diagram is to be generated. 172 | * @param includePatterns regular expression of included artifact id patterns 173 | * @param excludePatterns regular expression of excluded artifact id patterns 174 | * @param umlDirPath output directory to write UML 175 | * @throws Exception If anything goes wrong then raise it to the caller. 176 | */ 177 | public static void generateJPAMappingDiagram(URL projectJarUrl, URL[] jarURLs, String projectName, String umlDirPath, UmlOptions options) throws Exception { 178 | ClassLoader loader = Thread.currentThread().getContextClassLoader(); 179 | try { 180 | // parse all the classes from the jars 181 | URLClassLoader classLoader = new URLClassLoader(jarURLs); 182 | Thread.currentThread().setContextClassLoader(classLoader); 183 | String uml = JpaMappingDiagramGenerator.generateJpaDependencies(classLoader, projectJarUrl, options).replace("$", "_Inner"); 184 | 185 | // generate the UML and plant uml text files 186 | exportToPlantUMLFile(projectName, umlDirPath, uml, "_JPAMappingDiagram"); 187 | exportToFile(projectName, umlDirPath, uml, "_JPAMappingDiagram", options.getFileFormat()); 188 | } 189 | finally { 190 | Thread.currentThread().setContextClassLoader(loader); 191 | } 192 | } 193 | 194 | private static String exportToPlantUMLFile(String projectName, String umlDirPath, String uml, String filePostfix) throws IOException { 195 | LOGGER.log(Level.INFO, "Writing PlantUML string to *.plantuml file"); 196 | String umlStringFile = umlDirPath + File.separator + projectName + filePostfix + ".plantuml"; 197 | // write plant UML text file 198 | BufferedWriter writer = new BufferedWriter(new FileWriter(umlStringFile)); 199 | writer.write(uml); 200 | writer.flush(); 201 | writer.close(); 202 | LOGGER.log(Level.INFO, "The UML diagram is generated under " + umlDirPath); 203 | return umlStringFile; 204 | } 205 | 206 | private static void exportToFile(String projectName, String umlDirPath, String sourceFilePath, String filePostfix, FileFormat format) throws IOException { 207 | LOGGER.log(Level.INFO, "Writing PlantUML string to *." + format + " file"); 208 | // String umlFile = umlDirPath + File.separator + projectName + filePostfix + ".png"; 209 | // File umlDir = new File(umlDirPath); 210 | // if (umlDir.exists()) { 211 | // umlDir.delete(); 212 | // } 213 | 214 | // write the plant UML image file 215 | SourceFileReader reader = new SourceFileReader(new File(sourceFilePath), new File(umlDirPath), new FileFormatOption(format)); 216 | reader.getGeneratedImages(); 217 | } 218 | 219 | } 220 | -------------------------------------------------------------------------------- /UmlGenerator/src/main/java/com/uml/generator/jpa/JpaMappingDiagramGenerator.java: -------------------------------------------------------------------------------- 1 | /** 2 | * 3 | */ 4 | package com.uml.generator.jpa; 5 | 6 | import java.lang.annotation.Annotation; 7 | import java.lang.reflect.Field; 8 | import java.lang.reflect.InvocationTargetException; 9 | import java.lang.reflect.Method; 10 | import java.lang.reflect.ParameterizedType; 11 | import java.lang.reflect.Type; 12 | import java.net.URL; 13 | import java.net.URLClassLoader; 14 | import java.util.ArrayList; 15 | import java.util.Enumeration; 16 | import java.util.HashMap; 17 | import java.util.List; 18 | import java.util.Map; 19 | import java.util.jar.JarEntry; 20 | import java.util.jar.JarFile; 21 | 22 | import javax.persistence.Column; 23 | import javax.persistence.Entity; 24 | import javax.persistence.Id; 25 | import javax.persistence.ManyToMany; 26 | import javax.persistence.ManyToOne; 27 | import javax.persistence.MappedSuperclass; 28 | import javax.persistence.OneToMany; 29 | import javax.persistence.OneToOne; 30 | import javax.persistence.Table; 31 | 32 | import com.uml.generator.UmlGeneratorUtility; 33 | import com.uml.generator.UmlOptions; 34 | import com.uml.generator.jpa.models.JpaClassModel; 35 | import com.uml.generator.jpa.models.JpaDependencyDiagramModel; 36 | import com.uml.generator.jpa.models.JpaDependencyType; 37 | import com.uml.generator.jpa.models.JpaEntityType; 38 | 39 | /** 40 | * @author SShah 41 | */ 42 | public class JpaMappingDiagramGenerator { 43 | 44 | public static String generateJpaDependencies(final URLClassLoader classLoader, final URL jarUrl, final UmlOptions options) { 45 | JpaDependencyDiagramModel dependencyModel = new JpaDependencyDiagramModel(); 46 | try { 47 | List
45 | * Subclasses of this class can get the projects selected by the user by calling
46 | * {@link MultipleProjectAction#getSelectedProjects()}
47 | *
48 | */
49 | public abstract class MultipleProjectAction implements IObjectActionDelegate {
50 |
51 | private static final Logger LOGGER = Logger.getLogger("MultipleProjectAction");
52 |
53 | /**
54 | * Projects selected by the user.
55 | */
56 | private List