/* $Id: ToDoByGoal.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:

  *    bobtarling

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

  *

  * 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.cognitive.ui;

 import org.apache.log4j.Logger;

 import org.argouml.cognitive.Designer;

 import org.argouml.cognitive.Goal;

 import org.argouml.cognitive.ToDoItem;

 import org.argouml.cognitive.ToDoListEvent;

 import org.argouml.cognitive.ToDoListListener;

 /**

  * Represents a perspective for ToDo items: grouping by goal type.

  *

  */

 public class ToDoByGoal extends ToDoPerspective

     implements ToDoListListener {

     private static final Logger LOG =

         Logger.getLogger(ToDoByGoal.class);

     /**

      * The constructor.

      *

      */

     public ToDoByGoal() {

         super("combobox.todo-perspective-goal");

         addSubTreeModel(new GoListToGoalsToItems());

     }

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

     // ToDoListListener implementation

     /*

      * @see org.argouml.cognitive.ToDoListListener#toDoItemsChanged(org.argouml.cognitive.ToDoListEvent)

      */

     public void toDoItemsChanged(ToDoListEvent tde) {

         LOG.debug("toDoItemsChanged");

         Object[] path = new Object[2];

         path[0] = Designer.theDesigner().getToDoList();

         for (Goal g : Designer.theDesigner().getGoalList()) {

             path[1] = g;

             int nMatchingItems = 0;

             for (ToDoItem item : tde.getToDoItemList()) {

                 if (!item.supports(g)) {

                     continue;

                 }

                 nMatchingItems++;

             }

             if (nMatchingItems == 0) continue;

             int[] childIndices = new int[nMatchingItems];

             Object[] children = new Object[nMatchingItems];

             nMatchingItems = 0;

             for (ToDoItem item : tde.getToDoItemList()) {

                 if (!item.supports(g)) {

                     continue;

                 }

                 childIndices[nMatchingItems] = getIndexOfChild(g, item);

                 children[nMatchingItems] = item;

                 nMatchingItems++;

             }

             fireTreeNodesChanged(this, path, childIndices, children);

         }

     }

     /*

      * @see org.argouml.cognitive.ToDoListListener#toDoItemsAdded(org.argouml.cognitive.ToDoListEvent)

      */

     public void toDoItemsAdded(ToDoListEvent tde) {

         LOG.debug("toDoItemAdded");

         Object[] path = new Object[2];

         path[0] = Designer.theDesigner().getToDoList();

         for (Goal g : Designer.theDesigner().getGoalList()) {

             path[1] = g;

             int nMatchingItems = 0;

             for (ToDoItem item : tde.getToDoItemList()) {

                 if (!item.supports(g)) {

                     continue;

                 }

                 nMatchingItems++;

             }

             if (nMatchingItems == 0) {

                 continue;

             }

             int[] childIndices = new int[nMatchingItems];

             Object[] children = new Object[nMatchingItems];

             nMatchingItems = 0;

             // TODO: This shouldn't require two passes through the list - tfm

             for (ToDoItem item : tde.getToDoItemList()) {

                 if (!item.supports(g)) {

                     continue;

                 }

                 childIndices[nMatchingItems] = getIndexOfChild(g, item);

                 children[nMatchingItems] = item;

                 nMatchingItems++;

             }

             fireTreeNodesInserted(this, path, childIndices, children);

         }

     }

     /*

      * @see org.argouml.cognitive.ToDoListListener#toDoItemsRemoved(org.argouml.cognitive.ToDoListEvent)

      */

     public void toDoItemsRemoved(ToDoListEvent tde) {

         LOG.debug("toDoItemAdded");

         Object[] path = new Object[2];

         path[0] = Designer.theDesigner().getToDoList();

         for (Goal g : Designer.theDesigner().getGoalList()) {

             LOG.debug("toDoItemRemoved updating decision node!");

             boolean anyInGoal = false;

             for (ToDoItem item : tde.getToDoItemList()) {

                 if (item.supports(g)) anyInGoal = true;

             }

             if (!anyInGoal) continue;

             path[1] = g;

             //fireTreeNodesChanged(this, path, childIndices, children);

             fireTreeStructureChanged(path);

         }

     }

     /*

      * @see org.argouml.cognitive.ToDoListListener#toDoListChanged(org.argouml.cognitive.ToDoListEvent)

      */

     public void toDoListChanged(ToDoListEvent tde) { }

 }