com.hfg.math.RelationalOperator 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.math;


import java.util.Collection;
import java.util.Map;

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

//------------------------------------------------------------------------------
/**
 Enumeration of standard mathematical relational operators.
 
 @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 class RelationalOperator implements Comparable
{
   private String mSymbol;
   private String mShortName;
   private int    mIndex;


   private static int sIndexSrc = 1;
   private static Map sValueMap = new OrderedMap<>(6);

   public static final RelationalOperator EQUALS     = new RelationalOperator("=", "EQ");
   public static final RelationalOperator NOT_EQUALS = new RelationalOperator("!=", "NE");
   public static final RelationalOperator LESS_THAN    = new RelationalOperator("<", "LT");
   public static final RelationalOperator GREATER_THAN = new RelationalOperator(">", "GT");
   public static final RelationalOperator LESS_THAN_OR_EQUAL_TO = new RelationalOperator("<=", "LE");
   public static final RelationalOperator GREATER_THAN_OR_EQUAL_TO = new RelationalOperator(">=", "GE");

   //###########################################################################
   // CONSTRUCTORS
   //###########################################################################

   //---------------------------------------------------------------------------
   private RelationalOperator(String inSymbol, String inShortName)
   {
      mSymbol = inSymbol;
      mShortName = inShortName;
      mIndex = sIndexSrc++;
      sValueMap.put(inSymbol, this);
      sValueMap.put(inShortName, this);
   }

   //###########################################################################
   // PUBLIC METHODS
   //###########################################################################

   //---------------------------------------------------------------------------
   public static Collection values()
   {
      return new OrderedSet(sValueMap.values());
   }

   //---------------------------------------------------------------------------
   public static RelationalOperator valueOf(String inString)
   {
      return sValueMap.get(inString);
   }

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

   //---------------------------------------------------------------------------
   public String getShortName()
   {
      return mShortName;
   }

   //--------------------------------------------------------------------------
   @Override
   public boolean equals(Object inObj2)
   {
      boolean result = false;

      if (inObj2 != null
            && inObj2 instanceof RelationalOperator)
      {
         result = (0 == compareTo((RelationalOperator) inObj2));
      }

      return result;
   }

   //--------------------------------------------------------------------------
   @Override
   public int compareTo(RelationalOperator inObj2)
   {
      int result = -1;

      if (inObj2 != null)
      {
         result = 0;

         if (this != inObj2)
         {
            result = CompareUtil.compare(mIndex, inObj2.mIndex);
         }
      }

      return result;
   }

   //--------------------------------------------------------------------------
   @Override
   public final int hashCode()
   {
      return mIndex;
   }

}