// $Id: UMLClassifierRoleAvailableContentsListModel.java,v 1.17 2004/09/14 17:35:12 mvw Exp $
// Copyright (c) 2002-2003 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.ui.behavior.collaborations;

import java.util.Collection;
import java.util.Iterator;

import org.argouml.model.ModelFacade;
import org.argouml.model.uml.UmlModelEventPump;
import org.argouml.model.uml.behavioralelements.collaborations.CollaborationsHelper;
import org.argouml.uml.ui.UMLModelElementListModel2;
import org.tigris.gef.presentation.Fig;

import ru.novosoft.uml.MElementEvent;
/**
 * Binary relation list model for available con between classifierroles
 * 
 * @author jaap.branderhorst@xs4all.nl
 */
public class UMLClassifierRoleAvailableContentsListModel
    extends UMLModelElementListModel2 {

    /**
     * Constructor for UMLClassifierRoleAvailableContentsListModel.
     */
    public UMLClassifierRoleAvailableContentsListModel() {
        super();
    }

    /**
     * @see org.argouml.uml.ui.UMLModelElementListModel2#buildModelList()
     */
    protected void buildModelList() {
        setAllElements(
            CollaborationsHelper.getHelper().allAvailableContents(
	       /*(MClassifierRole)*/ getTarget()));
    }

    /**
     * @see
     * ru.novosoft.uml.MElementListener#roleAdded(ru.novosoft.uml.MElementEvent)
     */
    public void roleAdded(MElementEvent e) {
        if (e.getName().equals("base") && e.getSource() == getTarget()) {
            Object clazz = /*(MClassifier)*/ getChangedElement(e);
            addAll(ModelFacade.getOwnedElements(clazz));
            // UmlModelEventPump.getPump().removeModelEventListener(this,
            // clazz, "ownedElement");
            UmlModelEventPump.getPump().addModelEventListener(
							      this,
							      clazz,
							      "ownedElement");
        } else if (
                e.getName().equals("ownedElement")
                && ModelFacade.getBases(getTarget()).contains(
                        e.getSource())) {
            addElement(getChangedElement(e));
        }
    }

    /**
     * @see
     * org.argouml.uml.ui.UMLModelElementListModel2#setTarget(java.lang.Object)
     */
    public void setTarget(Object theNewTarget) {
        theNewTarget = theNewTarget instanceof Fig 
            ? ((Fig) theNewTarget).getOwner() : theNewTarget;
        if (ModelFacade.isABase(theNewTarget) 
                || ModelFacade.isADiagram(theNewTarget)) {
            if (getTarget() != null) {
                Collection bases = ModelFacade.getBases(getTarget());
                Iterator it = bases.iterator();
                while (it.hasNext()) {
                    Object base = /*(MBase)*/ it.next();
                    UmlModelEventPump.getPump().removeModelEventListener(
                            this,
                            base,
                        "ownedElement");
                }
                UmlModelEventPump.getPump().removeModelEventListener(
                        this,
                        /*(MBase)*/ getTarget(),
                    "base");
            }
            setListTarget(theNewTarget);
            if (getTarget() != null) {
                Collection bases = ModelFacade.getBases(getTarget());
                Iterator it = bases.iterator();
                while (it.hasNext()) {
                    Object base = /*(MBase)*/ it.next();
                    UmlModelEventPump.getPump().addModelEventListener(
                            this,
                            base,
                        "ownedElement");
                }
                // make sure we know it when a classifier is added as a base
                UmlModelEventPump.getPump().addModelEventListener(
                        this,
                        /*(MBase)*/ getTarget(),
                    "base");
            }
            if (getTarget() != null) {
                removeAllElements();
                setBuildingModel(true);
                buildModelList();
                setBuildingModel(false);
                if (getSize() > 0) {
                    fireIntervalAdded(this, 0, getSize() - 1);
                }
            }
        }
    }

    /**
     * @see org.argouml.uml.ui.UMLModelElementListModel2#isValidElement(Object)
     */
    protected boolean isValidElement(Object/*MBase*/ element) {
        return false;
    }

    /**
     * @see ru.novosoft.uml.MElementListener#roleRemoved(ru.novosoft.uml.MElementEvent)
     */
    public void roleRemoved(MElementEvent e) {
        if (e.getName().equals("base") && e.getSource() == getTarget()) {
            Object clazz = /*(MClassifier)*/ getChangedElement(e);
            UmlModelEventPump.getPump().removeModelEventListener(
                    this,
                    clazz,
                "ownedElement");
        } else if (
		   e.getName().equals("ownedElement")
		   && ModelFacade.getBases(getTarget()).contains(
		           e.getSource())) {
            removeElement(getChangedElement(e));
        }
    }

}