package com.explosion.utilities.process;
   
   /*
    * =============================================================================
    * 
    * Copyright 2004 Stephen Cowx
    * 
    * Licensed under the Apache License, Version 2.0 (the "License"); you may not
    * use this file except in compliance with the License. You may obtain a copy of
   * the License at
   * 
   * http://www.apache.org/licenses/LICENSE-2.0
   * 
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
   * License for the specific language governing permissions and limitations under
   * the License.
   * 
   * =============================================================================
   */
  
  import javax.swing.SwingUtilities;
  
  import com.explosion.utilities.exception.ExceptionManager;
  import com.explosion.utilities.process.threads.Finishable;
  import com.explosion.utilities.process.threads.ProcessThread;
  import com.explosion.utilities.process.threads.SimpleProcess;
  import com.explosion.utilities.process.threads.SimpleProcessThread;
  import com.explosion.utilities.process.threads.Updateable;
  
  /***
   * @author Stephen Cowx
   * 
   * Subclass this fellow if you want a simple threadbased process. If the
   * Finishable you pass it is not null, it will call the finish() method of that
   * finishable once it is done.
   * 
   * Thisis a Stackable process. This means that one instance of these can create
   * and call the process method of any other.
   * 
   * In this case, they would all share the same parentProcessControl and so would
   * be able to check the status of the parentProcessControl. The
   * parentProcessControl and other interested parties are however only aware of
   * the top process and so only listen to the percent complete of that process.
   * 
   * To implement one of these classes, one must implement the process method and
   * ensure that you constantly check the isStopped() method to see if the
   * parentprocess has been stopped. If it has, return immediately.
   * 
   * Date created:@13-Feb-2003
   */
  public abstract class StackableSimpleProcess extends ExceptionManager implements SimpleProcess
  {
  
      private String statusText = "Processing";
  
      private boolean processUnitComplete = false;
  
      private ProcessThread parentProcessControl;
  
      private Finishable finishable;
      
      private Updateable updateable;
  
      private boolean initialised = false;
  
      private int percentComplete = 0;
      
      private boolean isUserProcess = false;    
      
      public StackableSimpleProcess(Finishable finishable, StackableSimpleProcess parentProcess)
      {
          this(parentProcess);
          this.finishable = finishable;
      }
      
      public StackableSimpleProcess(Updateable updateable, StackableSimpleProcess parentProcess)
      {
          this(parentProcess);
          this.updateable = updateable;
      }
      
      public StackableSimpleProcess(Finishable finishable, Updateable updateable, StackableSimpleProcess parentProcess)
      {
          this(parentProcess);
          this.finishable = finishable;
          this.updateable = updateable;
      }    
      
      public StackableSimpleProcess(StackableSimpleProcess parentProcess)
      {
          if (parentProcess == null) // ie,this is a root
          {
              parentProcessControl = new SimpleProcessThread();
              parentProcessControl.setProcess(this);
          } else
          {
              parentProcessControl = parentProcess.getProcessControl();
         } 
     }
 
     public abstract void process() throws Exception;
 
     public void initialise() throws Exception
     {}
 
     public final void finalise() throws Exception
     {
         if (finishable != null) finishIt();
     }
 
     public final void finalise(Exception e)
     {
         if (finishable != null) finishIt();
     }
 
     private final void finishIt()
     {
         if (finishable != null)
         {
 	        Runnable doFinished = new Runnable()
 	        {
 	
 	            public void run()
 	            {
 	                finishable.finish();
 	            }
 	        };
 	        SwingUtilities.invokeLater(doFinished);
         }
     }
 
     public final int getPercentComplete()
     {
         return percentComplete;
     }
 
     public final void setPercentComplete(int percentComplete)
     {
         this.percentComplete = percentComplete;
     }
 
     public final String getStatusText()
     {
         return statusText;
     }
 
     public final void setStatusText(String statusText)
     {
         this.statusText = statusText;
     }
 
     public final ProcessThread getProcessControl()
     {
         return parentProcessControl;
     }
 
     public final void setProcessControl(ProcessThread processThread)
     {
         parentProcessControl = processThread;
     }
 
     public final boolean isStopped()
     {
         parentProcessControl.checkSuspended();
         return parentProcessControl.getStatus() == ProcessThread.THREAD_STOPPED;
     }
 
     /***
      * @return Returns the updateable.
      */
     public Updateable getUpdateable()
     {
         return updateable;
     }
     
     /***
      * Returns a boolean value indicating whther this is a user process or not
      * @return
      */
     public boolean isUserProcess()
     {
         return this.isUserProcess;
     }
     
     /***
      * Sets whtether or not this is a user process.  True means that it is
      * @param truth
      */
     public void setIsUserProcess(boolean truth)
     {
         this.isUserProcess = true;
     }    
 }