/* $Id: UMLMetaClassComboBoxModel.java 17898 2010-01-12 21:38:37Z linus $

  *****************************************************************************

  * Copyright (c) 2009 Contributors - see below

  * All rights reserved. This program and the accompanying materials

  * are made available under the terms of the Eclipse Public License v1.0

  * which accompanies this distribution, and is available at

  * http://www.eclipse.org/legal/epl-v10.html

  *

  * Contributors:

  *    tfmorris

  *****************************************************************************

  *

  * Some portions of this file was previously release using the BSD License:

  */

 // Copyright (c) 1996-2008 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.

 // $header$

 package org.argouml.uml.ui.foundation.extension_mechanisms;

 import java.util.Collection;

 import java.util.Collections;

 import java.util.LinkedList;

 import java.util.List;

 import org.argouml.model.Model;

 import org.argouml.uml.ui.UMLComboBoxModel2;

 /**

  * A model for selecting a UML metaclass. Originally designed for use in

  * selecting the base class of stereotypes in UML 1.3, but now used to select

  * the type of a TagDefinition.

  * 

  * @author mkl

  */

 public class UMLMetaClassComboBoxModel extends UMLComboBoxModel2 {

     private List<String> metaClasses;

     /**

      * Construct a default combo box model.

      */

     public UMLMetaClassComboBoxModel() {

         super("tagType", true);

         Collection<String> tmpMetaClasses =

                 Model.getCoreHelper().getAllMetatypeNames();

         if (tmpMetaClasses instanceof List) {

             metaClasses = (List<String>) tmpMetaClasses;

         } else {

             metaClasses = new LinkedList<String>(tmpMetaClasses);

         }

         tmpMetaClasses.addAll(Model.getCoreHelper().getAllMetaDatatypeNames());

         try {

             Collections.sort(metaClasses);

         } catch (UnsupportedOperationException e) {

             // We got passed an unmodifiable List.  Copy it and sort the result

             metaClasses = new LinkedList<String>(tmpMetaClasses);

             Collections.sort(metaClasses);

         }

     }

     /*

      * @see org.argouml.uml.ui.UMLComboBoxModel2#getSelectedModelElement()

      */

     @Override

     protected Object getSelectedModelElement() {

         if (getTarget() != null) {

             return Model.getFacade().getType(getTarget());

         }

         return null;

     }

     /*

      * @see org.argouml.uml.ui.UMLComboBoxModel2#buildModelList()

      */

     protected void buildModelList() {

         setElements(metaClasses);

     }

     /*

      * @see org.argouml.uml.ui.UMLComboBoxModel2#isValidElement(Object)

      */

     protected boolean isValidElement(Object element) {

         return metaClasses.contains(element);

     }

 }