org.fulib.tools

Class ClassDiagrams

java.lang.Object

org.fulib.tools.ClassDiagrams

public class ClassDiagrams
extends java.lang.Object

To create a class diagram png for usage in java doc comments, dumpPng(model) creates file .../doc-files/classDiagram.png within the model source folder

 
      ClassModelBuilder mb = Fulib.classModelBuilder("de.uniks.studyright");
      ClassBuilder uni = mb.buildClass("University")
            .buildAttribute("name", mb.STRING);
      ClassBuilder student = mb.buildClass("Student")
            .buildAttribute("name", mb.STRING)
            .buildAttribute("studentId", mb.STRING)
            .buildAttribute("matNo", mb.INT);
      uni.buildAssociation(student, "students", mb.MANY, "uni", mb.ONE);
      ClassBuilder room = mb.buildClass("Room")
            .buildAttribute("roomNo", mb.STRING);
      uni.buildAssociation(room, "rooms", mb.MANY, "uni", mb.ONE)
            .setAggregation();
      room.buildAssociation(student, "students", mb.MANY, "in", mb.ONE);
      ClassBuilder professor = mb.buildClass("Professor");
      uni.buildAssociation(professor, "profs", mb.MANY, null, 1);

      ClassModel model = mb.getClassModel();
 
 

Constructor Summary

Constructors

Constructor and Description
ClassDiagrams()

Method Summary

Modifier and Type	Method and Description
java.lang.String	dump(org.fulib.classmodel.ClassModel model, java.lang.String diagramFileName, guru.nidi.graphviz.engine.Format format)
java.lang.String	dumpPng(org.fulib.classmodel.ClassModel model) create a class diagram png in modelFolder/doc-files/classDiagram.png
java.lang.String	dumpPng(org.fulib.classmodel.ClassModel model, java.lang.String diagramFileName) create a class diagram png in modelFolder/doc-files/classDiagram.png
java.lang.String	dumpSVG(org.fulib.classmodel.ClassModel model, java.lang.String diagramFileName) create a class diagram png in modelFolder/doc-files/classDiagram.png

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClassDiagrams

public ClassDiagrams()

Method Detail

dumpPng

public java.lang.String dumpPng(org.fulib.classmodel.ClassModel model)

create a class diagram png in modelFolder/doc-files/classDiagram.png

Parameters:

model -

dumpPng

public java.lang.String dumpPng(org.fulib.classmodel.ClassModel model,
                                java.lang.String diagramFileName)

create a class diagram png in modelFolder/doc-files/classDiagram.png

Parameters:

model -

dumpSVG

public java.lang.String dumpSVG(org.fulib.classmodel.ClassModel model,
                                java.lang.String diagramFileName)

create a class diagram png in modelFolder/doc-files/classDiagram.png

Parameters:

model -

dump

public java.lang.String dump(org.fulib.classmodel.ClassModel model,
                             java.lang.String diagramFileName,
                             guru.nidi.graphviz.engine.Format format)