org.umlgraph.doclet.Shape Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of umlgraph Show documentation
Declarative Drawing of UML Diagrams
There is a newer version: 5.6.6
/*
 * Manage the GraphViz interface for node shapes
 *
 * (C) Copyright 2007 Diomidis Spinellis
 *
 * Permission to use, copy, and distribute this software and its
 * documentation for any purpose and without fee is hereby granted,
 * provided that the above copyright notice appear in all copies and that
 * both that copyright notice and this permission notice appear in
 * supporting documentation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
 * MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 *
 * $Id$
 *
 */

package org.umlgraph.doclet;

import java.io.IOException;
import java.io.PrintWriter;
import java.util.ArrayList;
import java.util.List;

import com.sun.javadoc.ClassDoc;
import com.sun.javadoc.Doc;
import com.sun.javadoc.LanguageVersion;
import com.sun.javadoc.RootDoc;

/**
 * Properties of node shapes
 *
 * @version $Revision$
 * @author Diomidis Spinellis
 */
public class Shape {

    /** Shape's UMLGraph name */
    private String name;

    /** Construct a default (class) Shape */
    public Shape() {
	name = "class";
    }

    /** Construct a Shape through the specified UMLGraph name */
    public Shape(String n) {
	name = n;
	if (graphvizAttribute() == null) {
	    System.err.println("Ignoring invalid shape " + n);
	    name = "class";
	}
    }

    /**
     * Return the GraphViz shape name corresponding to the shape
     */
    public String graphvizAttribute() {
	if (name.equals("class"))
	    return "";		// Default; plaintext
	else if (name.equals("note"))
	    return ", shape=note";
	else if (name.equals("node"))
	    return ", shape=box3d";
	else if (name.equals("component"))
	    return ", shape=component";
	else if (name.equals("package"))
	    return ", shape=tab";
	else if (name.equals("collaboration"))
	    return ", shape=ellipse, style=dashed";
	else if (name.equals("usecase"))
	    return ", shape=ellipse";
	else if (name.equals("activeclass"))
	    return "";		// Default; plaintext
	else
	    return null;
    }

    /** Return the shape's GraphViz landing port */
    String landingPort() {
	if (name.equals("class") || name.equals("activeclass"))
	    return ":p";
	else
	    return "";
    }

    /** Return the table border required for the shape */
    String extraColumn(int nRows) {
	return name.equals("activeclass") ? ("") : "";
    }

    /** Return the cell border required for the shape */
    String cellBorder() {
	return (name.equals("class") || name.equals("activeclass")) ? "1" : "0";
    }
}