com.hfg.network.Edge 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.network;

import com.hfg.util.CompareUtil;

//------------------------------------------------------------------------------
/**
 Representation of a network edge.
 
  @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 Edge implements Comparable
{
   public T mFrom;
   public T mTo;

   public Float mDistance;


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

   //--------------------------------------------------------------------------
   public Edge(T inFrom, T inTo)
   {
      mFrom = inFrom;
      mTo   = inTo;
   }

   //--------------------------------------------------------------------------
   public Edge(T inFrom, T inTo, Float inDistance)
   {
      this(inFrom, inTo);
      mDistance = inDistance;
   }

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

   //--------------------------------------------------------------------------
   @Override
   public String toString()
   {
      return mFrom + " --> " + mTo + ": " + mDistance;
   }

   //--------------------------------------------------------------------------
   public Edge setFrom(T inValue)
   {
      mFrom = inValue;
      return this;
   }

   //--------------------------------------------------------------------------
   public T getFrom()
   {
      return mFrom;
   }

   //--------------------------------------------------------------------------
   public Edge setTo(T inValue)
   {
      mTo = inValue;
      return this;
   }

   //--------------------------------------------------------------------------
   public T getTo()
   {
      return mTo;
   }

   //--------------------------------------------------------------------------
   public Float getDistance()
   {
      return mDistance;
   }

   //--------------------------------------------------------------------------
   public Edge setDistance(Float inValue)
   {
      mDistance = inValue;
      return this;
   }

   //--------------------------------------------------------------------------
   public void switchDirection()
   {
      T tmp = mTo;
      mTo = mFrom;
      mFrom = tmp;
   }

   //--------------------------------------------------------------------------
   public int compareTo(Edge inEdge2)
   {
      int result = 0;

      if (inEdge2 != null)
      {
         result = CompareUtil.compare(getDistance(), inEdge2.getDistance());
      }
      else
      {
         result = -1;
      }

      return result;
   }
}