com.hfg.citation.ncbi.MeshHeading 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.citation.ncbi;

//------------------------------------------------------------------------------

import java.util.HashSet;
import java.util.Set;

import com.hfg.util.CompareUtil;

/**
 Medical Subject Heading (MeSH®) value. MeSH headings are used to characterize
 the contents of MEDLINE citations.
 
 @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 MeshHeading implements Comparable
{
   private String  mValue;
   private String  mUniqueIdentifier;
   private Boolean mIsMajorTopic;
   private Set mQualifiers;


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

   //---------------------------------------------------------------------------
   public MeshHeading(String inValue)
   {
      mValue = inValue;
   }

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

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

   //---------------------------------------------------------------------------
   @Override
   public boolean equals(Object inObj2)
   {
      return (0 == compareTo(inObj2));
   }

   //---------------------------------------------------------------------------
   @Override
   public int hashCode()
   {
      int result = 1;

      if (getValue() != null)
      {
         result = getValue().hashCode();
      }

      return result;
   }

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

      if (inObj2 != null
          && inObj2 instanceof MeshHeading)
      {
         result = CompareUtil.compare(getValue(), ((MeshHeading) inObj2).getValue());
      }

      return result;
   }



   //---------------------------------------------------------------------------
   public String getValue()
   {
      return mValue;
   }


   //---------------------------------------------------------------------------
   public MeshHeading setUniqueIdentifier(String inValue)
   {
      mUniqueIdentifier = inValue;
      return this;
   }

   //---------------------------------------------------------------------------
   public String getUniqueIdentifier()
   {
      return mUniqueIdentifier;
   }


   //---------------------------------------------------------------------------
   public MeshHeading setIsMajorTopic(boolean inValue)
   {
      mIsMajorTopic = inValue;
      return this;
   }

   //---------------------------------------------------------------------------
   public Boolean isMajorTopic()
   {
      return mIsMajorTopic;
   }


   //---------------------------------------------------------------------------
   public MeshHeading addQualifier(MeshQualifier inValue)
   {
      if (null == mQualifiers)
      {
         mQualifiers = new HashSet<>(3);
      }

      mQualifiers.add(inValue);
      return this;
   }

   //---------------------------------------------------------------------------
   public Set getQualifiers()
   {
      return mQualifiers;
   }
}