net.sourceforge.plantuml.dot.DotData 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.dot;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import net.sourceforge.plantuml.abel.Entity;
import net.sourceforge.plantuml.abel.EntityFactory;
import net.sourceforge.plantuml.abel.EntityPortion;
import net.sourceforge.plantuml.abel.Link;
import net.sourceforge.plantuml.cucadiagram.GroupHierarchy;
import net.sourceforge.plantuml.cucadiagram.PortionShower;
import net.sourceforge.plantuml.skin.Pragma;
import net.sourceforge.plantuml.skin.UmlDiagramType;
import net.sourceforge.plantuml.style.ISkinParam;
import net.sourceforge.plantuml.svek.DotMode;
final public class DotData implements PortionShower {
final private List links;
final private Collection leafs;
final private UmlDiagramType umlDiagramType;
final private ISkinParam skinParam;
// final private Rankdir rankdir;
final private GroupHierarchy groupHierarchy;
final private Entity topParent;
final private PortionShower portionShower;
final private boolean isHideEmptyDescriptionForState;
final private DotMode dotMode;
final private String namespaceSeparator;
final private Pragma pragma;
private final EntityFactory entityFactory;
public EntityFactory getEntityFactory() {
return entityFactory;
}
public DotData(Entity topParent, List links, Collection leafs, UmlDiagramType umlDiagramType,
ISkinParam skinParam, GroupHierarchy groupHierarchy, PortionShower portionShower,
EntityFactory entityFactory, boolean isHideEmptyDescriptionForState, DotMode dotMode,
String namespaceSeparator, Pragma pragma) {
this.namespaceSeparator = namespaceSeparator;
this.pragma = pragma;
this.topParent = Objects.requireNonNull(topParent);
this.dotMode = dotMode;
this.isHideEmptyDescriptionForState = isHideEmptyDescriptionForState;
this.links = links;
this.leafs = leafs;
this.umlDiagramType = umlDiagramType;
this.skinParam = skinParam;
// this.rankdir = rankdir;
this.groupHierarchy = groupHierarchy;
this.portionShower = portionShower;
this.entityFactory = entityFactory;
}
public DotData(Entity topParent, List links, Collection leafs, UmlDiagramType umlDiagramType,
ISkinParam skinParam, GroupHierarchy groupHierarchy, EntityFactory entityFactory,
boolean isHideEmptyDescriptionForState, DotMode dotMode, String namespaceSeparator, Pragma pragma) {
this(topParent, links, leafs, umlDiagramType, skinParam, groupHierarchy, new PortionShower() {
public boolean showPortion(EntityPortion portion, Entity entity) {
return true;
}
public List getVisibleStereotypeLabels(Entity entity) {
return Collections.emptyList();
}
}, entityFactory, isHideEmptyDescriptionForState, dotMode, namespaceSeparator, pragma);
}
public UmlDiagramType getUmlDiagramType() {
return umlDiagramType;
}
public ISkinParam getSkinParam() {
return skinParam;
}
public GroupHierarchy getGroupHierarchy() {
return groupHierarchy;
}
public List getLinks() {
return links;
}
public Collection getLeafs() {
return leafs;
}
public final Entity getTopParent() {
return topParent;
}
public boolean isEmpty(Entity g) {
return groupHierarchy.isEmpty(g);
}
public boolean showPortion(EntityPortion portion, Entity entity) {
return portionShower.showPortion(portion, entity);
}
public List getVisibleStereotypeLabels(Entity entity) {
return portionShower.getVisibleStereotypeLabels(entity);
}
public Entity getRootGroup() {
return entityFactory.getRootGroup();
}
public boolean isDegeneratedWithFewEntities(int nb) {
return entityFactory.groups().size() == 0 && getLinks().size() == 0 && getLeafs().size() == nb;
}
public final boolean isHideEmptyDescriptionForState() {
return isHideEmptyDescriptionForState;
}
public final DotMode getDotMode() {
return dotMode;
}
public final String getNamespaceSeparator() {
return namespaceSeparator;
}
public Pragma getPragma() {
return pragma;
}
public void removeIrrelevantSametail() {
final Map sametails = new HashMap();
for (Link link : links) {
if (link.getType().getDecor2().isExtendsLike()) {
link.setSametail(link.getEntity1().getUid());
}
final String sametail = link.getSametail();
if (sametail == null) {
continue;
}
final Integer value = sametails.get(sametail);
sametails.put(sametail, value == null ? 1 : value + 1);
}
final Collection toremove = new HashSet<>();
final int limit = skinParam.groupInheritance();
for (Map.Entry ent : sametails.entrySet()) {
final String key = ent.getKey();
if (ent.getValue() < limit) {
toremove.add(key);
} else {
final List some = new ArrayList<>();
for (Link link : links) {
if (key.equals(link.getSametail())) {
some.add(link);
}
}
final Entity leaf = getLeaf(key);
final Neighborhood neighborhood = new Neighborhood(leaf, some, getLinksOfThisLeaf(leaf));
leaf.setNeighborhood(neighborhood);
}
}
for (Link link : links) {
final String sametail = link.getSametail();
if (sametail == null) {
continue;
}
if (toremove.contains(sametail)) {
link.setSametail(null);
}
}
}
private List getLinksOfThisLeaf(Entity leaf) {
final List result = new ArrayList<>();
for (Link link : links) {
if (link.contains(leaf)) {
result.add(link);
}
}
return result;
}
private Entity getLeaf(String key) {
for (Entity entity : leafs) {
if (entity.getUid().equals(key)) {
return entity;
}
}
return null;
}
}