1
0
mirror of https://github.com/octoleo/plantuml.git synced 2024-11-21 20:45:10 +00:00

Add XMI_SCRIPT support to DescriptionDiagrams

This commit is contained in:
Daum Alexander (DCL ATV SC D RAD CSFW FW) 2024-02-28 13:20:08 +01:00
parent 124aa0384c
commit 3216eea2d9
6 changed files with 332 additions and 80 deletions

View File

@ -71,7 +71,7 @@ public final class CucaDiagramXmiMaker {
if (diagram instanceof StateDiagram)
xmi = new XmiStateDiagram((StateDiagram) diagram);
else if (diagram instanceof DescriptionDiagram)
xmi = new XmiDescriptionDiagramScript((DescriptionDiagram) diagram);
xmi = createDescriptionDiagram();
else if (diagram instanceof ClassDiagram)
xmi = createClassDiagram();
else
@ -103,4 +103,14 @@ public final class CucaDiagramXmiMaker {
throw new UnsupportedOperationException();
}
private XmlDiagramTransformer createDescriptionDiagram() throws ParserConfigurationException {
if (fileFormat == FileFormat.XMI_SCRIPT) {
return new XmiDescriptionDiagramScript((DescriptionDiagram) diagram);
} else {
// dont care about which file format is specified, to keep backwards
// compatibility
return new XmiDescriptionDiagramStandard((DescriptionDiagram) diagram);
}
}
}

View File

@ -59,13 +59,13 @@ import net.sourceforge.plantuml.descdiagram.DescriptionDiagram;
import net.sourceforge.plantuml.klimt.creole.Display;
import net.sourceforge.plantuml.xml.XmlFactories;
public class XmiDescriptionDiagram implements XmlDiagramTransformer {
public abstract class XmiDescriptionDiagramAbstract implements XmlDiagramTransformer {
private final DescriptionDiagram diagram;
private final Document document;
private final Element ownedElement;
protected final DescriptionDiagram diagram;
protected final Document document;
protected final Element ownedElement;
public XmiDescriptionDiagram(DescriptionDiagram diagram) throws ParserConfigurationException {
public XmiDescriptionDiagramAbstract(DescriptionDiagram diagram) throws ParserConfigurationException {
this.diagram = diagram;
final DocumentBuilder builder = XmlFactories.newDocumentBuilder();
@ -110,7 +110,7 @@ public class XmiDescriptionDiagram implements XmlDiagramTransformer {
}
private void addElement(final Entity tobeAdded, Element container) {
protected void addElement(final Entity tobeAdded, Element container) {
final Element element = createEntityNode(tobeAdded);
container.appendChild(element);
for (final Entity ent : diagram.getEntityFactory().groups())
@ -123,66 +123,9 @@ public class XmiDescriptionDiagram implements XmlDiagramTransformer {
}
public static String forXMI(String s) {
return s.replace(':', ' ');
}
protected abstract void addLink(Link link);
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) {
protected Element createEntityNode(Entity entity) {
final Element cla = document.createElement("UML:Component");
cla.setAttribute("xmi.id", entity.getUid());
@ -192,19 +135,6 @@ public class XmiDescriptionDiagram implements XmlDiagramTransformer {
final Element feature = document.createElement("UML:Classifier.feature");
cla.appendChild(feature);
// for (Member m : entity.getBodier().getFieldsToDisplay()) {
// final Element attribute = document.createElement("UML:Attribute");
// attribute.setAttribute("xmi.id", "att" + UniqueSequence.getValue());
// attribute.setAttribute("name", m.getDisplay(false));
// feature.appendChild(attribute);
// }
//
// for (Member m : entity.getBodier().getMethodsToDisplay()) {
// final Element operation = document.createElement("UML:Operation");
// operation.setAttribute("xmi.id", "att" + UniqueSequence.getValue());
// operation.setAttribute("name", m.getDisplay(false));
// feature.appendChild(operation);
// }
return cla;
}
@ -220,4 +150,11 @@ public class XmiDescriptionDiagram implements XmlDiagramTransformer {
transformer.transform(source, resultat);
}
public static String forXMI(String s) {
return s.replace(':', ' ');
}
public static String forXMI(Display s) {
return s.get(0).toString().replace(':', ' ');
}
}

View File

@ -0,0 +1,159 @@
/* ========================================================================
* 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/paypal
*
* This file is part of PlantUML.
*
* PlantUML is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* PlantUML distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
* License for more details.
*
* You should have received a copy of the GNU General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
* USA.
*
*
* Original Author: Arnaud Roques
*
*
*/
package net.sourceforge.plantuml.xmi;
import javax.xml.parsers.ParserConfigurationException;
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.descdiagram.DescriptionDiagram;
import net.sourceforge.plantuml.klimt.creole.Display;
public class XmiDescriptionDiagramScript extends XmiDescriptionDiagramAbstract {
public XmiDescriptionDiagramScript(DescriptionDiagram diagram) throws ParserConfigurationException {
super(diagram);
}
@Override
protected void addLink(Link link) {
if (link.isHidden() || link.isInvis())
return;
if (!link.getType().getStyle().isNormal()) {
// this is some kind of dashed line, which means it is a dependency
Element dependency = createDependency(link);
ownedElement.appendChild(dependency);
return;
}
final String assId = "ass" + diagram.getUniqueSequence();
UMLAggregationKind aggregation = UMLAggregationKind.None;
if (link.getType().getDecor1() == LinkDecor.COMPOSITION) {
aggregation = UMLAggregationKind.Composite;
}
if (link.getType().getDecor2() == LinkDecor.COMPOSITION) {
aggregation = UMLAggregationKind.Composite;
}
if (link.getType().getDecor1() == LinkDecor.AGREGATION) {
aggregation = UMLAggregationKind.Aggregation;
}
if (link.getType().getDecor2() == LinkDecor.AGREGATION) {
aggregation = UMLAggregationKind.Aggregation;
}
final Element association = document.createElement("UML:Association");
association.setAttribute("xmi.id", assId);
// association.setAttribute("namespace",
// CucaDiagramXmiMaker.getModel(classDiagram));
if (Display.isNull(link.getLabel()) == false)
association.setAttribute("name", forXMI(link.getLabel()));
final Element connection = document.createElement("UML:Association.connection");
final Element end1 = createAssociationEnd(assId, link.getType().getDecor2(), link.getQuantifier1(),
link.getEntity1(), aggregation);
connection.appendChild(end1);
final Element end2 = createAssociationEnd(assId, link.getType().getDecor1(), link.getQuantifier2(),
link.getEntity2(), aggregation);
connection.appendChild(end2);
association.appendChild(connection);
ownedElement.appendChild(association);
}
private Element createAssociationEnd(final String assId, final LinkDecor decor, final String quantifier,
Entity entity, UMLAggregationKind aggregation) {
final Element end = document.createElement("UML:AssociationEnd");
end.setAttribute("xmi.id", "end" + diagram.getUniqueSequence());
end.setAttribute("association", assId);
// end1.setAttribute("type", link.getEntity1().getUid());
if (quantifier != null)
end.setAttribute("name", forXMI(quantifier));
// TODO this is the multiplicity, handle that correctly
end.setAttribute("participant", entity.getUid());
if (aggregation != UMLAggregationKind.None)
end.setAttribute("aggregation", aggregation.name);
boolean navigable = decor != LinkDecor.NOT_NAVIGABLE && decor != LinkDecor.NONE;
end.setAttribute("isNavigable", Boolean.toString(navigable));
return end;
}
private Element createDependency(Link link) {
// determine kind and direction
if (link.isInverted()) {
return createDependencyClientSupplier(link.getEntity2(), link.getEntity1());
} else {
return createDependencyClientSupplier(link.getEntity1(), link.getEntity2());
}
}
private Element createRef(Entity entity) {
Element ref = document.createElement("UML:Component");
ref.setAttribute("xmi.idref", entity.getUid());
return ref;
}
private Element createDependencyClientSupplier(Entity clientEntity, Entity supplierEntity) {
String depID = diagram.getUniqueSequence("dep");
Element dependency = document.createElement("UML:Dependency");
dependency.setAttribute("xmi.id", depID);
Element client = document.createElement("UML:Dependency.client");
Element supplier = document.createElement("UML:Dependency.supplier");
Element clientRef = createRef(clientEntity);
if (clientRef != null)
client.appendChild(clientRef);
Element supplierRef = createRef(supplierEntity);
if (supplierRef != null)
supplier.appendChild(supplierRef);
dependency.appendChild(client);
dependency.appendChild(supplier);
return dependency;
}
}

View File

@ -0,0 +1,106 @@
/* ========================================================================
* 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/paypal
*
* This file is part of PlantUML.
*
* PlantUML is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* PlantUML distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
* License for more details.
*
* You should have received a copy of the GNU General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
* USA.
*
*
* Original Author: Arnaud Roques
*
*
*/
package net.sourceforge.plantuml.xmi;
import javax.xml.parsers.ParserConfigurationException;
import org.w3c.dom.Element;
import net.sourceforge.plantuml.abel.Link;
import net.sourceforge.plantuml.decoration.LinkDecor;
import net.sourceforge.plantuml.descdiagram.DescriptionDiagram;
import net.sourceforge.plantuml.klimt.creole.Display;
public class XmiDescriptionDiagramStandard extends XmiDescriptionDiagramAbstract {
public XmiDescriptionDiagramStandard(DescriptionDiagram diagram) throws ParserConfigurationException {
super(diagram);
}
@Override
protected 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);
}
}

View File

@ -113,6 +113,46 @@ Expected result MUST be put between triple brackets
</XMI>
}}}argo
{{{script
<?xml version="1.0" encoding="UTF-8"?><XMI xmlns:UML="href://org.omg/UML/1.3" xmi.version="1.1">
<XMI.header>
<XMI.metamodel xmi.name="UML" xmi.version="1.3"/>
</XMI.header>
<XMI.content>
<UML:Model name="PlantUML" xmi.id="model1">
<UML:Namespace.ownedElement>
<UML:Component name="test" namespace="model1" xmi.id="cl0002">
<UML:Classifier.feature/>
</UML:Component>
<UML:Component name="first line1" namespace="model1" xmi.id="cl0004">
<UML:Classifier.feature/>
</UML:Component>
<UML:Component name="first line3" namespace="model1" xmi.id="cl0007">
<UML:Classifier.feature/>
</UML:Component>
<UML:Dependency xmi.id="dep9">
<UML:Dependency.client>
<UML:Component xmi.idref="cl0004"/>
</UML:Dependency.client>
<UML:Dependency.supplier>
<UML:Component xmi.idref="cl0002"/>
</UML:Dependency.supplier>
</UML:Dependency>
<UML:Dependency xmi.id="dep10">
<UML:Dependency.client>
<UML:Component xmi.idref="cl0002"/>
</UML:Dependency.client>
<UML:Dependency.supplier>
<UML:Component xmi.idref="cl0007"/>
</UML:Dependency.supplier>
</UML:Dependency>
</UML:Namespace.ownedElement>
</UML:Model>
</XMI.content>
</XMI>
}}}script
*/
public class XMI0001_Test extends XmiTest {