/**
    * Copyright 2010, CSIRO Australia.
    *
    * 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.
   */
  
  package au.csiro.netcdf.wron;
  
  import java.text.DecimalFormat;
  import java.util.Arrays;
  
  import org.apache.log4j.Logger;
  
  /**
   * Represents a range of longitude values for some variables. The intended use is to 
   * store data for all variables in all longitudes for a particular latitude and time. 
   * Note: Speed is chosen over robustness and error checking in this class. Most 
   * problems will be signalled by a runtime exception of some form.  
   * 
   * Copyright 2010, CSIRO Australia
   * All rights reserved.
   * 
   * @author Robert Bridle on 12/04/2010
   * @version $Revision: 78 $ $Date: 2010-07-24 16:23:13 +1000 (Sat, 24 Jul 2010) $
   */
  public class LongitudeRange
  {
  
      /**
       * Constant that defines the logger to be used.
       */
      private static final Logger LOG = Logger.getLogger(LongitudeRange.class.getName());
  
      private static final float SPATIAL_INCREMENT_DEGREES = 0.05f;
  
      private int numVariables;
      private int numLongitudes;
      private float startLongitudeRange;
      private float values[][];
  
      int counter = 0;
  
      /**
       * Create a new longitude range. The values will all be preset to the 
       * supplied default value.
       * 
       * @param numVariables The number of variables the range should hold.
       * @param numLongitudes The number of longitudes the range should hold.
       * @param defaultValue The default values to preset for each variable.
       */
      public LongitudeRange(int numVariables, int numLongitudes, String[] defaultValues)
      {
          this.numVariables = numVariables;
          this.numLongitudes = numLongitudes;
          values = new float[this.numVariables][this.numLongitudes];
          for (int i = 0; i < numVariables; i++)
          {
              Arrays.fill(values[i], Float.valueOf(defaultValues[i]));
          }
      }
  
      /**
       * Retrieve the values for a particular variable as a string of one value per line. There will be one value for each
       * longitude.
       * 
       * @param varIndex
       *            The index of the variable to be returned.
       * @return the values for a particular variable
       */
      public String getValues(int varIndex)
      {
          StringBuffer strBuf = new StringBuffer();
          for (Float f : values[varIndex])
          {
              strBuf.append(f).append(System.getProperty("line.separator"));
          }
          return strBuf.toString();
      }
  
      /**
       * Retrieve the values for a particular variable as a string of one value per line. There will be one value for each
       * longitude.
       * 
       * @param varIndex
       *            The index of the variable to be returned.
       * @return the values for a particular variable
       */
      String getSingleValue(int varIndex, int longIndex)
      {
         return String.valueOf(values[varIndex][longIndex]);
     }
 
     /**
      * @return the startLongitudeRange
      */
     public float getStartLongitudeRange()
     {
         return startLongitudeRange;
     }
 
     /**
      * @param startLongitudeRange
      *            the startLongitudeRange to set
      */
     public void setStartLongitudeRange(String startLongitudeRange)
     {
         this.startLongitudeRange = Float.valueOf(startLongitudeRange);
     }
 
     /**
      * @return the endLongitudeRange
      */
     public String getEndLongitudeRange()
     {
         DecimalFormat fmtObj = new DecimalFormat("###0.00");
         return fmtObj.format(startLongitudeRange + (float) ((numLongitudes - 1) * SPATIAL_INCREMENT_DEGREES));
     }
 
     /**
      * @return the numVariables
      */
     public int getNumVariables()
     {
         return numVariables;
     }
 
     /**
      * @return the numLongitudes
      */
     public int getNumLongitudes()
     {
         return numLongitudes;
     }
 
     /**
      * @param rainFall
      */
     public void addValues(String[] variableValues)
     {
         for (int i = 0; i < variableValues.length; i++)
         {
             values[i][counter] = Float.valueOf(variableValues[i]);
         }
         counter++;
     }
 
     /**
      * @param rainFall
      */
     public void putValues(int longitudeIndex, String[] variableValues)
     {
         for (int i = 0; i < variableValues.length; i++)
         {
             values[i][longitudeIndex] = Float.valueOf(variableValues[i]);
         }
     }
 
     /**
      * @param rainFall
      */
     public void putValues(String longitude, String[] variableValues)
     {
         putValues(convertLongitudeToIndex(longitude), variableValues);
     }
     
     private int convertLongitudeToIndex(String longitude)
     {
         float longVal = Float.parseFloat(longitude);
         Float index = (longVal-startLongitudeRange)/SPATIAL_INCREMENT_DEGREES; 
         if (index > 500f)
         {
             LOG.error("Got an invalid longitude index from " + longVal + " of " + index);
         }
         return index.intValue();
     }
 
     public String debugOutput()
     {
         StringBuffer result = new StringBuffer();
         for (int varNum = 0; varNum < numVariables; varNum++)
         {
             for (int longIdx = 0; longIdx < numLongitudes; longIdx++)
             {
                 result.append(values[varNum][longIdx]).append(", ");
             }
             result.append("\n");
         }
         
         return result.toString();
     }
 }