/* ===================================================================
    * Copyright 2002-04 SRI International.
    * Released under the MOZILLA PUBLIC LICENSE Version 1.1
    * which can be obtained at http://www.mozilla.org/MPL/MPL-1.1.html
    * This software is distributed on an "AS IS"
    * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied.
    * See the License for the specific language governing rights and
    * limitations under the License.
    * =================================================================== */
  package com.sri.emo.wizard.defaults;
  
  import com.jcorporate.expresso.core.controller.ErrorCollection;
  import com.jcorporate.expresso.core.dbobj.ValidValue;
  import com.sri.emo.wizard.PageMetadata;
  import com.sri.emo.wizard.WizardException;
  import com.sri.emo.wizard.WizardPage;
  
  import java.io.Serializable;
  
  
  /***
   * Wizard Page implementation for Emo.  By default will store one string
   * per page, although derived classes will often store maps, lists, and sets.
   *
   * @author Michael Rimov
   */
  public class EmoWizardPage implements WizardPage, Serializable {
      /***
  	 * 
  	 */
  	private static final long serialVersionUID = 1L;
  
  	/***
       * The Page Id as Integer.
       */
      private final Integer id;
  
      /***
       * The Page Metadata.
       */
      private final PageMetadata metadata;
  
      /***
       * The Page Data.
       */
      private Serializable data;
  
      /***
       * The page menus.
       */
      private ValidValue[] menu;
  
  
      /***
       * Sets any errors for the current page.
       */
      private ErrorCollection errors = null;
  
      /***
       * Constructor that takes a PageMetadata object and a page definition
       * object to build itself.
       *
       * @param newId        the page id.
       * @param pageMetadata the metadata for the page
       * @param optionalMenu The menu to pick from (may be null).
       */
      public EmoWizardPage(Integer newId, PageMetadata pageMetadata, ValidValue[] optionalMenu) {
          id = newId;
          metadata = pageMetadata;
          menu = optionalMenu;
      }
  
      public Serializable getId() {
          return id;
      }
  
      public Serializable getData() {
          return data;
      }
  
  
      public String getPrintableData() {
          if (data == null) {
              return null;
          }
  
          if (menu != null) {
              for (int i = 0; i < menu.length; i++) {
                  ValidValue oneVV = menu[i];
                  if (data.equals(oneVV.getKey())) {
                      return oneVV.getDescription();
                  }
              }
  
              throw new IllegalStateException(
                      "Menu is specified, but there is no matching data found for: " + data.toString());
          } else {
              return data.toString();
          }
     }
 
 
     public PageMetadata getMetadata() {
         return metadata;
     }
 
     public void setData(Serializable newData) throws WizardException {
         data = newData;
     }
 
     /***
      * Override to performs field comparison.
      * <p>{@inheritDoc}</p>
      *
      * @param parm1 The other object to compare.
      * @return true if all fields are equal
      */
     public boolean equals(Object parm1) {
         EmoWizardPage other = (EmoWizardPage) parm1;
 
         //
         //Translation:  Checks that one isn't null and the other isn't.
         //Then if both aren't null checks for equality.  Yes, I did want
         //to know if I could do it in one line of code :)
         //
         if (!(!(data == null ^ other.data == null) &&
                 ((data != null && data.equals(other.data))
                         || data == null))) {
             return false;
         }
 
         boolean returnValue = true;
         returnValue &= id.equals(other.id);
         returnValue &= metadata.equals(other.metadata);
 
         return returnValue;
     }
 
     /***
      * Override of hashcode.  Hashes the id.
      * <p>{@inheritDoc}</p>
      *
      * @return integer
      */
     public int hashCode() {
         return id.hashCode();
     }
 
     /***
      * Override of toString(), returns the Id.
      * <p>{@inheritDoc}</p>
      *
      * @return String
      */
     public String toString() {
         return EmoWizardPage.class.getName() + ": id=" + id;
     }
 
 
     /***
      * Retrieve the picklist value for the map.
      *
      * @return ValidValue[]
      */
     public ValidValue[] getMenu() {
         return menu;
     }
 
     /***
      * Retrieve an error collection (if any) that is associated with this page.
      * May return null if there are no errors.
      *
      * @return ErrorCollection
      */
     public ErrorCollection getPageErrors() {
         return this.errors;
     }
 
     /***
      * Clear all errors associated with the page.
      */
     public void removeErrors() {
         errors = null;
     }
 
 
     /***
      * Adds an error to be associated with the current page.
      *
      * @param message String
      */
     public synchronized void addError(String message) {
         if (errors == null) {
             errors = new ErrorCollection();
         }
 
         errors.addError(message);
     }
 
 }