net.sourceforge.plantuml.xmi.XmiStateDiagram Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-asl Show documentation
Show all versions of plantuml-asl Show documentation
PlantUML is a component that allows to quickly write diagrams from text.
The newest version!
// THIS FILE HAS BEEN GENERATED BY A PREPROCESSOR.
/* +=======================================================================
* |
* | PlantUML : a free UML diagram generator
* |
* +=======================================================================
*
* (C) Copyright 2009-2024, Arnaud Roques
*
* Project Info: https://plantuml.com
*
* If you like this project or if you find it useful, you can support us at:
*
* https://plantuml.com/patreon (only 1$ per month!)
* https://plantuml.com/liberapay (only 1€ per month!)
* https://plantuml.com/paypal
*
*
* PlantUML is free software; you can redistribute it and/or modify it
* under the terms of the Apache Software License.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* PlantUML can occasionally display sponsored or advertising messages. Those
* messages are usually generated on welcome or error images and never on
* functional diagrams.
* See https://plantuml.com/professional if you want to remove them
*
* Images (whatever their format : PNG, SVG, EPS...) generated by running PlantUML
* are owned by the author of their corresponding sources code (that is, their
* textual description in PlantUML language). Those images are not covered by
* this APACHE license.
*
* The generated images can then be used without any reference to the APACHE license.
* It is not even necessary to stipulate that they have been generated with PlantUML,
* although this will be appreciated by the PlantUML team.
*
* There is an exception : if the textual description in PlantUML language is also covered
* by any license, then the generated images are logically covered
* by the very same license.
*
* This is the IGY distribution (Install GraphViz by Yourself).
* You have to install GraphViz and to setup the GRAPHVIZ_DOT environment variable
* (see https://plantuml.com/graphviz-dot )
*
* Icons provided by OpenIconic : https://useiconic.com/open
* Archimate sprites provided by Archi : http://www.archimatetool.com
* Stdlib AWS provided by https://github.com/milo-minderbinder/AWS-PlantUML
* Stdlib Icons provided https://github.com/tupadr3/plantuml-icon-font-sprites
* ASCIIMathML (c) Peter Jipsen http://www.chapman.edu/~jipsen
* ASCIIMathML (c) David Lippman http://www.pierce.ctc.edu/dlippman
* CafeUndZopfli ported by Eugene Klyuchnikov https://github.com/eustas/CafeUndZopfli
* Brotli (c) by the Brotli Authors https://github.com/google/brotli
* Themes (c) by Brett Schwarz https://github.com/bschwarz/puml-themes
* Twemoji (c) by Twitter at https://twemoji.twitter.com/
*
*/
package net.sourceforge.plantuml.xmi;
import static java.nio.charset.StandardCharsets.UTF_8;
import java.io.OutputStream;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Result;
import javax.xml.transform.Source;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerException;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import net.sourceforge.plantuml.abel.Entity;
import net.sourceforge.plantuml.abel.Link;
import net.sourceforge.plantuml.decoration.LinkDecor;
import net.sourceforge.plantuml.klimt.creole.Display;
import net.sourceforge.plantuml.statediagram.StateDiagram;
import net.sourceforge.plantuml.xml.XmlFactories;
public class XmiStateDiagram implements XmlDiagramTransformer {
private final StateDiagram diagram;
private final Document document;
private final Element ownedElement;
public XmiStateDiagram(StateDiagram diagram) throws ParserConfigurationException {
this.diagram = diagram;
final DocumentBuilder builder = XmlFactories.newDocumentBuilder();
this.document = builder.newDocument();
document.setXmlVersion("1.0");
document.setXmlStandalone(true);
final Element xmi = document.createElement("XMI");
xmi.setAttribute("xmi.version", "1.1");
xmi.setAttribute("xmlns:UML", "href://org.omg/UML/1.3");
document.appendChild(xmi);
final Element header = document.createElement("XMI.header");
xmi.appendChild(header);
final Element metamodel = document.createElement("XMI.metamodel");
metamodel.setAttribute("xmi.name", "UML");
metamodel.setAttribute("xmi.version", "1.3");
header.appendChild(metamodel);
final Element content = document.createElement("XMI.content");
xmi.appendChild(content);
final Element model = document.createElement("UML:Model");
model.setAttribute("xmi.id", CucaDiagramXmiMaker.getModel(diagram));
model.setAttribute("name", "PlantUML");
content.appendChild(model);
//
this.ownedElement = document.createElement("UML:Namespace.ownedElement");
model.appendChild(ownedElement);
for (final Entity gr : diagram.groups())
if (gr.getParentContainer().isRoot())
addState(gr, ownedElement);
for (final Entity ent : diagram.leafs())
if (ent.getParentContainer().isRoot())
addState(ent, ownedElement);
for (final Link link : diagram.getLinks())
addLink(link);
}
private void addState(final Entity tobeAdded, Element container) {
final Element elementState = createEntityNode(tobeAdded);
container.appendChild(elementState);
for (final Entity ent : diagram.groups())
if (ent.getParentContainer() == tobeAdded)
addState(ent, elementState);
for (final Entity ent : diagram.leafs())
if (ent.getParentContainer() == tobeAdded)
addState(ent, elementState);
}
public static String forXMI(String s) {
return s.replace(':', ' ');
}
public static String forXMI(Display s) {
return s.get(0).toString().replace(':', ' ');
}
private void addLink(Link link) {
final String assId = "ass" + diagram.getUniqueSequence();
final Element association = document.createElement("UML:Association");
association.setAttribute("xmi.id", assId);
association.setAttribute("namespace", CucaDiagramXmiMaker.getModel(diagram));
if (Display.isNull(link.getLabel()) == false)
association.setAttribute("name", forXMI(link.getLabel()));
final Element connection = document.createElement("UML:Association.connection");
final Element end1 = document.createElement("UML:AssociationEnd");
end1.setAttribute("xmi.id", "end" + diagram.getUniqueSequence());
end1.setAttribute("association", assId);
end1.setAttribute("type", link.getEntity1().getUid());
if (link.getQuantifier1() != null)
end1.setAttribute("name", forXMI(link.getQuantifier1()));
final Element endparticipant1 = document.createElement("UML:AssociationEnd.participant");
if (link.getType().getDecor2() == LinkDecor.COMPOSITION)
end1.setAttribute("aggregation", "composite");
if (link.getType().getDecor2() == LinkDecor.AGREGATION)
end1.setAttribute("aggregation", "aggregate");
// }
end1.appendChild(endparticipant1);
connection.appendChild(end1);
final Element end2 = document.createElement("UML:AssociationEnd");
end2.setAttribute("xmi.id", "end" + diagram.getUniqueSequence());
end2.setAttribute("association", assId);
end2.setAttribute("type", link.getEntity2().getUid());
if (link.getQuantifier2() != null)
end2.setAttribute("name", forXMI(link.getQuantifier2()));
final Element endparticipant2 = document.createElement("UML:AssociationEnd.participant");
if (link.getType().getDecor1() == LinkDecor.COMPOSITION)
end2.setAttribute("aggregation", "composite");
if (link.getType().getDecor1() == LinkDecor.AGREGATION)
end2.setAttribute("aggregation", "aggregate");
// }
end2.appendChild(endparticipant2);
connection.appendChild(end2);
association.appendChild(connection);
ownedElement.appendChild(association);
}
private Element createEntityNode(Entity entity) {
//
final Element cla = document.createElement("UML:State");
cla.setAttribute("xmi.id", entity.getUid());
cla.setAttribute("name", entity.getDisplay().get(0).toString());
cla.setAttribute("namespace", CucaDiagramXmiMaker.getModel(diagram));
final Element feature = document.createElement("UML:Classifier.feature");
cla.appendChild(feature);
// for (Member m : entity.getBodier().getFieldsToDisplay()) {
// //