net.sourceforge.plantuml.html.CucaDiagramHtmlMaker Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of plantuml Show documentation
PlantUML is a component that allows to quickly write : * sequence diagram, * use case diagram, * class diagram, * activity diagram, * component diagram, * state diagram * object diagram
There is a newer version: 8059
Show newest version
/* ========================================================================
 * PlantUML : a free UML diagram generator
 * ========================================================================
 *
 * (C) Copyright 2009-2013, Arnaud Roques
 *
 * Project Info:  http://plantuml.sourceforge.net
 * 
 * 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.
 *
 * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
 * in the United States and other countries.]
 *
 * Original Author:  Arnaud Roques
 * 
 * Revision $Revision: 5079 $
 *
 */
package net.sourceforge.plantuml.html;

import java.io.File;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;

import net.sourceforge.plantuml.StringUtils;
import net.sourceforge.plantuml.cucadiagram.Code;
import net.sourceforge.plantuml.cucadiagram.CucaDiagram;
import net.sourceforge.plantuml.cucadiagram.IEntity;
import net.sourceforge.plantuml.cucadiagram.LeafType;
import net.sourceforge.plantuml.cucadiagram.Link;
import net.sourceforge.plantuml.cucadiagram.Member;
import net.sourceforge.plantuml.cucadiagram.Stereotype;

public final class CucaDiagramHtmlMaker {

	private final CucaDiagram diagram;
	private final File dir;

	public CucaDiagramHtmlMaker(CucaDiagram diagram, File dir) {
		this.diagram = diagram;
		this.dir = dir;
	}

	public List create() throws IOException {
		dir.mkdirs();
		if (dir.exists() == false) {
			throw new IOException("Cannot create " + dir);
		}
		final File f = new File(dir, "index.html");
		final PrintWriter pw = new PrintWriter(f);
		pw.println("");
		printAllType(pw, LeafType.ENUM);
		printAllType(pw, LeafType.INTERFACE);
		printAllType(pw, LeafType.ANNOTATION);
		printAllType(pw, LeafType.ABSTRACT_CLASS);
		printAllType(pw, LeafType.CLASS);
		htmlClose(pw);
		return Arrays.asList(dir);
	}

	private void printAllType(final PrintWriter pw, LeafType type) throws IOException {
		if (hasSome(type)) {
			pw.println("" + type.toHtml() + "");
			for (Map.Entry ent : new TreeMap(diagram.getLeafs()).entrySet()) {
				if (ent.getValue().getEntityType() != type) {
					continue;
				}
				export(ent.getValue());
				pw.println("");
				pw.println(LinkHtmlPrinter.htmlLink(ent.getValue()));
				pw.println("");
			}
		}
	}

	private boolean hasSome(final LeafType type) {
		for (IEntity ent : diagram.getLeafs().values()) {
			if (ent.getEntityType() == type) {
				return true;
			}
		}
		return false;
	}

	private void export(IEntity entity) throws IOException {
		final File f = new File(dir, LinkHtmlPrinter.urlOf(entity));
		final PrintWriter pw = new PrintWriter(f);
		pw.println("");
		pw.println("" + StringUtils.unicodeForHtml(entity.getCode().getCode()) + "");
		pw.println("" + entity.getEntityType().toHtml() + "");
		for (CharSequence s : entity.getDisplay()) {
			pw.println(StringUtils.unicodeForHtml(s.toString()));
			pw.println("
");
		}
		final Stereotype stereotype = entity.getStereotype();
		if (stereotype != null) {
			pw.println("");
			pw.println("Stereotype");
			for (String s : stereotype.getLabels()) {
				pw.println(s);
				pw.println("
");
			}
		}

		pw.println("");
		if (entity.getFieldsToDisplay().size() == 0) {
			pw.println("No fields");
		} else {
			pw.println("Fields:");
			pw.println("");
			for (Member m : entity.getFieldsToDisplay()) {
				pw.println("");
				pw.println(StringUtils.unicodeForHtml(m.getDisplay(true)));
				pw.println("");
			}
			pw.println("");
		}

		pw.println("");
		if (entity.getMethodsToDisplay().size() == 0) {
			pw.println("No methods");
		} else {
			pw.println("Methods:");
			pw.println("");
			for (Member m : entity.getMethodsToDisplay()) {
				pw.println("");
				pw.println(StringUtils.unicodeForHtml(m.getDisplay(true)));
				pw.println("");
			}
			pw.println("");
		}

		pw.println("");
		final Collection links = getLinksButNotes(entity);
		if (links.size() == 0) {
			pw.println("No links");
		} else {
			pw.println("Links:");
			pw.println("");
			for (Link l : links) {
				pw.println("");
				new LinkHtmlPrinter(l, entity).printLink(pw);
				pw.println("");
			}
			pw.println("");
		}

		final Collection notes = getNotes(entity);
		if (notes.size() > 0) {
			pw.println("");
			pw.println("Notes:");
			pw.println("");
			for (IEntity note : notes) {
				pw.println("");
				for (CharSequence s : note.getDisplay()) {
					pw.println(StringUtils.unicodeForHtml(s.toString()));
					pw.println("
");
				}
				pw.println("");
			}
			pw.println("");

		}

		htmlClose(pw);
	}

	private void htmlClose(final PrintWriter pw) {
		pw.println("");
		pw.println("Back to index");
		pw.println("");
		pw.close();
	}

	private Collection getNotes(IEntity ent) {
		final List result = new ArrayList();
		for (Link link : diagram.getLinks()) {
			if (link.contains(ent) == false) {
				continue;
			}
			if (link.getEntity1().getEntityType() == LeafType.NOTE || link.getEntity2().getEntityType() == LeafType.NOTE) {
				result.add(link.getOther(ent));
			}
		}
		return Collections.unmodifiableList(result);
	}

	private Collection getLinksButNotes(IEntity ent) {
		final List result = new ArrayList();
		for (Link link : diagram.getLinks()) {
			if (link.contains(ent) == false) {
				continue;
			}
			if (link.getEntity1().getEntityType() == LeafType.NOTE || link.getEntity2().getEntityType() == LeafType.NOTE) {
				continue;
			}
			result.add(link);
		}
		return Collections.unmodifiableList(result);
	}
}