/* $Id: ToDoByOffender.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 java.util.List;

 import org.apache.log4j.Logger;

 import org.argouml.cognitive.Designer;

 import org.argouml.cognitive.ListSet;

 import org.argouml.cognitive.ToDoItem;

 import org.argouml.cognitive.ToDoListEvent;

 import org.argouml.cognitive.ToDoListListener;

 /**

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

  *

  */

 public class ToDoByOffender extends ToDoPerspective

         implements ToDoListListener {

     private static final Logger LOG = Logger.getLogger(ToDoByOffender.class);

     /**

      * The constructor.

      *

      */

     public ToDoByOffender() {

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

         addSubTreeModel(new GoListToOffenderToItem());

     }

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

     // ToDoListListener implementation

     /*

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

      */

     public void toDoItemsChanged(ToDoListEvent tde) {

         LOG.debug("toDoItemsChanged");

         List<ToDoItem> items = tde.getToDoItemList();

         Object[] path = new Object[2];

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

         ListSet allOffenders = Designer.theDesigner().getToDoList()

                 .getOffenders();

         synchronized (allOffenders) {

             for (Object off : allOffenders) {

                 path[1] = off;

                 int nMatchingItems = 0;

                 synchronized (items) {

                     for (ToDoItem item : items) {

                         ListSet offenders = item.getOffenders();

                         if (!offenders.contains(off)) {

                             continue;

                         }

                         nMatchingItems++;

                     }

                 }

                 if (nMatchingItems == 0) {

                     continue;

                 }

                 int[] childIndices = new int[nMatchingItems];

                 Object[] children = new Object[nMatchingItems];

                 nMatchingItems = 0;

                 synchronized (items) {

                     for (ToDoItem item : items) {

                         ListSet offenders = item.getOffenders();

                         if (!offenders.contains(off)) {

                             continue;

                         }

                         childIndices[nMatchingItems] = getIndexOfChild(off,

                                 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");

         List<ToDoItem> items = tde.getToDoItemList();

         Object[] path = new Object[2];

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

         ListSet allOffenders = Designer.theDesigner().getToDoList()

                 .getOffenders();

         synchronized (allOffenders) {

             for (Object off : allOffenders) {

                 path[1] = off;

                 int nMatchingItems = 0;

                 // TODO: This first loop just to count the items appears

                 // redundant to me - tfm 20070630

                 synchronized (items) {

                     for (ToDoItem item : items) {

                         ListSet offenders = item.getOffenders();

                         if (!offenders.contains(off)) {

                             continue;

                         }

                         nMatchingItems++;

                     }

                 }

                 if (nMatchingItems == 0) {

                     continue;

                 }

                 int[] childIndices = new int[nMatchingItems];

                 Object[] children = new Object[nMatchingItems];

                 nMatchingItems = 0;

                 synchronized (items) {

                     for (ToDoItem item : items) {

                         ListSet offenders = item.getOffenders();

                         if (!offenders.contains(off)) {

                             continue;

                         }

                         childIndices[nMatchingItems] = getIndexOfChild(off,

                                 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("toDoItemRemoved");

         List<ToDoItem> items = tde.getToDoItemList();

         Object[] path = new Object[2];

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

         ListSet allOffenders = Designer.theDesigner().getToDoList()

                 .getOffenders();

         synchronized (allOffenders) {

             for (Object off : allOffenders) {

                 boolean anyInOff = false;

                 synchronized (items) {

                     for (ToDoItem item : items) {

                         ListSet offenders = item.getOffenders();

                         // TODO: This looks O(n^2)

                         if (offenders.contains(off)) {

                             anyInOff = true;

                             break;

                         }

                     }

                 }

                 if (!anyInOff) {

                     continue;

                 }

                 LOG.debug("toDoItemRemoved updating PriorityNode");

                 path[1] = off;

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

                 fireTreeStructureChanged(path);

             }

         }

     }

     /*

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

      */

     public void toDoListChanged(ToDoListEvent tde) {

     }

 } /* end class ToDoByOffender */