/**
    * 2007, Digitalis Informatica. All rights reserved. Distribuicao e Gestao de Informatica, Lda. Estrada de Paco de Arcos
    * num.9 - Piso -1 2780-666 Paco de Arcos Telefone: (351) 21 4408990 Fax: (351) 21 4408999 http://www.digitalis.pt
    */
   package pt.digitalis.dif.dem.objects.parameters.types;
   
   import java.math.BigDecimal;
   import java.util.ArrayList;
   import java.util.Date;
  import java.util.List;
  
  import pt.digitalis.dif.controller.interfaces.IDIFContext;
  import pt.digitalis.dif.dem.interfaces.IStageInstance;
  import pt.digitalis.dif.dem.objects.parameters.constraints.IParameterConstraint;
  import pt.digitalis.dif.dem.objects.parameters.errors.ParameterError;
  import pt.digitalis.dif.dem.objects.parameters.errors.ParameterErrorList;
  import pt.digitalis.dif.dem.objects.parameters.errors.ParameterErrorType;
  import pt.digitalis.dif.exception.objects.ParameterException;
  import pt.digitalis.dif.startup.DIFGeneralConfigurationParameters;
  
  /**
   * This class will define a numeric Parameter.
   * <p>
   * It will hold information relative to the Parameter value, ID key and validation constraints.
   * 
   * @author Pedro Viegas <a href="mailto:pviegas@digitalis.pt">pviegas@digitalis.pt</a>
   * @author Rodrigo Gonçalves <a href="mailto:rgoncalves@digitalis.pt">rgoncalves@digitalis.pt</a>
   * @created Nov 23, 2007
   */
  public class DoubleParameter extends AbstractParameter<Number> {
  
      /** The list of supported classes to define in the concrete implementations */
      @SuppressWarnings("serial")
      final static private List<String> supportedClasses = new ArrayList<String>() {
  
          {
              add(Double.class.getCanonicalName());
          }
      };
  
      /**
       * @see pt.digitalis.dif.dem.objects.parameters.types.AbstractParameter#automaticConstraints()
       */
      @Override
      protected String automaticConstraints()
      {
          return "numeric";
      }
  
      /**
       * @see pt.digitalis.dif.dem.objects.parameters.IParameter#getSupportedClasses()
       */
      public List<String> getSupportedClasses()
      {
          return supportedClasses;
      }
  
      /**
       * @see pt.digitalis.dif.dem.objects.parameters.IParameter#getValueAsBigDecimal(pt.digitalis.dif.controller.interfaces.IDIFContext)
       */
      public BigDecimal getValueAsBigDecimal(IDIFContext context) throws ParameterException
      {
          return BigDecimal.valueOf(getValue(context).doubleValue());
      }
  
      /**
       * @see pt.digitalis.dif.dem.objects.parameters.IParameter#getValueAsBoolean(IDIFContext)
       */
      public boolean getValueAsBoolean(IDIFContext context) throws ParameterException
      {
          return (getValue(context).doubleValue() != 0D);
      }
  
      /**
       * @see pt.digitalis.dif.dem.objects.parameters.IParameter#getValueAsDate(IDIFContext)
       */
      public Date getValueAsDate(IDIFContext context)
      {
          return null;
      }
  
      /**
       * @see pt.digitalis.dif.dem.objects.parameters.IParameter#getValueAsDouble(IDIFContext)
       */
      public Double getValueAsDouble(IDIFContext context) throws ParameterException
      {
          return getValue(context).doubleValue();
      }
  
      /**
       * @see pt.digitalis.dif.dem.objects.parameters.IParameter#getValueAsLong(IDIFContext)
       */
      public Long getValueAsLong(IDIFContext context) throws ParameterException
      {
          return getValue(context).longValue();
      }
  
      /**
       * @see pt.digitalis.dif.dem.objects.parameters.IParameter#isNumeric()
      */
     public boolean isNumeric()
     {
         return true;
     }
 
     /**
      * @see pt.digitalis.dif.dem.objects.parameters.IParameter#setValueFromString(java.lang.String,
      *      pt.digitalis.dif.dem.interfaces.IStageInstance, boolean)
      */
     public ParameterErrorList setValueFromString(String value, IStageInstance stageInstance,
             boolean initializationInProgress)
     {
 
         ParameterErrorList list = new ParameterErrorList(this, value);
         ParameterError error;
         // TODO: Create a floating point constraint. This will not pick up the floating point errors
         IParameterConstraint constraint = getConstraints().get("numeric");
         IDIFContext context;
 
         if (stageInstance == null)
             context = null;
         else
             context = stageInstance.getContext();
 
         // If the numeric constraint does not validate...
         if (!constraint.validateConstraint(value, stageInstance))
         {
             String language;
 
             if (context == null)
                 language = DIFGeneralConfigurationParameters.getInstance().getDefaultLanguage();
             else
                 language = context.getLanguage();
 
             error = new ParameterError(constraint.validationErrorMessage(language), ParameterErrorType.CONSTRAINT);
             error.setConstraint("numeric", constraint);
 
             list.addError(error);
         }
         else
         {
             try
             {
                 if (value == null || "".equals(value))
                     return setValue(null, stageInstance, initializationInProgress);
                 else
                 {
                     value = value.replace(',', '.').trim();
 
                     return setValue(Double.valueOf(value), stageInstance, initializationInProgress);
                 }
             }
             catch (Exception e)
             {
                 /*
                  * Unreachable exception: to get here Double#parseDouble() would have to throw a NumberFormatException.
                  * This exception is raised if the string does not contain a parsable double. This would happen if a bad
                  * value is passed. This situation is avoided by the constraint validation mechanism. So if a bad value
                  * is passed the code never enters the 'else' branch and as such is never possible to get here.
                  */
                 error = new ParameterError("Error parsing value", ParameterErrorType.OTHER);
                 error.setException(e);
                 list.addError(error);
             }
         }
         return list;
     }
 }