-
-
Notifications
You must be signed in to change notification settings - Fork 282
/
WebSequenceDiagramsExporter.java
176 lines (141 loc) · 5.57 KB
/
WebSequenceDiagramsExporter.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
package com.structurizr.export.websequencediagrams;
import com.structurizr.export.AbstractDiagramExporter;
import com.structurizr.export.Diagram;
import com.structurizr.export.IndentingWriter;
import com.structurizr.model.*;
import com.structurizr.util.StringUtils;
import com.structurizr.view.*;
import java.util.LinkedHashSet;
import java.util.Set;
/**
* Exports dynamic diagram definitions that can be copy-pasted
* into https://www.websequencediagrams.com
*
* This implementation only supports a basic sequence of interactions,
* both synchronous and asynchronous. It doesn't support return messages,
* parallel behaviour, etc.
*/
public class WebSequenceDiagramsExporter extends AbstractDiagramExporter {
private static final String SYNCHRONOUS_INTERACTION = "->";
private static final String ASYNCHRONOUS_INTERACTION = "->>";
private static final String SYNCHRONOUS_INTERACTION_RETURN = "-->";
private static final String ASYNCHRONOUS_INTERACTION_RETURN = "-->>";
@Override
public Diagram export(SystemLandscapeView view) {
return null;
}
@Override
public Diagram export(SystemContextView view) {
return null;
}
@Override
public Diagram export(ContainerView view) {
return null;
}
@Override
public Diagram export(ComponentView view) {
return null;
}
@Override
public Diagram export(DynamicView view) {
IndentingWriter writer = new IndentingWriter();
writeHeader(view, writer);
Set<Element> elements = new LinkedHashSet<>();
for (RelationshipView relationshipView : view.getRelationships()) {
elements.add(relationshipView.getRelationship().getSource());
elements.add(relationshipView.getRelationship().getDestination());
}
for (Element element : elements) {
writeElement(view, element, writer);
}
writer.writeLine();
writeRelationships(view, writer);
writeFooter(view, writer);
return createDiagram(view, writer.toString());
}
@Override
public Diagram export(DeploymentView view) {
return null;
}
@Override
protected void writeHeader(ModelView view, IndentingWriter writer) {
writer.writeLine("title " + view.getName() + " - " + view.getKey());
writer.writeLine();
}
@Override
protected void writeFooter(ModelView view, IndentingWriter writer) {
}
@Override
protected void startEnterpriseBoundary(ModelView view, String enterpriseName, IndentingWriter writer) {
}
@Override
protected void endEnterpriseBoundary(ModelView view, IndentingWriter writer) {
}
@Override
protected void startGroupBoundary(ModelView view, String group, IndentingWriter writer) {
}
@Override
protected void endGroupBoundary(ModelView view, IndentingWriter writer) {
}
@Override
protected void startSoftwareSystemBoundary(ModelView view, SoftwareSystem softwareSystem, IndentingWriter writer) {
}
@Override
protected void endSoftwareSystemBoundary(ModelView view, IndentingWriter writer) {
}
@Override
protected void startContainerBoundary(ModelView view, Container container, IndentingWriter writer) {
}
@Override
protected void endContainerBoundary(ModelView view, IndentingWriter writer) {
}
@Override
protected void startDeploymentNodeBoundary(DeploymentView view, DeploymentNode deploymentNode, IndentingWriter writer) {
}
@Override
protected void endDeploymentNodeBoundary(ModelView view, IndentingWriter writer) {
}
@Override
protected void writeElement(ModelView view, Element element, IndentingWriter writer) {
if (element instanceof Person) {
writer.writeLine(String.format("actor <<%s>>\\n%s as %s",
view.getViewSet().getConfiguration().getTerminology().findTerminology(element),
element.getName(),
element.getName())
);
} else {
writer.writeLine(String.format("participant <<%s>>\\n%s as %s",
view.getViewSet().getConfiguration().getTerminology().findTerminology(element),
element.getName(),
element.getName())
);
}
}
@Override
protected void writeRelationship(ModelView view, RelationshipView relationshipView, IndentingWriter writer) {
Relationship r = relationshipView.getRelationship();
Element source = r.getSource();
Element destination = r.getDestination();
String description = relationshipView.getDescription();
String arrow = r.getInteractionStyle() == InteractionStyle.Asynchronous ? ASYNCHRONOUS_INTERACTION : SYNCHRONOUS_INTERACTION;
if (relationshipView.isResponse() != null && relationshipView.isResponse()) {
source = r.getDestination();
destination = r.getSource();
arrow = r.getInteractionStyle() == InteractionStyle.Asynchronous ? ASYNCHRONOUS_INTERACTION_RETURN : SYNCHRONOUS_INTERACTION_RETURN;
}
if (StringUtils.isNullOrEmpty(description)) {
description = relationshipView.getRelationship().getDescription();
}
// Thing A->Thing B: Description
writer.writeLine(String.format("%s%s%s: %s",
source.getName(),
arrow,
destination.getName(),
description
));
}
@Override
protected Diagram createDiagram(ModelView view, String definition) {
return new WebSequenceDiagramsDiagram(view, definition);
}
}