/**

  * Copyright 2009 Timothy Johnston 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 com.timjohnstondev.unitconverter.controller;

 import java.util.List;

 import java.util.prefs.Preferences;

 import javax.swing.DefaultListModel;

 import javax.swing.JList;

 import com.timjohnstondev.unitconverter.Launcher;

 import com.timjohnstondev.unitconverter.logic.ConversionFactorParser;

 import com.timjohnstondev.unitconverter.logic.ConversionFactorParserHandler;

 import com.timjohnstondev.unitconverter.model.PropertyList;

 /**

  * The controller in the MVC pattern for this application. Acts and the intermediary between the view components and the

  * model components.

  */

 public class ModelController

 {

   private PropertyList properties;

   private String unitSeparator;

   /**

    * Constructs and initializes a {@code ModelController}, pulling all of the model data into a

    * {@link com.timjohnstondev.unitconverter.model.PropertyList}.

    */

   public ModelController()

   {

     properties = loadPropertyList();

   }

   /**

    * Returns the {@link com.timjohnstondev.unitconverter.model.Conversion Conversion} factor or formula for the given

    * {@link com.timjohnstondev.unitconverter.model.Property Property} name for going from one set of units to another.

    * 

    * @param property the name of the {@code Property} that will be converted, such as temperature, pressure or length

    * @param from the original units

    * @param to the desired units

    * @return the factor or formula to perform the conversion

    */

   public final String getConversion(final String property, final String from, final String to)

   {

     return properties.getConversion(property, from, to);

   }

   /**

    * Returns a list of all the {@link com.timjohnstondev.unitconverter.model.Property Property} names in the data

    * source. The order of the names is determined by the underlying {@link PropertyList}. This list order was initially

    * based on the order the properties appear in the data source.

    * 

    * @return a list of the {@code Property} names

    */

   public final List <String> getPropertyNames()

   {

     return properties.getPropertyNames();

   }

   /**

    * Returns a list of all the symbols for this {@link com.timjohnstondev.unitconverter.model.Property Property} in the

    * data source. The order of the symbols is determined by the underlying {@link PropertyList}. This list order was

    * initially based on the order the symbols appear in the data source for this {@code Property}.

    * 

    * @param property the name of the {@code Property} that is the basis for the units

    * @return a list of the symbols

    */

   public final List <String> getSymbols(final String property)

   {

     return properties.getSymbols(property);

   }

   /**

    * Returns a list, minus the symbol provided, of the symbols for this

    * {@link com.timjohnstondev.unitconverter.model.Property Property} in the data source. The order of the symbols is

    * determined by the underlying {@code Property}. This list order was initially based on the order the symbols appear

    * in the data source for this {@code Property}.

    * 

    * @param property the name of the {@code Property} that is the basis for the units

    * @param fromUnit the symbol to leave out of the list

    * @return a list of the symbols

    */

   public final List <String> getSymbols(final String property, final String fromUnit)

   {

     return properties.getSymbols(property, fromUnit);

   }

   /**

    * Returns this symbol's name in unabbreviated words for this {@link com.timjohnstondev.unitconverter.model.Property

    * Property}.

    * 

    * @param property the name of the {@code Property} that is the basis for this unit

    * @param unitSymbol the symbol that represents the returned name

    * @return the name for this symbol

    */

   public final String getUnitName(final String property, final String unitSymbol)

   {

     return properties.getUnitName(property, unitSymbol);

   }

   /**

    * Returns the unit separator symbol or the default (*) if the value has not been set

    * 

    * @return the unit separator symbol or the default (*) if the value has not been set

    */

   public final String getUnitSeparator()

   {

     return unitSeparator != null ? unitSeparator : "*";

   }

   /**

    * Updates the unit separator symbol

    * 

    * @param symbol the new unit separator symbol

    */

   public final void setUnitSeparator(final String symbol)

   {

     properties = loadPropertyList();

     properties.setUnitSeparator(symbol);

     unitSeparator = symbol;

   }

   /**

    * Returns {@code true} if this {@code Property} can do mole to mass and mass to mole unit conversions, else {@code

    * false}

    * 

    * @param propertyName name of the property

    * @return {@code true} if this {@code Property} can do mole to mass and mass to mole unit conversions, else {@code

    *         false}

    */

   public final boolean usesMoles(final String propertyName)

   {

     return properties.usesMoles(propertyName);

   }

   private PropertyList loadPropertyList()

   {

     final ConversionFactorParserHandler parserHandler = new ConversionFactorParserHandler();

     (new ConversionFactorParser(parserHandler)).parse();

     return parserHandler.getPropertyList();

   }

   /**

    * Updates the preference that orders the {@code Property}s in the application.

    * 

    * @param list {@code Property} list

    */

   public final void setPropertyOrderPreferences(final JList list)

   {

     final DefaultListModel model = (DefaultListModel) list.getModel();

     final Preferences userPref = Preferences.userNodeForPackage(Launcher.class);

     for (int i = 0; i < model.size(); i++)

     {

       final String key = "sortorder." + ((String) model.get(i)).replaceAll(" ", "").toLowerCase();

       userPref.putInt(key, i + 1);

     }

   }

 }