/**

  * 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.model;

 import java.util.ArrayList;

 import java.util.List;

 /**

  * A collection of {@link Property}s and their unit symbols/names from the data source.

  */

 public class PropertyList extends ArrayList <Property>

 {

   /**

    * Returns a list of all the {@link Property} names in the data source. This list is organized by the order the

    * properties appear in the data source.

    * 

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

    */

   public final List <String> getPropertyNames()

   {

     final List <String> propertyNames = new ArrayList <String>();

     for (Property property : this)

     {

       propertyNames.add(property.getName());

     }

     return propertyNames;

   }

   /**

    * Returns the {@link Conversion} factor or formula for the given {@link Property} for going from one set of units to

    * another.

    * 

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

    *          length

    * @param fromSymbol the original units

    * @param toSymbol the desired units

    * @return the {@code Conversion} factor or formula to perform the conversion

    */

   public final String getConversion(final String propertyName, final String fromSymbol, final String toSymbol)

   {

     final Property property = getPropertyByName(propertyName);

     return property.getConversion(fromSymbol, toSymbol);

   }

   /**

    * Returns a list of all the symbols for the given {@link 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 the {@code Property}.

    * 

    * @param propertyName 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 propertyName)

   {

     final Property property = getPropertyByName(propertyName);

     return property.getSymbols();

   }

   /**

    * Returns a list, minus the symbol provided, of the symbols for the given {@link 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 fromSymbol the symbol to leave out of the list

    * @return a list of the symbols

    */

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

   {

     final List <String> symbols = getSymbols(property);

     symbols.remove(fromSymbol);

     return symbols;

   }

   /**

    * Returns this symbol's name in unabbreviated words for this {@link Property}.

    * 

    * @param propertyName 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 propertyName, final String unitSymbol)

   {

     final Property property = getPropertyByName(propertyName);

     return property.getUnitName(unitSymbol);

   }

   private Property getPropertyByName(final String propertyName)

   {

     Property property = null;

     for (Property prop : this)

     {

       if (propertyName.equals(prop.getName()))

       {

         property = prop;

         break;

       }

     }

     return property;

   }

   /**

    * Updates the unit separator symbol

    * 

    * @param symbol the new unit separator symbol

    */

   public final void setUnitSeparator(final String symbol)

   {

     for (Property prop : this)

     {

       prop.setUnitSeparator(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)

   {

     final Property property = getPropertyByName(propertyName);

     return property.usesMoles();

   }

 }