// $Id: UMLSequenceDiagram.java,v 1.34 2004/09/09 18:07:17 mvw Exp $
// Copyright (c) 1996-2004 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.

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

import java.beans.PropertyVetoException;
import java.util.Hashtable;

import org.argouml.kernel.ProjectManager;
import org.argouml.model.ModelFacade;
import org.argouml.model.uml.UmlFactory;
import org.argouml.model.uml.behavioralelements.collaborations.CollaborationsFactory;
import org.argouml.ui.CmdCreateNode;
import org.argouml.ui.CmdSetMode;
import org.argouml.uml.diagram.sequence.SequenceDiagramGraphModel;
import org.argouml.uml.diagram.ui.RadioAction;
import org.argouml.uml.diagram.ui.UMLDiagram;

/**
 * The diagram for sequence diagrams.

 *
 * Totally rewritten for release 0.16.

 *
 * @author jaap.branderhorst@xs4all.nl Aug 3, 2003
 * @author 5eichler@informatik.uni-hamburg.de originally.
 */
public class UMLSequenceDiagram extends UMLDiagram {

    /**
     * This is the default sequence number for newly created anonymous
     * sequence diagrams.
     */
    private static int sequenceDiagramSerial = 1;

    /**
     * Returns the next available sequence diagram number.
     *
     * @return a number.
     */
    private static int getNextSequenceDiagramNumber() {
	return sequenceDiagramSerial++;
    }


    private Object[] actions;

    /**
     * Constructs a new sequence diagram with a default name and NO namespace.
     * namespaces are used to determine the 'owner' of the diagram for diagrams
     * but that's plain misuse.
     */
    public UMLSequenceDiagram() {
        this(CollaborationsFactory.getFactory().buildCollaboration(
		 ProjectManager.getManager().getCurrentProject().getRoot()));
    }

    /**
     * The constructor.
     * 
     * @param collaboration the collaboration
     */
    public UMLSequenceDiagram(Object collaboration) {
        super();
        try {
            setName(getNewDiagramName());
        } catch (PropertyVetoException pve) {
        }
        // Dirty hack to remove the trash the Diagram constructor leaves
        SequenceDiagramGraphModel gm =
            new SequenceDiagramGraphModel(collaboration);
        SequenceDiagramLayout lay =
            new SequenceDiagramLayout(this.getName(), gm);
        SequenceDiagramRenderer rend = new SequenceDiagramRenderer();
        lay.setGraphEdgeRenderer(rend);
        lay.setGraphNodeRenderer(rend);
        setLayer(lay);
    }

    /**
     * Returns the owner of this diagram. In the case of sequencediagrams it's 
     * allways the root model. 
     *
     * @see org.argouml.uml.diagram.ui.UMLDiagram#getOwner()
     */
    public Object getOwner() {
        // TODO: in the future (when there are multiple models) this
        // should be changeable
        return ProjectManager.getManager().getCurrentProject().getRoot();
    }

    /**
     * Creates a new diagramname.
     *
     * @return a new unique name.
     */
    protected static String getNewDiagramName() {
        String name = null;
        name = "Sequence Diagram " + getNextSequenceDiagramNumber();
        if (!(ProjectManager.getManager().getCurrentProject()
	      .isValidDiagramName(name))) {
            name = getNewDiagramName();
        }
        return name;
    }

    /**
     * Must return an array of actions via which the model can be
     * manipulated. To use the 'nested actions' feature (like the
     * different association types on UMLClassDiagram) these nested
     * actions must be in an array of their own.

     *
     * In case of the sequence diagram this method must return the
     * following actions:

     * 
Action to create an object
     * 
Action to add a procedural link
     * 
Action to add a create link
     * 
Action to add a asynchronous link
     * 
Action to add a synchronous link
     * 
Action to add a return link
     * 
     *
     * @see org.argouml.uml.diagram.ui.UMLDiagram#getUmlActions()
     */
    protected Object[] getUmlActions() {
        if (actions == null) {
            actions = new Object[5];
            actions[0] =
                new CmdCreateNode((Class) ModelFacade.OBJECT, "Object");
	    int offset = 1;

	    Object[][] actionList = {
		{ModelFacade.CALL_ACTION, "CallAction"},
		{ModelFacade.RETURN_ACTION, "ReturnAction"},
		{ModelFacade.CREATE_ACTION, "CreateAction"},
		{ModelFacade.DESTROY_ACTION, "DestroyAction"},
	    };

	    for (int i = 0; i < actionList.length; i++) {
		Hashtable args = new Hashtable();
		args.put("edgeClass", (Class) ModelFacade.LINK);
		args.put("action", actionList[i][0]);
		actions[i + offset] =
		    new RadioAction(new CmdSetMode(ModeCreateLink.class, args,
						   (String) actionList[i][1]));
	    }
        }
        return actions;
    }

    /**
     * @see org.argouml.uml.diagram.ui.UMLDiagram#getNamespace()
     */
    public Object getNamespace() {
        if (getGraphModel() == null
            || !(getGraphModel() instanceof SequenceDiagramGraphModel)) {
            SequenceDiagramGraphModel model =
                new SequenceDiagramGraphModel(
                    CollaborationsFactory.getFactory().buildCollaboration(
                        ProjectManager.getManager().getCurrentProject()
                            .getRoot()));
            SequenceDiagramLayout lay =
                new SequenceDiagramLayout(this.getName(), model);
            SequenceDiagramRenderer rend = new SequenceDiagramRenderer();
            lay.setGraphEdgeRenderer(rend);
            lay.setGraphNodeRenderer(rend);
            setLayer(lay);
        }
        return ((SequenceDiagramGraphModel) getGraphModel()).getCollaboration();
    }

    /**
     * UMLSequencediagram does not have a namespace.

     *
     * This method throws therefore an UnsupportedOperationException.

     *
     * @see org.argouml.uml.diagram.ui.UMLDiagram#setNamespace(Object)
     */
    public void setNamespace(Object ns) throws UnsupportedOperationException {
        if (getGraphModel() == null
            || !(getGraphModel() instanceof SequenceDiagramGraphModel)) {
            SequenceDiagramGraphModel model =
                new SequenceDiagramGraphModel(
                    CollaborationsFactory.getFactory().buildCollaboration(
                        ProjectManager.getManager().getCurrentProject()
			    .getRoot()));
            SequenceDiagramLayout lay =
                new SequenceDiagramLayout(this.getName(), model);
            SequenceDiagramRenderer rend = new SequenceDiagramRenderer();
            lay.setGraphEdgeRenderer(rend);
            lay.setGraphNodeRenderer(rend);
            setLayer(lay);
        }
        ModelFacade.setNamespace(
            ((SequenceDiagramGraphModel) getLayer().getGraphModel())
                .getCollaboration(),
            ns);
    }

    /**
     * Method called by Project.removeDiagram to clean up the mess in
     * this diagram when the diagram is removed.
     */
    public void cleanUp() {
        Object collab =
            ((SequenceDiagramGraphModel) getGraphModel()).getCollaboration();
        UmlFactory.getFactory().delete(collab);
    }

} /* end class UMLSequenceDiagram */