package org.opentrafficsim.imb.kpi;

import org.opentrafficsim.kpi.interfaces.RouteDataInterface;

/**
 * <p>
 * Copyright (c) 2013-2019 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
 * BSD-style license. See <a href="http://opentrafficsim.org/node/13">OpenTrafficSim License</a>.
 * <p>
 * @version $Revision$, $LastChangedDate$, by $Author$, initial version 13 okt. 2016 <br>
 * @author <a href="http://www.tbm.tudelft.nl/averbraeck">Alexander Verbraeck</a>
 * @author <a href="http://www.tudelft.nl/pknoppers">Peter Knoppers</a>
 * @author <a href="http://www.transport.citg.tudelft.nl">Wouter Schakel</a>
 */
public class RouteData implements RouteDataInterface
{
    /** Route name. */
    private final String routeName;

    /** Route start. */
    private final NodeData startNode;

    /** Route end. */
    private final NodeData endNode;

    /**
     * @param routeName String; name of the route
     * @param startNode NodeData; data of the start node of the route
     * @param endNode NodeData; data of the end node of the route
     */
    public RouteData(String routeName, NodeData startNode, NodeData endNode)
    {
        super();
        this.routeName = routeName;
        this.startNode = startNode;
        this.endNode = endNode;
    }

    /**
     * @return routeName
     */
    public final String getRouteName()
    {
        return this.routeName;
    }

    /**
     * @return startNode
     */
    public final NodeData getStartNode()
    {
        return this.startNode;
    }

    /**
     * @return endNode
     */
    public final NodeData getEndNode()
    {
        return this.endNode;
    }

    /** {@inheritDoc} */
    @Override
    public String getId()
    {
        return getRouteName();
    }

    /** {@inheritDoc} */
    @Override
    public int hashCode()
    {
        final int prime = 31;
        int result = 1;
        result = prime * result + ((this.routeName == null) ? 0 : this.routeName.hashCode());
        return result;
    }

    /** {@inheritDoc} */
    @Override
    public boolean equals(Object obj)
    {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (getClass() != obj.getClass())
            return false;
        RouteData other = (RouteData) obj;
        if (this.routeName == null)
        {
            if (other.routeName != null)
                return false;
        }
        else if (!this.routeName.equals(other.routeName))
            return false;
        return true;
    }

    /** {@inheritDoc} */
    @Override
    public String toString()
    {
        return "RouteData [routeName=" + this.routeName + ", startNode=" + this.startNode + ", endNode=" + this.endNode + "]";
    }

}