/* 
 * Copyright (c) 2010 The Regents of the University of California.
 * All rights reserved.
 *
 * '$Author: tao $'
 * '$Date: 2010-07-23 17:04:30 -0700 (Fri, 23 Jul 2010) $' 
 * '$Revision: 25146 $'
 * 
 * Permission is hereby granted, without written agreement and without
 * license or royalty fees, to use, copy, modify, and distribute this
 * software and its documentation for any purpose, provided that the above
 * copyright notice and the following two paragraphs appear in all copies
 * of this software.
 *
 * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
 * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
 * 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 OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
 * ENHANCEMENTS, OR MODIFICATIONS.
 *
 */
package org.kepler.workflowscheduler.gui;

import java.util.Vector;

import javax.swing.JTree;
import javax.swing.tree.DefaultTreeSelectionModel;
import javax.swing.tree.TreePath;

import org.kepler.gui.ComponentLibraryTab;

/**
 * A controller controls the relationship between schedule change and presentation(listener) change
 * @author tao
 *
 */
public class ScheduleChangeController
{
  private Vector <ScheduleChangeListenerInterface>listenerList = new Vector<ScheduleChangeListenerInterface>();
  private ComponentLibraryTab componentTab = null;
  private boolean firstTime = true;
  private boolean showWarningMessageOnNoReporting = true;
  /**
   * Add a ScheduleChangeListenerInterface into the controller
   * @param listener
   */
  public void addListener(ScheduleChangeListenerInterface listener)
  {
    listenerList.add(listener);
  }
  
  /**
   * Remove a listener from the controller
   * @param listener
   */
  public void removeListener(ScheduleChangeListenerInterface listener)
  {
    listenerList.remove(listener);
  }
  
  /**
   * Handle the event that a new schedule is added
   * @param schedule  the new schedule
   * @throws Exception
   */
  public void addSchedule(Schedule schedule) throws Exception
  {
    for(int i=0; i<listenerList.size(); i++)
    {
      ScheduleChangeListenerInterface listener = listenerList.elementAt(i);
      if(listener != null)
      {
        listener.addSchedule(schedule);
      }
    }
  }
  
  /**
   * Handle the event that a schedule is removed
   * @param schedule the schedule will be removed
   * @throws Exception
   */
  public void removeSchedule(Schedule schedule) throws Exception
  {
    for(int i=0; i<listenerList.size(); i++)
    {
      ScheduleChangeListenerInterface listener = listenerList.elementAt(i);
      if(listener != null)
      {
        listener.removeSchedule(schedule);
      }
    }
  }
  
  /**
   * Handle the event that a schedule will be enabled
   * @param schedule the schedule will be enabled
   * @throws Exception
   */
  public void enableSchedule(Schedule schedule) throws Exception
  {
    for(int i=0; i<listenerList.size(); i++)
    {
      ScheduleChangeListenerInterface listener = listenerList.elementAt(i);
      if(listener != null)
      {
        listener.enableSchedule(schedule);
      }
    }
  }
  
  /**
   * Handle the event that a schedule will be disabled
   * @param schedule the schedule will be disabled
   * @throws Exception
   */
  public void disableSchedule(Schedule schedule) throws Exception
  {
    for(int i=0; i<listenerList.size(); i++)
    {
      ScheduleChangeListenerInterface listener = listenerList.elementAt(i);
      if(listener != null)
      {
        listener.disableSchedule(schedule);
      }
    }
  }
  
  /**
   * Handle the event that new schedules will replace the old one.
   * @param newSchedule new schedules
   * @throws Exception
   */
  public void update(Schedule[] newSchedules) throws Exception
  {
    for(int i=0; i<listenerList.size(); i++)
    {
      ScheduleChangeListenerInterface listener = listenerList.elementAt(i);
      if(listener != null)
      {
        listener.update(newSchedules);
      }
    }
  }
  
  /**
   * Call this method when the SearchSchedules worker finishes its job
   */
  public void complete()
  {
    for(int i=0; i<listenerList.size(); i++)
    {
      ScheduleChangeListenerInterface listener = listenerList.elementAt(i);
      if (listener != null &&listener instanceof SearchSchedulesWorkerListenerInterface)
      {
        
        SearchSchedulesWorkerListenerInterface workerListener = 
                    (SearchSchedulesWorkerListenerInterface)listener;     
        workerListener.complete();
      }
     
    }
  }
  
  /**
   * Call this method to start progress bar
   */
  public void startProgressBar()
  {
    for(int i=0; i<listenerList.size(); i++)
    {
      ScheduleChangeListenerInterface listener = listenerList.elementAt(i);
      if (listener != null &&listener instanceof ProgressBarControlInterface)
      {
        
        ProgressBarControlInterface workerListener = 
                    (ProgressBarControlInterface)listener;     
        workerListener.start();
      }
     
    }
  }
  
  /**
   * Call this method to stop progress bar
   */
  public void stopProgressBar()
  {
    for(int i=0; i<listenerList.size(); i++)
    {
      ScheduleChangeListenerInterface listener = listenerList.elementAt(i);
      if (listener != null &&listener instanceof ProgressBarControlInterface)
      {
        
        ProgressBarControlInterface workerListener = 
                    (ProgressBarControlInterface)listener;     
        workerListener.stop();
      }
     
    }
  }
  
  /**
   * Set the component library tab
   * @param tab
   */
  public void setComponentLibraryTab(ComponentLibraryTab tab)
  {
    componentTab =tab;
  }
  
  /**
   *Disable selecting a node from tree
   */
  public void disableTreeSelection()
  {
    if(componentTab != null)
    {
      //System.out.println("component tab is not null");
      JTree resultTree = componentTab.getResultTree();
      if(resultTree != null)
      {
        //System.out.println("adding non-selectable tree selection model");
        TreePath path = resultTree.getLeadSelectionPath();
        resultTree.setSelectionModel(new NonSelectableTreeSelectionModel());
        resultTree.setSelectionPath(path);
      }
    }
    
  }
  
  /**
   *Enable selecting a node from tree
   */
  public void enableTreeSelection()
  {
    if(componentTab != null)
    {
      JTree resultTree = componentTab.getResultTree();
      if(resultTree != null)
      {
        //System.out.println("adding default tree selection model");
        firstTime = true;
        TreePath path = resultTree.getLeadSelectionPath();
        NonResponseTreePath nonResponsePath = null;
        if(path != null)
        {
          nonResponsePath = new NonResponseTreePath(path);
        }
        resultTree.setSelectionModel(new DefaultTreeSelectionModel());
        resultTree.setSelectionPath(nonResponsePath);
      }
    }
    
  }
  
  /**
   * A non-selectable tree selection model but allow first selection
   */
  public class NonSelectableTreeSelectionModel extends DefaultTreeSelectionModel
  {
    
    /**
     * Do nothing on this method
     */
    public void setSelectionPath(TreePath path) 
    {
      if(firstTime)
      {
        //System.out.println("first time to set up the original one");
        firstTime = false;
        super.setSelectionPath(path);
      }
      /*else
      {

        System.out.println("NonSelectableTreeSelectionModel  do nothing at setSelectionPath(TreePath path)");
      }*/
      
    }
   
  }
  
  /**
   * Call the method when the uploading is done. 
   * It will put the kar file lsid into a map. Then select the remote copy of the kar file to
   * scheduler gui.
   * @param KARFileLSID the lisd of the uploaded kar file
   * @param KARFilePath the path of the local kar file
   * @param workflowName the name of the workflow 
   * @param workflowLSID the lsid of the workflow
   * @param repositoryName the name of the remote repository
   */
  public void completeUploading(String KARFileLSID, String KARFilePath, String workflowName, 
      String workflowLSID, String repositoryName)
  {
    for(int i=0; i<listenerList.size(); i++)
    {
      ScheduleChangeListenerInterface listener = listenerList.elementAt(i);
      if (listener != null &&listener instanceof UploadingKARFileListenerInterface)
      {
        
        UploadingKARFileListenerInterface workerListener = 
                    (UploadingKARFileListenerInterface)listener;     
        workerListener.completeUploading(KARFileLSID, KARFilePath, workflowName, 
                                                       workflowLSID, repositoryName);
      }
     
    }
  }
  
  /**
   * If the warning message will be shown if there is no reporting design on the workflow.
   * @return true if the warning message will be shown. false otherwise.
   */
  public boolean showWarningMessageOnNoReporting()
  {
    return showWarningMessageOnNoReporting;
  }
  
  /**
   * Set the controller showing the warning message or not if there is no reporting design on the workflow.
   * @param showWarningMessageOnNoReporting  true to show the warning message.
   */
  public void setShowWarningMessageOnNoReporting(boolean showWarningMessageOnNoReporting)
  {
    this.showWarningMessageOnNoReporting = showWarningMessageOnNoReporting;
  }
}