net.sf.javagimmicks.graph.routing.DefaultRoute Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gimmicks Show documentation

Utility classes, APIs and tools for Java

There is a newer version: 0.99-alpha1

package net.sf.javagimmicks.graph.routing;

import java.util.ArrayList;
import java.util.Iterator;

import net.sf.javagimmicks.graph.Edge;
import net.sf.javagimmicks.graph.WeightedEdge;

/**
 * A simple default {@link Route} implementation based on an {@link ArrayList}
 * that can automatically calculate the {@link #getCost() cost}.
 */
public class DefaultRoute> extends ArrayList
      implements Route
{
   private static final long serialVersionUID = 8309167375893037566L;

   protected final VertexType _source;
   protected final VertexType _target;

   /**
    * Creates a new instance for the given source and target vertex.
    * 
    * @param source
    *           the source vertex for this instance
    * @param target
    *           the target vertex for this instance
    */
   public DefaultRoute(final VertexType source, final VertexType target)
   {
      _source = source;
      _target = target;
   }

   @Override
   public double getCost()
   {
      double cost = 0.0;

      for (final EdgeType edge : this)
      {
         cost += (edge instanceof WeightedEdge) ?
               ((WeightedEdge) edge).getCost() : 1.0;
      }

      return cost;
   }

   @Override
   public VertexType getSourceVertex()
   {
      return _source;
   }

   @Override
   public VertexType getTargetVertex()
   {
      return _target;
   }

   @Override
   public String toString()
   {
      final StringBuilder result = new StringBuilder()
            .append(_source)
            .append("->")
            .append(_target);

      if (!isEmpty())
      {
         result.append(" (");

         final Iterator edgeIterator = iterator();
         VertexType source = _source;
         EdgeType edge = edgeIterator.next();

         result.append(edge.toString(_source));

         while (edgeIterator.hasNext())
         {
            source = edge.getOutgoingVertex(source);
            edge = edgeIterator.next();
            result.append(", ").append(edge.toString(source));
         }

         result.append(")");
      }

      return result
            .append(" / Overall cost: ")
            .append(getCost())
            .toString();
   }
}