UML, workflow data visualization tool plantUML
PlantUML will be a tool that can automatically draw a variety of open source data models and is based on graphviz, an open source drawing tool provided by AT&T Laboratories. It will be a component for quickly creating various diagrams such as those shown below.
A sequence diagram is a diagram that describes the outline, specifications, and processing flow of a system, and is used as a design document for system development. It is characterized by the fact that it describes the interactions between classes and objects along a time axis and in accordance with a certain format. It is used not only during design, but also to grasp the details of the system during the development, maintenance, and operation phases.
A use case diagram is a representation of how a system should function (use cases) and its external environment (actors). It allows us to see the system from the end-user’s point of view and thus communicate with end-users and domain experts to ensure a mutual understanding of their requirements. It is also something that can clarify the boundaries between the outside and inside of the system.
A class diagram is one of the basic diagrams of UML, which expresses the classes that make up the system and their relationships. It also represents the attributes (properties) and operations (methods) that each class holds.
An object diagram is one of the diagrams specified in UML (Unified Modeling Language), which is used for software design, etc. It represents concrete objects that appear in actual situations and the relationships among them. The difference between an object diagram and a class diagram is whether the internal structure of the system is represented by concrete objects or abstract classes.
An activity diagram (flowchart) is a type of UML that illustrates “the flow of system execution and conditional branching. Specifically, it describes the functions of a task from start to finish in the order in which they are executed.
While UML describes the flow of a system, an activity diagram describes the “flow of entity control. Control of an entity means “what kind of actions (activities) occur. Therefore, Activity Diagrams are easier to understand visually “what kind of actions occur” than other UML diagrams.
A component diagram is one of the diagrams specified in the Unified Modeling Language (UML), which is used for software design, etc., and represents the relationships among the elements that make up a system. Large-scale software is usually implemented as a combination of software components such as multiple executable files, library files, and modules. A component diagram describes what kind of components a system consists of and how they depend on each other.
A UML deployment diagram is a static representation of how a processing node and the components that run on that node will be configured at runtime. Stated differently, a deployment diagram represents the hardware of the system, the software installed on that hardware, and the middleware that connects the different types of machines together.
A state transition diagram (state machine diagram) is a graphical representation of how a certain state changes (transition). By creating a state transition diagram when designing software, it is possible to prevent omissions and omissions of test items.
A timing diagram is a diagram that represents the state of a class or object in chronological order. It can express the timing (trigger) of state transitions, messages to other objects, etc.
The following non-UML diagrams are also supported
In addition, there are the following features
- Hyperlinks and tooltips
- Creole: text modifiers, pictograms, unicode, icons
- OpenIconic icons
- Sprite icons
- Mathematical expressions with AsciiMath
There are many ways to use plantUML.
- Use as Java (basically this is how it is used in case of windows)
To use PlantUML as Java, first download the PlantUML jar file from the official download page, then download the base graphviz from the official download page, store each in a file, and execute plantuml.jar in a terminal. At that time, specify the location of dot.exe included in graphviz.
> java -jar plantuml.jar -graphvizdot C:Graphvizbindot.exe ...- For use on Mac
It can also be used on Mac using brew.
> brew install graphviz
> brew install plantumlCreate a UML file with text editor
//architecture.uml
@startuml
actor User
participant "First Class" as A
participant "Second Class" as B
participant "Last Class" as C
User -> A: DoWork
activate A
A -> B: Create Request
activate B
B -> C: DoWork
activate C
@endumlExecute.
$ plantuml architecture.umlThe following results are output
- Use of web tool (plant UML editor)
The web tool (plantUML editor) can be used without installation.
- How to build into your application
When considering an application that searches/converts database data and outputs it in UML format, the simplest form is to use Java as a library, as described in “Java, Scala and Koltlin, a general-purpose application construction environment. Clojure, which is LISP running on the JVM, is used as a library using the method described in “Integrating Clojure and Java“.
There is also a method to set up plantUML as a server and communicate with it via API.
There are also methods to use plantUML in Javascript, such as integration with Jquery, “calling PlantUML using JavaScript,” and node-plantUML.
コメント