com.hfg.units.MeasurementSystem Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com_hfg Show documentation
com.hfg xml, html, svg, and bioinformatics utility library
There is a newer version: 20240423
package com.hfg.units;

import java.util.Map;
import java.util.Set;

import com.hfg.util.CompareUtil;
import com.hfg.util.StringUtil;
import com.hfg.util.collection.OrderedSet;

//------------------------------------------------------------------------------
/**
 Base class for systems of units.
 
 @author J. Alex Taylor, hairyfatguy.com
 
 */
//------------------------------------------------------------------------------
// com.hfg XML/HTML Coding Library
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
// J. Alex Taylor, President, Founder, CEO, COO, CFO, OOPS hairyfatguy.com
// [email protected]
//------------------------------------------------------------------------------

public abstract class MeasurementSystem implements Comparable
{
   private String mName;
   private String mAbbrev;

   public static final MeasurementSystem SI              = SI_System.getInstance();
   public static final MeasurementSystem Metric          = MetricSystem.getInstance();
   public static final MeasurementSystem BritishImperial = BritishImperialSystem.getInstance();

   //---------------------------------------------------------------------------
   protected MeasurementSystem(String inName, String inAbbrev)
   {
      mName = inName;
      mAbbrev = inAbbrev;
   }

   //---------------------------------------------------------------------------
   @Override
   public boolean equals(Object inObj2)
   {
      return (inObj2 != null
            && inObj2 instanceof MeasurementSystem
            && 0 == compareTo((MeasurementSystem) inObj2));
   }

   //---------------------------------------------------------------------------
   @Override
   public int hashCode()
   {
      int hashCode = name().hashCode();

      return hashCode;
   }

   //---------------------------------------------------------------------------
   public int compareTo(Object inObj2)
   {
      int result = -1;
      if (inObj2 != null)
      {
         if (inObj2 instanceof MeasurementSystem)
         {
            MeasurementSystem system2 = (MeasurementSystem) inObj2;

            result = CompareUtil.compare(name(), system2.name());
         }
      }

      return result;
   }

   //---------------------------------------------------------------------------
   public Unit getBaseUnit(QuantityType inQuantityType)
   {
      Unit baseUnit = getBaseUnitMap().get(inQuantityType);

      if (null == baseUnit)
      {
         throw new RuntimeException("Unrecognized quantity " + StringUtil.singleQuote(inQuantityType) + "!");
      }

      return baseUnit;
   }

   //---------------------------------------------------------------------------
   public Set getBaseUnits()
   {
      return new OrderedSet<>(getBaseUnitMap().values());
   }

   //---------------------------------------------------------------------------
   public String name()
   {
      return mName;
   }

   //---------------------------------------------------------------------------
   public String getAbbrev()
   {
      return mAbbrev;
   }

   //---------------------------------------------------------------------------
   @Override
   public String toString()
   {
      return getAbbrev();
   }

   protected abstract Map getBaseUnitMap();
}