com.hfg.bio.DbXref 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.bio;



import com.hfg.util.CompareUtil;

//------------------------------------------------------------------------------
/**
 * Simple container for a database cross-reference.
 * 
 *  @author J. Alex Taylor, hairyfatguy.com
 * 
 * */
//------------------------------------------------------------------------------
// com.hfg 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 DbXref implements Comparable
{
   private String mDB;
   private String mId;
   private String mDescription;

   //--------------------------------------------------------------------------
   public DbXref(String inDB, String inId)
   {
      mDB = inDB;
      mId = inId;
   }

   //--------------------------------------------------------------------------
   public String getDB()
   {
      return mDB;
   }

   //--------------------------------------------------------------------------
   public String getId()
   {
      return mId;
   }

   //--------------------------------------------------------------------------
   public DbXref setDescription(String inValue)
   {
      mDescription = inValue;
      return this;
   }

   //--------------------------------------------------------------------------
   public String getDescription()
   {
      return mDescription;
   }

   //--------------------------------------------------------------------------
   @Override
   public String toString()
   {
      return mDB + ":" + mId;
   }

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

   //---------------------------------------------------------------------------
   @Override
   public int hashCode()
   {
      return toString().hashCode();
   }

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

      if (inObj2 != null)
      {
         result = CompareUtil.compare(toString(), inObj2.toString());
      }

      return result;
   }
}