net.sourceforge.plantuml.xmlsc.ScxmlStateDiagramStandard Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-mit Show documentation
Show all versions of plantuml-mit Show documentation
PlantUML is a component that allows to quickly write diagrams from text.
// 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 MIT License.
*
* See http://opensource.org/licenses/MIT
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
* IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
* 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 MIT license.
*
* The generated images can then be used without any reference to the MIT 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.xmlsc;
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.Comment;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import net.sourceforge.plantuml.abel.Entity;
import net.sourceforge.plantuml.abel.LeafType;
import net.sourceforge.plantuml.abel.Link;
import net.sourceforge.plantuml.klimt.creole.Display;
import net.sourceforge.plantuml.statediagram.StateDiagram;
import net.sourceforge.plantuml.stereo.Stereotype;
import net.sourceforge.plantuml.text.Guillemet;
import net.sourceforge.plantuml.xml.XmlFactories;
public class ScxmlStateDiagramStandard {
// ::remove folder when __CORE__
private final StateDiagram diagram;
private final Document document;
public ScxmlStateDiagramStandard(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 scxml = document.createElement("scxml");
scxml.setAttribute("xmlns", "http://www.w3.org/2005/07/scxml");
scxml.setAttribute("version", "1.0");
final String initial = getInitial();
if (initial != null)
scxml.setAttribute("initial", initial);
document.appendChild(scxml);
for (final Entity ent : diagram.getEntityFactory().leafs())
if (ent.getParentContainer().isRoot())
scxml.appendChild(createState(ent));
for (Entity ent : diagram.getEntityFactory().groups())
if (ent.getParentContainer().isRoot())
exportGroup(scxml, ent);
}
private Element exportGroup(Element dest, Entity ent) {
final Element gr = createGroup(ent);
dest.appendChild(gr);
for (Entity leaf : ent.leafs())
gr.appendChild(createState(leaf));
for (Entity child : ent.groups())
exportGroup(gr, child);
return gr;
}
private String getInitial() {
for (final Entity ent : diagram.getEntityFactory().leafs())
if (ent.getLeafType() == LeafType.CIRCLE_START)
return getId(ent);
return null;
}
private Element createGroup(Entity entity) {
return createState(entity);
}
private Element createState(Entity entity) {
final LeafType type = entity.getLeafType();
final Element state = document.createElement("state");
if (type == LeafType.NOTE) {
state.setAttribute("stereotype", "note");
state.setAttribute("id", entity.getName());
final Display display = entity.getDisplay();
final StringBuilder sb = new StringBuilder();
for (CharSequence s : display) {
sb.append(s);
sb.append("\n");
}
if (sb.length() > 0)
sb.setLength(sb.length() - 1);
final Comment comment = document.createComment(sb.toString());
state.appendChild(comment);
} else {
state.setAttribute("id", getId(entity));
final Stereotype stereotype = entity.getStereotype();
if (stereotype != null)
state.setAttribute("stereotype", stereotype.getLabels(Guillemet.NONE).get(0));
for (final Link link : diagram.getLinks())
if (link.getEntity1() == entity)
addLink(state, link);
}
return state;
}
private void addLink(Element state, Link link) {
final Element transition = document.createElement("transition");
final Display label = link.getLabel();
if (Display.isNull(label) == false) {
final String event = label.get(0).toString();
transition.setAttribute("event", event);
}
transition.setAttribute("target", getId(link.getEntity2()));
state.appendChild(transition);
}
private String getId(Entity entity) {
return entity.getName().replaceAll("\\*", "");
}
public void transformerXml(OutputStream os) throws TransformerException, ParserConfigurationException {
final Source source = new DOMSource(document);
final Result resultat = new StreamResult(os);
final Transformer transformer = XmlFactories.newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
transformer.setOutputProperty(OutputKeys.ENCODING, UTF_8.name());
transformer.transform(source, resultat);
}
}