This repository has been archived by the owner on Dec 23, 2023. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 23
/
AbstractPlantUMLWriter.java
436 lines (353 loc) · 15.7 KB
/
AbstractPlantUMLWriter.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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
package com.structurizr.io.plantuml;
import com.structurizr.Workspace;
import com.structurizr.model.*;
import com.structurizr.util.StringUtils;
import com.structurizr.view.*;
import java.io.IOException;
import java.io.StringWriter;
import java.io.Writer;
import java.net.URI;
import java.util.*;
import static java.lang.String.format;
public abstract class AbstractPlantUMLWriter {
private final Map<String, String> skinParams = new LinkedHashMap<>();
private final List<String> includes = new ArrayList<>();
private boolean useSequenceDiagrams = false;
AbstractPlantUMLWriter() {
}
public List<String> getIncludes() {
return includes;
}
public void addIncludeFile(String file) {
addIncludeFile(file, null);
}
public void addIncludeFile(String file, int id) {
addIncludeFile(file, String.valueOf(id));
}
public void addIncludeFile(String file, String id) {
if (id==null) {
includes.add(format("!include %s", file));
} else {
includes.add(format("!include %s!%s", file, id));
}
}
public void addIncludeURL(URI file) {
addIncludeURL(file, null);
}
public void addIncludeURL(URI file, int id) {
addIncludeURL(file, String.valueOf(id));
}
public void addIncludeURL(URI file, String id) {
if (id==null) {
includes.add(format("!includeurl %s", file));
} else {
includes.add(format("!includeurl %s!%s", file, id));
}
}
public void clearIncludes() {
includes.clear();
}
protected Map<String, String> getSkinParams() {
return skinParams;
}
public void addSkinParam(String name, String value) {
skinParams.put(name, value);
}
public void clearSkinParams() {
skinParams.clear();
}
public boolean isUseSequenceDiagrams() {
return useSequenceDiagrams;
}
public void setUseSequenceDiagrams(boolean useSequenceDiagrams) {
this.useSequenceDiagrams = useSequenceDiagrams;
}
/**
* Writes the views in the given workspace as PlantUML definitions, to the specified writer.
*
* @param workspace the workspace containing the views to be written
* @param writer the Writer to write to
*/
public final void write(Workspace workspace, Writer writer) {
if (workspace == null) {
throw new IllegalArgumentException("A workspace must be provided.");
}
if (writer == null) {
throw new IllegalArgumentException("A writer must be provided.");
}
workspace.getViews().getSystemLandscapeViews().forEach(v -> write(v, writer));
workspace.getViews().getSystemContextViews().forEach(v -> write(v, writer));
workspace.getViews().getContainerViews().forEach(v -> write(v, writer));
workspace.getViews().getComponentViews().forEach(v -> write(v, writer));
workspace.getViews().getDynamicViews().forEach(v -> write(v, writer));
workspace.getViews().getDeploymentViews().forEach(v -> write(v, writer));
}
/**
* Gets a single view as a PlantUML diagram definition.
*
* @param view the view to write
* @return the PlantUML definition as a String
*/
public final String toString(View view) {
StringWriter stringWriter = new StringWriter();
write(view, stringWriter);
return stringWriter.toString();
}
/**
* Creates PlantUML diagram definitions based upon the specified workspace.
*
* @param workspace the workspace containing the views to be written
* @return a collection of PlantUML diagram definitions, one per view
*/
public final Collection<PlantUMLDiagram> toPlantUMLDiagrams(Workspace workspace) {
if (workspace == null) {
throw new IllegalArgumentException("A workspace must be provided.");
}
Collection<PlantUMLDiagram> diagrams = new ArrayList<>();
for (View view : workspace.getViews().getViews()) {
StringWriter stringWriter = new StringWriter();
write(view, stringWriter);
diagrams.add(new PlantUMLDiagram(view.getKey(), view.getName(), stringWriter.toString()));
}
return diagrams;
}
/**
* Writes a single view as a PlantUML diagram definition, to the specified writer.
*
* @param view the view to write
* @param writer the Writer to write the PlantUML definition to
*/
public final void write(View view, Writer writer) {
if (view == null) {
throw new IllegalArgumentException("A view must be provided.");
}
if (writer == null) {
throw new IllegalArgumentException("A writer must be provided.");
}
if (SystemLandscapeView.class.isAssignableFrom(view.getClass())) {
write((SystemLandscapeView) view, writer);
} else if (SystemContextView.class.isAssignableFrom(view.getClass())) {
write((SystemContextView) view, writer);
} else if (ContainerView.class.isAssignableFrom(view.getClass())) {
write((ContainerView) view, writer);
} else if (ComponentView.class.isAssignableFrom(view.getClass())) {
write((ComponentView) view, writer);
} else if (DynamicView.class.isAssignableFrom(view.getClass())) {
write((DynamicView) view, writer);
} else if (DeploymentView.class.isAssignableFrom(view.getClass())) {
write((DeploymentView) view, writer);
}
}
protected void write(SystemLandscapeView view, Writer writer) {
writeSystemLandscapeOrContextView(view, writer, view.isEnterpriseBoundaryVisible());
}
protected void write(SystemContextView view, Writer writer) {
writeSystemLandscapeOrContextView(view, writer, view.isEnterpriseBoundaryVisible());
}
void writeSystemLandscapeOrContextView(View view, Writer writer, boolean showEnterpriseBoundary) {
try {
writeHeader(view, writer);
boolean enterpriseBoundaryVisible;
enterpriseBoundaryVisible =
showEnterpriseBoundary &&
(view.getElements().stream().map(ElementView::getElement).anyMatch(e -> e instanceof Person && ((Person)e).getLocation() == Location.Internal) ||
view.getElements().stream().map(ElementView::getElement).anyMatch(e -> e instanceof SoftwareSystem && ((SoftwareSystem)e).getLocation() == Location.Internal));
view.getElements().stream()
.map(ElementView::getElement)
.filter(e -> e instanceof Person && ((Person)e).getLocation() != Location.Internal)
.sorted(Comparator.comparing(Element::getName))
.forEach(e -> write(view, e, writer, false));
view.getElements().stream()
.map(ElementView::getElement)
.filter(e -> e instanceof SoftwareSystem && ((SoftwareSystem)e).getLocation() != Location.Internal)
.sorted(Comparator.comparing(Element::getName))
.forEach(e -> write(view, e, writer, false));
if (enterpriseBoundaryVisible) {
String name = view.getModel().getEnterprise() != null ? view.getModel().getEnterprise().getName() : "Enterprise";
writer.write("package \"" + name + "\" {");
writer.write(System.lineSeparator());
}
view.getElements().stream()
.map(ElementView::getElement)
.filter(e -> e instanceof Person && ((Person)e).getLocation() == Location.Internal)
.sorted(Comparator.comparing(Element::getName))
.forEach(e -> write(view, e, writer, true));
view.getElements().stream()
.map(ElementView::getElement)
.filter(e -> e instanceof SoftwareSystem && ((SoftwareSystem)e).getLocation() == Location.Internal)
.sorted(Comparator.comparing(Element::getName))
.forEach(e -> write(view, e, writer, true));
if (enterpriseBoundaryVisible) {
writer.write("}");
writer.write(System.lineSeparator());
}
writeRelationships(view, writer);
writeFooter(writer);
} catch (IOException e) {
e.printStackTrace();
}
}
protected abstract void write(ContainerView view, Writer writer);
protected abstract void write(ComponentView view, Writer writer);
protected abstract void write(DynamicView view, Writer writer);
void write(DeploymentView view, Writer writer) {
try {
writeHeader(view, writer);
view.getElements().stream()
.filter(ev -> ev.getElement() instanceof DeploymentNode && ev.getElement().getParent() == null)
.map(ev -> (DeploymentNode)ev.getElement())
.sorted(Comparator.comparing(Element::getName))
.forEach(e -> write(view, e, writer, 0));
writeRelationships(view, writer);
writeFooter(writer);
} catch (IOException e) {
e.printStackTrace();
}
}
protected abstract void write(View view, DeploymentNode deploymentNode, Writer writer, int indent);
String calculateIndent(int indent) {
StringBuilder buf = new StringBuilder();
for (int i = 0; i < indent; i++) {
buf.append(" ");
}
return buf.toString();
}
void write(View view, Element element, Writer writer, boolean indent) {
write(view, element, writer, indent ? 1 : 0);
}
protected abstract void write(View view, Element element, Writer writer, int indent);
String backgroundOf(View view, Element element) {
return view.getViewSet().getConfiguration().getStyles().findElementStyle(element).getBackground();
}
String strokeOf(View view, Element element) {
String stroke = view.getViewSet().getConfiguration().getStyles().findElementStyle(element).getStroke();
if (element instanceof DeploymentNode) {
return stroke != null ? stroke : "#000000";
} else {
if (stroke != null) {
return stroke;
} else {
java.awt.Color color = java.awt.Color.decode(backgroundOf(view, element));
return String.format("#%06X", (0xFFFFFF & color.darker().getRGB()));
}
}
}
String colorOf(View view, Element element) {
return view.getViewSet().getConfiguration().getStyles().findElementStyle(element).getColor();
}
Shape shapeOf(View view, Element element) {
return view.getViewSet().getConfiguration().getStyles().findElementStyle(element).getShape();
}
String plantUMLShapeOf(View view, Element element) {
Shape shape = view.getViewSet().getConfiguration().getStyles().findElementStyle(element).getShape();
if (element instanceof DeploymentNode) {
return "node";
}
switch(shape) {
case Person:
return "actor";
case Component:
return "component";
case Cylinder:
return "database";
case Folder:
return "folder";
case Ellipse:
case Circle:
return "storage";
default:
return "rectangle";
}
}
String plantumlSequenceType(View view, Element element) {
Shape shape = view.getViewSet().getConfiguration().getStyles().findElementStyle(element).getShape();
switch(shape) {
case Box:
return "participant";
case Person:
return "actor";
case Cylinder:
return "database";
case Folder:
return "collections";
case Ellipse:
case Circle:
return "entity";
default:
return "participant";
}
}
RelationshipStyle relationshipStyleOf(View view, Relationship relationship) {
return view.getViewSet().getConfiguration().getStyles().findRelationshipStyle(relationship);
}
String idOf(Element e) {
return e.getId();
}
String typeOf(Element e, boolean includeMetadataSymbols) {
String type;
if (e instanceof SoftwareSystem) {
type = "Software System";
} else if (e instanceof Container) {
Container container = (Container)e;
type = "Container" + (hasValue(container.getTechnology()) ? ": " + container.getTechnology() : "");
} else if (e instanceof Component) {
Component component = (Component)e;
type = "Component" + (hasValue(component.getTechnology()) ? ": " + component.getTechnology() : "");
} else if (e instanceof DeploymentNode) {
DeploymentNode deploymentNode = (DeploymentNode)e;
type = "Deployment Node" + (hasValue(deploymentNode.getTechnology()) ? ": " + deploymentNode.getTechnology() : "");
} else if (e instanceof InfrastructureNode) {
InfrastructureNode infrastructureNode = (InfrastructureNode)e;
type = "Infrastructure Node" + (hasValue(infrastructureNode.getTechnology()) ? ": " + infrastructureNode.getTechnology() : "");
} else if (e instanceof ContainerInstance) {
Container container = ((ContainerInstance)e).getContainer();
type = "Container" + (hasValue(container.getTechnology()) ? ": " + container.getTechnology() : "");
} else {
type = e.getClass().getSimpleName();
}
if (includeMetadataSymbols) {
return "[" + type + "]";
} else {
return type;
}
}
boolean hasValue(String s) {
return !StringUtils.isNullOrEmpty(s);
}
protected void writeHeader(View view, Writer writer) throws IOException {
// Spaces in PlantUML ids can cause issues. Alternatively, id can be surrounded with double quotes
writer.write(format("@startuml(id=%s)", view.getKey().replace(' ', '_')));
writer.write(System.lineSeparator());
for (String include : includes) {
writer.write(include);
writer.write(System.lineSeparator());
}
String viewTitle = view.getTitle();
if (StringUtils.isNullOrEmpty(viewTitle)) {
viewTitle = view.getName();
}
writer.write("title " + viewTitle);
writer.write(System.lineSeparator());
if (view.getDescription() != null && view.getDescription().trim().length() > 0) {
writer.write("caption " + view.getDescription());
writer.write(System.lineSeparator());
}
writer.write(System.lineSeparator());
if (!skinParams.isEmpty()) {
writer.write(format("skinparam {%s", System.lineSeparator()));
for (final String name : skinParams.keySet()) {
writer.write(format(" %s %s%s", name, skinParams.get(name), System.lineSeparator()));
}
writer.write(format("}%s", System.lineSeparator()));
}
}
protected void writeRelationships(View view, Writer writer) {
view.getRelationships().stream()
.sorted(Comparator.comparing(rv -> (rv.getRelationship().getSource().getName() + rv.getRelationship().getDestination().getName())))
.forEach(r -> writeRelationship(view, r, writer));
}
protected abstract void writeRelationship(View view, RelationshipView relationshipView, Writer writer);
protected void writeFooter(Writer writer) throws IOException {
writer.write("@enduml");
}
}