package org.opentrafficsim.road.network.factory.vissim;
   
   import java.io.Serializable;
   import java.util.ArrayList;
   import java.util.List;
   
   import org.opentrafficsim.core.network.NetworkException;
   import org.opentrafficsim.core.network.route.Route;
   import org.w3c.dom.NamedNodeMap;
  import org.w3c.dom.Node;
  import org.w3c.dom.NodeList;
  import org.xml.sax.SAXException;
  
  /**
   * <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/docs/license.html">OpenTrafficSim License</a>.
   * <p>
   * $LastChangedDate: 2019-01-06 01:39:32 +0100 (Sun, 06 Jan 2019) $, @version $Revision: 4833 $, by $Author: averbraeck $,
   * initial version Jul 23, 2015 <br>
   * @author <a href="http://www.tbm.tudelft.nl/averbraeck">Alexander Verbraeck</a>
   */
  class RouteTag implements Serializable
  {
      /** */
      private static final long serialVersionUID = 20150723L;
  
      /** Name. */
      @SuppressWarnings("checkstyle:visibilitymodifier")
      String name = null;
  
      /** Nodes. */
      @SuppressWarnings("checkstyle:visibilitymodifier")
      List<NodeTag> routeNodeTags = new ArrayList<NodeTag>();
  
      /** Route that has been generated. */
      @SuppressWarnings("checkstyle:visibilitymodifier")
      Route route;
  
      /**
       * Parse the ROUTE tag.
       * @param nodeList NodeList; nodeList the top-level nodes of the XML-file
       * @param parser VissimNetworkLaneParser; the parser with the lists of information
       * @throws SAXException when parsing of the tag fails
       * @throws NetworkException when parsing of the tag fails
       */
      @SuppressWarnings("checkstyle:needbraces")
      static void parseRoutes(final NodeList nodeList, final VissimNetworkLaneParser parser) throws SAXException, NetworkException
      {
          for (Node node : XMLParser.getNodes(nodeList, "ROUTE"))
          {
              NamedNodeMap attributes = node.getAttributes();
              RouteTag routeTag = new RouteTag();
  
              if (attributes.getNamedItem("NAME") == null)
              {
                  throw new SAXException("ROUTE: missing attribute NAME");
              }
              routeTag.name = attributes.getNamedItem("NAME").getNodeValue().trim();
              if (parser.getRouteTags().keySet().contains(routeTag.name))
              {
                  throw new SAXException("ROUTE: NAME " + routeTag.name + " defined twice");
              }
  
              if (attributes.getNamedItem("NODELIST") == null)
              {
                  throw new SAXException("ROUTE " + routeTag.name + ": missing attribute NODELIST");
              }
              String routeNodes = attributes.getNamedItem("NODELIST").getNodeValue().trim();
              routeTag.routeNodeTags = NodeTag.parseNodeList(routeNodes, parser);
  
              parser.getRouteTags().put(routeTag.name, routeTag);
          }
      }
  
      /**
       * Make the route based on the nodes. This method should be called after the Nodes have been created from the NodeTags.
       * @throws NetworkException when node cannot be added.
       */
      void makeRoute() throws NetworkException
      {
          this.route = new Route(this.name);
          for (NodeTag nodeTag : this.routeNodeTags)
          {
              this.route.addNode(nodeTag.node);
          }
      }
  
      /** {@inheritDoc} */
      @Override
      public final String toString()
      {
          return "RouteTag [name=" + this.name + ", routeNodeTags=" + this.routeNodeTags + ", route=" + this.route + "]";
      }
  }