package com.explosion.expfmodules.wizard.standard;
   
   import java.util.ArrayList;
   import java.util.Collections;
   import java.util.Comparator;
   import java.util.Iterator;
   import java.util.List;
   import java.util.Map;
   
  import com.explosion.expfmodules.wizard.StepAction;
  import com.explosion.expfmodules.wizard.StepDefinition;
  import com.explosion.expfmodules.wizard.StepView;
  import com.explosion.expfmodules.wizard.Wizard;
  import com.explosion.utilities.GeneralConstants;
  
  
  /* =============================================================================
   *       
   *     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.
   * 
   * =============================================================================
   */
  
  /***
   * @author Stephen Cowx
   * Created on 22-Dec-2004
   */
  public class StandardStepDefinition implements StepDefinition
  {
  
      private StepAction action;
      private Map dataItems;
      private String help;
      private String id;
      private String name;
      private String notes;
      private String icon;
      private StepView view;
      private Wizard wizard;
      
      /***
       * Returns a reference to the wizard to which this step belongs
       * @return
       */
      public Wizard getWizard()
      {
          return wizard;
      }
      
      /***
       * Sets the wizard
       * @param wizard
       */
      public void setWizard(Wizard wizard)
      {
         this.wizard = wizard; 
      }
      
      /***
       * @see com.explosion.expfmodules.wizard.StepDefinition#getAction()
       * @return
       */   
      public StepAction getAction()
      {
          return action;
      }
      
      /***
       * @see com.explosion.expfmodules.wizard.StepDefinition#setAction(com.explosion.expfmodules.wizard.StepAction)
       * @param action
       */
      public void setAction(StepAction action)
      {
          this.action = action;
      }
      
      /***
       * @see com.explosion.expfmodules.wizard.StepDefinition#getDataItems()
       * @return
       */
      public Map getDataItems()
      {
          return dataItems;
      }
      
      /***
       * Sets the data items
      * @param dataItems
      */
     public void setDataItems(Map dataItems)
     {
         this.dataItems = dataItems;
     }
     
     
     /***
      * Returns a collection of the dataItems in this step ordered according to their
      * preferred display order
      * @return
      */
     public List getOrderedDataItems()
     {
       List list = new ArrayList();
       if (dataItems != null && dataItems.values() != null)
       {
       	for (Iterator it = dataItems.values().iterator(); it.hasNext();)
         {
 	      list.add(it.next());
 	    }
         Collections.sort(list, new PreferenceDataItemComparator());
       }
       return list;
     }
     
     /***
      * @see com.explosion.expfmodules.wizard.StepDefinition#getHelp()
      * @return
      */
     public String getHelp()
     {
         return help;
     }
     
     /***
      * @param help
      */
     public void setHelp(String help)
     {
         this.help = help;
     }
     
     /***
      * @see com.explosion.expfmodules.wizard.StepDefinition#getId()
      * @return
      */
     public String getId()
     {
         return this.id;
     }
     
     /***
      * @param id
      */
     public void setId(String id)
     {
         this.id = id;
     }
     
     /***
      * @see com.explosion.expfmodules.wizard.StepDefinition#getName()
      * @return
      */
     public String getName()
     {
         return name;
     }
     
     /***
      * @param name
      */
     public void setName(String name)
     {
         this.name = name;
     }
     
     /***
      * @see com.explosion.expfmodules.wizard.StepDefinition#getView()
      * @return
      */
     public StepView getView()
     {
         return view;
     }
     
     /***
      * @see com.explosion.expfmodules.wizard.StepDefinition#setView(com.explosion.expfmodules.wizard.StepView)
      * @param view
      */
     public void setView(StepView view)
     {
         this.view = view;
     }
     
     /***
      * returns the icon for this step
      * @return
      */
     public String getIcon()
     {
         return icon;
     }
     
     /***
      * Sets the Icon for this step
      * @param icon
      */
     public void setIcon(String icon)
     {
         this.icon = icon;
     }
     
     /***
      * Returns the notes for this step
      * @return
      */
     public String getNotes()
     {
         return notes;
     }
     
     /***
      * Sets the notes for this step
      * @param notes
      */
     public void setNotes(String notes)
     {
         this.notes = notes;
     }
     
     /***
      * Displays information about this step definition
      */
     public String toString()
     {
     	StringBuffer string = new StringBuffer();
     	string.append(GeneralConstants.LS);
     	string.append(GeneralConstants.LS);
     	string.append(GeneralConstants.LS);
     	string.append(GeneralConstants.LS);
     	
     	return string.toString();
     }
 }
 
 class PreferenceDataItemComparator implements Comparator
 {
 	/***
 	 * returns value appropriate depending on the sort order
 	 */
 	public int compare(Object arg0, Object arg1) {
 		PreferenceDataItem item1 = (PreferenceDataItem) arg0;
 		PreferenceDataItem item2 = (PreferenceDataItem) arg1;
 		
 		if (item1.getSortOrderNumber() > item1.getSortOrderNumber())
 			return 1;
 		else if (item1.getSortOrderNumber() < item1.getSortOrderNumber())
 			return -1;
 		else 
 			return 0;
 	}
 }