// $Id: UMLClassifierRoleAssociationRoleListModel.java,v 1.14 2004/09/22 17:55:54 mvw Exp $
// Copyright (c) 1996-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.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;

import org.argouml.i18n.Translator;
import org.argouml.model.ModelFacade;
import org.argouml.model.uml.behavioralelements.collaborations.CollaborationsFactory;
import org.argouml.model.uml.behavioralelements.collaborations.CollaborationsHelper;
import org.argouml.model.uml.foundation.core.CoreHelper;
import org.argouml.uml.ui.UMLConnectionListModel;
import org.argouml.uml.ui.UMLUserInterfaceContainer;
import org.tigris.gef.graph.MutableGraphModel;

/**
 * Binary relation list model for associationsroles between classifierroles
 * 
 * @author jaap.branderhorst@xs4all.nl
 *
 * @deprecated as of ArgoUml 0.13.5 (10-may-2003), replaced by ?, this
 * class is part of the 'old'(pre 0.13.*) implementation of proppanels
 * that used reflection a lot.
 */
public class UMLClassifierRoleAssociationRoleListModel
	extends UMLConnectionListModel {

    /**
     * Constructor for UMLClassifierRoleAssociationRoleListModel.
     * @param container the UI container
     * @param property the property name
     * @param showNone true if we have to show "none" when there's no name
     */
    public UMLClassifierRoleAssociationRoleListModel(
	UMLUserInterfaceContainer container,
	String property,
	boolean showNone)
    {
	super(container, property, showNone);
    }

    /**
     * @see org.argouml.uml.ui.UMLBinaryRelationListModel#getChoices()
     */
    protected Collection getChoices() {
	Object target = getTarget();
	if (org.argouml.model.ModelFacade.isAClassifierRole(target)) {
	    Object role = /*(MClassifierRole)*/ target;
	    List list = new ArrayList();
	    Iterator it = ModelFacade.getBases(role).iterator();
	    while (it.hasNext()) {
		Object base = /*(MClassifier)*/ it.next();
		list.addAll(CoreHelper.getHelper()
		        .getAssociatedClassifiers(base));
	    }
	    return list;
	} else
	    throw new IllegalStateException(
                "Target not an instanceof MClassifierRole");
    }

    /**
     * @see org.argouml.uml.ui.UMLBinaryRelationListModel#getAddDialogTitle()
     */
    protected String getAddDialogTitle() {
	return Translator.localize("UMLMenu",
			     "dialog.add-associated-classifierroles");
    }

    /**
     * @see
     * org.argouml.uml.ui.UMLBinaryRelationListModel#connect(MutableGraphModel,
     * Object, Object)
     */
    protected void connect(
			   MutableGraphModel gm,
			   Object/*MModelElement*/ from,
			   Object/*MModelElement*/ to) {
	gm.connect(from, to, (Class) ModelFacade.ASSOCIATION_ROLE);
    }

    /**
     * @see org.argouml.uml.ui.UMLBinaryRelationListModel#build(Object,Object)
     */
    protected void build(Object/*MModelElement*/ from, 
            Object/*MModelElement*/ to) {
	if (from != null && to != null && ModelFacade.isAClassifierRole(from) 
            && ModelFacade.isAClassifierRole(to)) { 
	    CollaborationsFactory.getFactory().buildAssociationRole(from, to);
	}
    }

    /**
     * @see
     * org.argouml.uml.ui.UMLBinaryRelationListModel#getRelation(Object,Object)
     */
    protected Object getRelation(Object/*MModelElement*/ from, 
            Object/*MModelElement*/ to) {
	if (from != null && to != null && ModelFacade.isAClassifierRole(from) 
            && ModelFacade.isAClassifierRole(to)) { 
	    return CollaborationsHelper.getHelper().getAssocationRole(
                /*(MClassifierRole)*/ from, /*(MClassifierRole)*/ to);
	} else
	    throw new IllegalArgumentException(
                "Tried to get relation between some objects of which one " 
                + "was not a classifierrole");
    }

}