diff options
Diffstat (limited to 'src/net/sourceforge/plantuml/UmlDiagram.java')
| -rw-r--r-- | src/net/sourceforge/plantuml/UmlDiagram.java | 430 |
1 files changed, 430 insertions, 0 deletions
diff --git a/src/net/sourceforge/plantuml/UmlDiagram.java b/src/net/sourceforge/plantuml/UmlDiagram.java new file mode 100644 index 0000000..02b9a0f --- /dev/null +++ b/src/net/sourceforge/plantuml/UmlDiagram.java @@ -0,0 +1,430 @@ +/* ========================================================================
+ * PlantUML : a free UML diagram generator
+ * ========================================================================
+ *
+ * (C) Copyright 2009-2014, Arnaud Roques
+ *
+ * Project Info: http://plantuml.sourceforge.net
+ *
+ * This file is part of PlantUML.
+ *
+ * Licensed under The MIT License (Massachusetts Institute of Technology 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.
+ *
+ *
+ * Original Author: Arnaud Roques
+ */
+package net.sourceforge.plantuml;
+
+import java.awt.Font;
+import java.awt.geom.AffineTransform;
+import java.awt.geom.Dimension2D;
+import java.awt.image.BufferedImage;
+import java.io.BufferedOutputStream;
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
+import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.OutputStream;
+import java.io.PrintWriter;
+import java.util.ArrayList;
+import java.util.List;
+
+import javax.imageio.ImageIO;
+import javax.script.ScriptException;
+
+import net.sourceforge.plantuml.anim.Animation;
+import net.sourceforge.plantuml.anim.AnimationDecoder;
+import net.sourceforge.plantuml.api.ImageDataSimple;
+import net.sourceforge.plantuml.core.Diagram;
+import net.sourceforge.plantuml.core.ImageData;
+import net.sourceforge.plantuml.core.UmlSource;
+import net.sourceforge.plantuml.cucadiagram.Display;
+import net.sourceforge.plantuml.cucadiagram.UnparsableGraphvizException;
+import net.sourceforge.plantuml.flashcode.FlashCodeFactory;
+import net.sourceforge.plantuml.flashcode.FlashCodeUtils;
+import net.sourceforge.plantuml.fun.IconLoader;
+import net.sourceforge.plantuml.graphic.GraphicPosition;
+import net.sourceforge.plantuml.graphic.GraphicStrings;
+import net.sourceforge.plantuml.graphic.HorizontalAlignment;
+import net.sourceforge.plantuml.graphic.HtmlColorUtils;
+import net.sourceforge.plantuml.graphic.QuoteUtils;
+import net.sourceforge.plantuml.graphic.UDrawable;
+import net.sourceforge.plantuml.graphic.VerticalAlignment;
+import net.sourceforge.plantuml.mjpeg.MJPEGGenerator;
+import net.sourceforge.plantuml.pdf.PdfConverter;
+import net.sourceforge.plantuml.svek.EmptySvgException;
+import net.sourceforge.plantuml.svek.GraphvizCrash;
+import net.sourceforge.plantuml.ugraphic.ColorMapperIdentity;
+import net.sourceforge.plantuml.ugraphic.ImageBuilder;
+import net.sourceforge.plantuml.ugraphic.Sprite;
+import net.sourceforge.plantuml.ugraphic.UAntiAliasing;
+import net.sourceforge.plantuml.ugraphic.UFont;
+import net.sourceforge.plantuml.ugraphic.UGraphic;
+import net.sourceforge.plantuml.ugraphic.UImage;
+import net.sourceforge.plantuml.ugraphic.UTranslate;
+import net.sourceforge.plantuml.version.Version;
+
+public abstract class UmlDiagram extends AbstractPSystem implements Diagram {
+
+ private boolean rotation;
+ private boolean hideUnlinkedData;
+
+ private int minwidth = Integer.MAX_VALUE;
+
+ private Display title;
+ private Display header;
+ private Display footer;
+ private Display legend = null;
+ private HorizontalAlignment legendAlignment = HorizontalAlignment.CENTER;
+ private VerticalAlignment legendVerticalAlignment = VerticalAlignment.BOTTOM;
+
+ private HorizontalAlignment headerAlignment = HorizontalAlignment.RIGHT;
+ private HorizontalAlignment footerAlignment = HorizontalAlignment.CENTER;
+ private final Pragma pragma = new Pragma();
+ private Scale scale;
+ private Animation animation;
+
+ private final SkinParam skinParam = new SkinParam();
+
+ final public void setTitle(Display strings) {
+ this.title = strings;
+ }
+
+ final public Display getTitle() {
+ return title;
+ }
+
+ final public int getMinwidth() {
+ return minwidth;
+ }
+
+ final public void setMinwidth(int minwidth) {
+ this.minwidth = minwidth;
+ }
+
+ final public boolean isRotation() {
+ return rotation;
+ }
+
+ final public void setRotation(boolean rotation) {
+ this.rotation = rotation;
+ }
+
+ public final ISkinParam getSkinParam() {
+ return skinParam;
+ }
+
+ public void setParam(String key, String value) {
+ skinParam.setParam(StringUtils.goLowerCase(key), value);
+ }
+
+ public final Display getHeader() {
+ return header;
+ }
+
+ public final void setHeader(Display header) {
+ this.header = header;
+ }
+
+ public final Display getFooter() {
+ return footer;
+ }
+
+ public final void setFooter(Display footer) {
+ this.footer = footer;
+ }
+
+ public final HorizontalAlignment getHeaderAlignment() {
+ return headerAlignment;
+ }
+
+ public final void setHeaderAlignment(HorizontalAlignment headerAlignment) {
+ this.headerAlignment = headerAlignment;
+ }
+
+ public final HorizontalAlignment getFooterAlignment() {
+ return footerAlignment;
+ }
+
+ public final void setFooterAlignment(HorizontalAlignment footerAlignment) {
+ this.footerAlignment = footerAlignment;
+ }
+
+ abstract public UmlDiagramType getUmlDiagramType();
+
+ public Pragma getPragma() {
+ return pragma;
+ }
+
+ final public void setScale(Scale scale) {
+ this.scale = scale;
+ }
+
+ final public Scale getScale() {
+ return scale;
+ }
+
+ final public void setAnimation(List<String> animationData) {
+ try {
+ final AnimationDecoder animationDecoder = new AnimationDecoder(animationData);
+ this.animation = Animation.create(animationDecoder.decode());
+ } catch (ScriptException e) {
+ e.printStackTrace();
+ }
+
+ }
+
+ final public Animation getAnimation() {
+ return animation;
+ }
+
+ public final double getDpiFactor(FileFormatOption fileFormatOption) {
+ if (getSkinParam().getDpi() == 96) {
+ return 1.0;
+ }
+ return getSkinParam().getDpi() / 96.0;
+ }
+
+ public final int getDpi(FileFormatOption fileFormatOption) {
+ return getSkinParam().getDpi();
+ }
+
+ public final boolean isHideUnlinkedData() {
+ return hideUnlinkedData;
+ }
+
+ public final void setHideUnlinkedData(boolean hideUnlinkedData) {
+ this.hideUnlinkedData = hideUnlinkedData;
+ }
+
+ final public ImageData exportDiagram(OutputStream os, int index, FileFormatOption fileFormatOption)
+ throws IOException {
+
+ if (fileFormatOption.getFileFormat() == FileFormat.PDF) {
+ return exportDiagramInternalPdf(os, index);
+ }
+
+ try {
+ final ImageData imageData = exportDiagramInternal(os, index, fileFormatOption);
+ this.lastInfo = new Dimension2DDouble(imageData.getWidth(), imageData.getHeight());
+ return imageData;
+ } catch (UnparsableGraphvizException e) {
+ e.printStackTrace();
+ exportDiagramError(os, e.getCause(), fileFormatOption, e.getGraphvizVersion(), e.getDebugData());
+ } catch (Exception e) {
+ e.printStackTrace();
+ exportDiagramError(os, e, fileFormatOption, null, null);
+ }
+ return new ImageDataSimple();
+
+ }
+
+ private void exportDiagramError(OutputStream os, Throwable exception, FileFormatOption fileFormat,
+ String graphvizVersion, String svg) throws IOException {
+ final UFont font = new UFont("SansSerif", Font.PLAIN, 12);
+ final List<String> strings = getFailureText(exception, graphvizVersion);
+
+ final String flash = getFlashData();
+ for (StackTraceElement ste : exception.getStackTrace()) {
+ strings.add(" " + ste.toString());
+ }
+ if (exception.getCause() != null) {
+ final Throwable cause = exception.getCause();
+ strings.add(" ");
+ strings.add("Caused by " + cause.toString());
+ for (StackTraceElement ste : cause.getStackTrace()) {
+ strings.add(" " + ste.toString());
+ }
+
+ }
+
+ final ImageBuilder imageBuilder = new ImageBuilder(new ColorMapperIdentity(), 1.0, HtmlColorUtils.WHITE,
+ getMetadata(), null, 0, 0, null, getSkinParam().handwritten());
+
+ final FlashCodeUtils utils = FlashCodeFactory.getFlashCodeUtils();
+ final BufferedImage im = utils.exportFlashcode(flash);
+ if (im != null) {
+ GraphvizCrash.addDecodeHint(strings);
+ }
+
+ final GraphicStrings graphicStrings = new GraphicStrings(strings, font, HtmlColorUtils.BLACK,
+ HtmlColorUtils.WHITE, UAntiAliasing.ANTI_ALIASING_ON, IconLoader.getRandom(),
+ GraphicPosition.BACKGROUND_CORNER_TOP_RIGHT);
+
+ if (im == null) {
+ imageBuilder.addUDrawable(graphicStrings);
+ } else {
+ imageBuilder.addUDrawable(new UDrawable() {
+ public void drawU(UGraphic ug) {
+ graphicStrings.drawU(ug);
+ final double height = graphicStrings.calculateDimension(ug.getStringBounder()).getHeight();
+ ug = ug.apply(new UTranslate(0, height));
+ ug.draw(new UImage(im));
+ }
+ });
+ }
+ imageBuilder.writeImageTOBEMOVED(fileFormat.getFileFormat(), os);
+ }
+
+ private String getFlashData() {
+ // for (Map.Entry<Object, Object> ent : System.getProperties().entrySet()) {
+ // System.err.println("p1=" + ent.getKey() + " " + ent.getValue());
+ // }
+ final StringBuilder result = new StringBuilder();
+ final UmlSource source = getSource();
+ result.append(source.getPlainString());
+ return result.toString();
+ }
+
+ private List<String> getFailureText(Throwable exception, String graphvizVersion) {
+ final List<String> strings = new ArrayList<String>();
+ strings.add("An error has occured : " + exception);
+ final String quote = QuoteUtils.getSomeQuote();
+ strings.add("<i>" + quote);
+ strings.add(" ");
+ strings.add("PlantUML (" + Version.versionString() + ") cannot parse result from dot/GraphViz.");
+ if (exception instanceof EmptySvgException) {
+ strings.add("Because dot/GraphViz returns an empty string.");
+ }
+ if (graphvizVersion != null) {
+ strings.add(" ");
+ strings.add("GraphViz version used : " + graphvizVersion);
+ }
+ strings.add(" ");
+ GraphvizCrash.addProperties(strings);
+ strings.add(" ");
+ strings.add("This may be caused by :");
+ strings.add(" - a bug in PlantUML");
+ strings.add(" - a problem in GraphViz");
+ strings.add(" ");
+ strings.add("You should send this diagram and this image to <b>plantuml@gmail.com</b> to solve this issue.");
+ strings.add("You can try to turn arround this issue by simplifing your diagram.");
+ strings.add(" ");
+ strings.add(exception.toString());
+ return strings;
+ }
+
+ private void exportDiagramInternalMjpeg(OutputStream os) throws IOException {
+ final File f = new File("c:/test.avi");
+ final int nb = 150;
+ final double framerate = 30;
+ final MJPEGGenerator m = new MJPEGGenerator(f, 640, 480, framerate, nb);
+
+ for (int i = 0; i < nb; i++) {
+ final AffineTransform at = new AffineTransform();
+ final double coef = (nb - 1 - i) * 1.0 / nb;
+ at.setToShear(coef, coef);
+ final ByteArrayOutputStream baos = new ByteArrayOutputStream();
+ // exportDiagramTOxxBEREMOVED(baos, null, 0, new FileFormatOption(FileFormat.PNG, at));
+ baos.close();
+ final BufferedImage im = ImageIO.read(new ByteArrayInputStream(baos.toByteArray()));
+ m.addImage(im);
+ }
+ m.finishAVI();
+
+ }
+
+ private Dimension2D lastInfo;
+
+ private ImageData exportDiagramInternalPdf(OutputStream os, int index) throws IOException {
+ final File svg = FileUtils.createTempFile("pdf", ".svf");
+ final File pdfFile = FileUtils.createTempFile("pdf", ".pdf");
+ final OutputStream fos = new BufferedOutputStream(new FileOutputStream(svg));
+ final ImageData result = exportDiagram(fos, index, new FileFormatOption(FileFormat.SVG));
+ fos.close();
+ PdfConverter.convert(svg, pdfFile);
+ FileUtils.copyToStream(pdfFile, os);
+ return result;
+ }
+
+ protected abstract ImageData exportDiagramInternal(OutputStream os, int index, FileFormatOption fileFormatOption)
+ throws IOException;
+
+ final protected void exportCmap(File suggestedFile, final ImageData cmapdata) throws FileNotFoundException {
+ final String name = changeName(suggestedFile.getAbsolutePath());
+ final File cmapFile = new File(name);
+ PrintWriter pw = null;
+ try {
+ if (PSystemUtils.canFileBeWritten(cmapFile) == false) {
+ return;
+ }
+ pw = new PrintWriter(cmapFile);
+ pw.print(cmapdata.getCMapData(cmapFile.getName().substring(0, cmapFile.getName().length() - 6)));
+ pw.close();
+ } finally {
+ if (pw != null) {
+ pw.close();
+ }
+ }
+ }
+
+ static String changeName(String name) {
+ return name.replaceAll("(?i)\\.\\w{3}$", ".cmapx");
+ }
+
+ @Override
+ public String getWarningOrError() {
+ if (lastInfo == null) {
+ return null;
+ }
+ final double actualWidth = lastInfo.getWidth();
+ if (actualWidth == 0) {
+ return null;
+ }
+ final String value = getSkinParam().getValue("widthwarning");
+ if (value == null) {
+ return null;
+ }
+ if (value.matches("\\d+") == false) {
+ return null;
+ }
+ final int widthwarning = Integer.parseInt(value);
+ if (actualWidth > widthwarning) {
+ return "The image is " + ((int) actualWidth) + " pixel width. (Warning limit is " + widthwarning + ")";
+ }
+ return null;
+ }
+
+ public void addSprite(String name, Sprite sprite) {
+ skinParam.addSprite(name, sprite);
+ }
+
+ public final Display getLegend() {
+ return legend;
+ }
+
+ public final HorizontalAlignment getLegendAlignment() {
+ return legendAlignment;
+ }
+
+ public final VerticalAlignment getLegendVerticalAlignment() {
+ return legendVerticalAlignment;
+ }
+
+ public final void setLegend(Display legend, HorizontalAlignment horizontalAlignment, VerticalAlignment valignment) {
+ this.legend = legend;
+ this.legendAlignment = horizontalAlignment;
+ this.legendVerticalAlignment = valignment;
+ }
+}
|