// $Id: CollabDiagramRenderer.java,v 1.14 2004/08/11 16:37:33 mvw Exp $
// Copyright (c) 1996-99 The Regents of the University of California. All
// Rights Reserved. Permission to use, copy, modify, and distribute this
// software and its documentation without fee, and without a written
// agreement is hereby granted, provided that the above copyright notice
// and this paragraph appear in all copies.  This software program and
// documentation are copyrighted by The Regents of the University of
// California. The software program and documentation are supplied "AS
// IS", without any accompanying services from The Regents. The Regents
// does not warrant that the operation of the program will be
// uninterrupted or error-free. The end-user understands that the program
// was developed for research purposes and is advised not to rely
// exclusively on the program for any reason.  IN NO EVENT SHALL THE
// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

// File: CollabDiagramRenderer.java
// Classes: CollabDiagramRenderer
// Original Author: agauthie@ics.uci.edu
// $Id: CollabDiagramRenderer.java,v 1.14 2004/08/11 16:37:33 mvw Exp $

package org.argouml.uml.diagram.collaboration.ui;

import org.apache.log4j.Logger;

import org.argouml.model.ModelFacade;
import org.argouml.uml.diagram.static_structure.ui.CommentEdge;
import org.argouml.uml.diagram.static_structure.ui.FigComment;
import org.argouml.uml.diagram.static_structure.ui.FigEdgeNote;
import org.argouml.uml.diagram.ui.FigDependency;
import org.argouml.uml.diagram.ui.FigGeneralization;
import org.argouml.uml.diagram.ui.FigMessage;

import org.tigris.gef.base.Layer;
import org.tigris.gef.graph.GraphEdgeRenderer;
import org.tigris.gef.graph.GraphModel;
import org.tigris.gef.graph.GraphNodeRenderer;
import org.tigris.gef.presentation.FigEdge;
import org.tigris.gef.presentation.FigNode;

/**
 * 
This class defines a renderer object for UML Collaboration Diagrams. 
 *   In a collaboration Diagram the following UML objects are displayed with the
 *   following Figs:
 *
 * 
 *   UML Object       ---  Fig
 *   ---------------------------------------
 *   MClassifierRole  ---  FigClassifierRole
 *   MMessage         ---  FigMessage
 *   MComment         ---  FigComment
 * 
 *
 * 
Provides {@link #getFigNodeFor} to implement the {@link
 *   GraphNodeRenderer} interface and {@link #getFigEdgeFor} to implement the
 *   {@link GraphEdgeRenderer} interface.
 *
 * 
Note. Should be implemented as a singleton - we don't really
 *   need a separate instance for each use case diagram.
 *
 */
public class CollabDiagramRenderer
    implements GraphNodeRenderer, GraphEdgeRenderer 
{
    private static final Logger LOG =
	Logger.getLogger(CollabDiagramRenderer.class);

    /** Return a Fig that can be used to represent the given node 
     * 
     * @see org.tigris.gef.graph.GraphNodeRenderer#getFigNodeFor(
     * org.tigris.gef.graph.GraphModel, org.tigris.gef.base.Layer, 
     * java.lang.Object)
     */
    public FigNode getFigNodeFor(GraphModel gm, Layer lay, Object node) {
	if (ModelFacade.isAClassifierRole(node))
	    return new FigClassifierRole(gm, lay, node);
	if (ModelFacade.isAMessage(node))
	    return new FigMessage(gm, lay, node);
	if (ModelFacade.isAComment(node)) {
            return new FigComment(gm, node);
        }
	LOG.debug("TODO: CollabDiagramRenderer getFigNodeFor");
	return null;
    }

    /** Return a Fig that can be used to represent the given edge,
     * Generally the same code as for the ClassDiagram, since its
     * very related to it.
     *
     * @see org.tigris.gef.graph.GraphEdgeRenderer#getFigEdgeFor(
     * org.tigris.gef.graph.GraphModel, 
     * org.tigris.gef.base.Layer, java.lang.Object)
     */
    public FigEdge getFigEdgeFor(GraphModel gm, Layer lay, Object edge) {
	if (ModelFacade.isAAssociationRole(edge)) {
	    FigAssociationRole asrFig = new FigAssociationRole(edge, lay);
	    return asrFig;
	} else 
	    if (ModelFacade.isAGeneralization(edge)) {
		FigGeneralization genFig = new FigGeneralization(edge, lay);
		return genFig;
	    }
	if (ModelFacade.isADependency(edge)) {
	    FigDependency depFig = new FigDependency(edge , lay);
	    return depFig;
	}
	if (edge instanceof CommentEdge) {
            return new FigEdgeNote(edge, lay);
        }

	LOG.debug("TODO: CollabDiagramRenderer getFigEdgeFor");
	return null;
    }

} /* end class CollabDiagramRenderer */