/* $Id: TypeThenNameOrder.java 17843 2010-01-12 19:23:29Z 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-2006 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.ui.explorer;

 import javax.swing.tree.DefaultMutableTreeNode;

 import org.argouml.i18n.Translator;

 /**

  * Sorts by user object type,

  * diagrams first,

  * then packages,

  * then other types.

  *

  * sorts by name within type groups.

  *

  * @since 0.15.2, Created on 28 September 2003, 10:02

  *

  * @author  alexb

  */

 public class TypeThenNameOrder extends NameOrder {

     /** Creates a new instance of TypeThenNameOrder */

     public TypeThenNameOrder() {

     }

     /*

      * Compares obj1 and obj2 sorting by user object type, then name. Diagrams

      * are sorted first, then packages, then other types. sorts by name within

      * type groups. Nulls are sorted first for names.

      * 

      * @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)

      */

     @Override

     public int compare(Object obj1, Object obj2) {

         if (obj1 instanceof DefaultMutableTreeNode) {

             DefaultMutableTreeNode node = (DefaultMutableTreeNode) obj1;

             obj1 = node.getUserObject();

         }

         if (obj2 instanceof DefaultMutableTreeNode) {

             DefaultMutableTreeNode node = (DefaultMutableTreeNode) obj2;

             obj2 = node.getUserObject();

         }

         if (obj1 == null) {

             if (obj2 == null)

                 return 0;

             return -1;

         } else if (obj2 == null) {

             return 1;

         }

         String typeName = obj1.getClass().getName();

         String typeName1 = obj2.getClass().getName();

         // all diagram types treated equally, see issue 2260

         // if (typeName.indexOf("Diagram") != -1

         //     && typeName1.indexOf("Diagram") != -1)

         //     return compareUserObjects(obj1, obj2);

         int typeNameOrder = typeName.compareTo(typeName1);

         if (typeNameOrder == 0)

             return compareUserObjects(obj1, obj2);

         if (typeName.indexOf("Diagram") == -1

             && typeName1.indexOf("Diagram") != -1)

             return 1;

         if (typeName.indexOf("Diagram") != -1

             && typeName1.indexOf("Diagram") == -1)

             return -1;

         if (typeName.indexOf("Package") == -1

             && typeName1.indexOf("Package") != -1)

             return 1;

         if (typeName.indexOf("Package") != -1

             && typeName1.indexOf("Package") == -1)

             return -1;

         return typeNameOrder;

     }

     /*

      * @see java.lang.Object#toString()

      */

     @Override

     public String toString() {

         return Translator.localize("combobox.order-by-type-name");

     }

 }