/**

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

 /**

  * This is a unit of measure with its related conversion formula to another unit.

  */

 public class ConversionFormula implements Conversion

 {

   private String unitName;

   private String unitSymbol;

   private String toUnitSymbol;

   private String formula;

   /**

    * Constructs a {@code ConversionFormula} setting its name, symbol, to-symbol and formula.

    * 

    * @param newUnitName the name of the unit in unabbreviated words

    * @param newUnitSymbol the symbol of the unit

    * @param newToUnitSymbol the symbol of the unit to be converted to

    * @param newFormula the formula to perform the conversion

    */

   public ConversionFormula(final String newUnitName, final String newUnitSymbol, final String newToUnitSymbol,

       final String newFormula)

   {

     unitName = newUnitName;

     unitSymbol = newUnitSymbol;

     toUnitSymbol = newToUnitSymbol;

     formula = newFormula;

   }

   @Override

   public final String getUnitName()

   {

     return unitName;

   }

   /**

    * Returns the raw text symbol for the unit being converted to.

    * 

    * @return the unit symbol

    */

   public final String getToUnitSymbol()

   {

     return toUnitSymbol;

   }

   @Override

   public final String getUnitSymbol()

   {

     return unitSymbol;

   }

   @Override

   public final String getFormattedUnitSymbol()

   {

     return unitSymbol;

   }

   @Override

   public final String getConversion()

   {

     return formula;

   }

   @Override

   public final void setUnitSeparator(final String symbol)

   {

     unitSymbol = unitSymbol.replaceAll("\\*", symbol);

     toUnitSymbol = toUnitSymbol.replaceAll("\\*", symbol);

   }

 }