/* $Id: GoListToOffenderToItem.java 17818 2010-01-12 18:39:46Z 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.

 package org.argouml.cognitive.ui;

 import java.util.ArrayList;

 import java.util.Collections;

 import java.util.List;

 import javax.swing.event.TreeModelListener;

 import javax.swing.tree.TreePath;

 import org.argouml.cognitive.Designer;

 import org.argouml.cognitive.ListSet;

 import org.argouml.cognitive.ToDoItem;

 import org.argouml.cognitive.ToDoList;

 import org.argouml.uml.PredicateNotInTrash;

 /**

  * Rule for sorting the ToDo list: Offender -> Item.

  *

  */

 public class GoListToOffenderToItem extends AbstractGoList2 {

     private Object lastParent;

     private List<ToDoItem> cachedChildrenList;

     /**

      * The constructor.

      */

     public GoListToOffenderToItem() {

         setListPredicate((org.argouml.util.Predicate) new PredicateNotInTrash());

     }

     ////////////////////////////////////////////////////////////////

     // TreeModel implementation

     /*

      * @see javax.swing.tree.TreeModel#getChild(java.lang.Object, int)

      */

     public Object getChild(Object parent, int index) {

         // TODO: This should only be building list up to 'index'

         return getChildrenList(parent).get(index);

     }

     /*

      * @see javax.swing.tree.TreeModel#getChildCount(java.lang.Object)

      */

     public int getChildCount(Object parent) {

         return getChildrenList(parent).size();

     }

     /*

      * @see javax.swing.tree.TreeModel#getIndexOfChild(

      * java.lang.Object, java.lang.Object)

      */

     public int getIndexOfChild(Object parent, Object child) {

         return getChildrenList(parent).indexOf(child);

     }

     /*

      * @see javax.swing.tree.TreeModel#isLeaf(java.lang.Object)

      */

     public boolean isLeaf(Object node) {

         if (node instanceof ToDoList) {

             return false;

         }

         // TODO: This is a very expensive way to do this

 //        if (getChildCount(node) > 0) {

 //            return false;

 //        }

         List<ToDoItem> itemList = 

             Designer.theDesigner().getToDoList().getToDoItemList();

         synchronized (itemList) {

             for (ToDoItem item : itemList) {

                 if (item.getOffenders().contains(node)) {

                     return false;

                 }

             }

         }

         return true;

     }

     /**

      * Get a list of children. Note that unlike its predecessor getChildren(),

      * this never returns null. If there are no children, it will return an

      * empty list.

      * 

      * @param parent the parent object to check

      * @return a list of children for the given object

      */

     public List<ToDoItem> getChildrenList(Object parent) {

         if (parent.equals(lastParent)) {

             return cachedChildrenList;

         }

         lastParent = parent;

         ListSet<ToDoItem> allOffenders = new ListSet<ToDoItem>();

         ListSet<ToDoItem> designerOffenders = 

             Designer.theDesigner().getToDoList().getOffenders();

         synchronized (designerOffenders) {

             allOffenders.addAllElementsSuchThat(designerOffenders,

                     getPredicate());

         }

         if (parent instanceof ToDoList) {

             cachedChildrenList = allOffenders;

             return cachedChildrenList;

         }

         //otherwise parent must be an offending design material

         if (allOffenders.contains(parent)) {

             List<ToDoItem> result = new ArrayList<ToDoItem>();

             List<ToDoItem> itemList = 

                 Designer.theDesigner().getToDoList().getToDoItemList();

             synchronized (itemList) {

                 for (ToDoItem item : itemList) {

                     ListSet offs = new ListSet();

                     offs.addAllElementsSuchThat(item.getOffenders(),

                             getPredicate());

                     if (offs.contains(parent)) {

                         result.add(item);

                     }

                 }

             }

             cachedChildrenList = result;

             return cachedChildrenList;

         }

         cachedChildrenList = Collections.emptyList();

         return cachedChildrenList;

     }

     /*

      * @see javax.swing.tree.TreeModel#valueForPathChanged(

      * javax.swing.tree.TreePath, java.lang.Object)

      */

     public void valueForPathChanged(TreePath path, Object newValue) {

     }

     /*

      * @see javax.swing.tree.TreeModel#addTreeModelListener(javax.swing.event.TreeModelListener)

      */

     public void addTreeModelListener(TreeModelListener l) {

     }

     /*

      * @see javax.swing.tree.TreeModel#removeTreeModelListener(javax.swing.event.TreeModelListener)

      */

     public void removeTreeModelListener(TreeModelListener l) {

     }

 }