package org.opentrafficsim.road.network.factory.xml;
   
   import java.io.Serializable;
   import java.rmi.RemoteException;
   import java.util.ArrayList;
   import java.util.List;
   
   import javax.naming.NamingException;
   
  import org.djunits.value.vdouble.scalar.Angle;
  import org.djunits.value.vdouble.scalar.Direction;
  import org.opentrafficsim.core.geometry.OTSPoint3D;
  import org.opentrafficsim.core.network.NetworkException;
  import org.opentrafficsim.core.network.OTSNode;
  import org.opentrafficsim.core.network.animation.NodeAnimation;
  import org.opentrafficsim.core.network.factory.xml.units.AngleUnits;
  import org.opentrafficsim.core.network.factory.xml.units.Coordinates;
  import org.w3c.dom.NamedNodeMap;
  import org.w3c.dom.Node;
  import org.w3c.dom.NodeList;
  import org.xml.sax.SAXException;
  
  import nl.tudelft.simulation.language.Throw;
  
  /**
   * <p>
   * Copyright (c) 2013-2018 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: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $,
   * initial version Jul 23, 2015 <br>
   * @author <a href="http://www.tbm.tudelft.nl/averbraeck">Alexander Verbraeck</a>
   */
  class NodeTag implements Serializable
  {
      /** */
      private static final long serialVersionUID = 20150723L;
  
      /** Name. */
      @SuppressWarnings("checkstyle:visibilitymodifier")
      String name = null;
  
      /** Coordinate (null at first, can be calculated later when connected to a link. */
      @SuppressWarnings("checkstyle:visibilitymodifier")
      OTSPoint3D coordinate = null;
  
      /** Absolute angle of the node. 0 is "East", pi/2 = "North". */
      @SuppressWarnings("checkstyle:visibilitymodifier")
      Direction angle = null;
  
      /** TODO slope as an angle. */
      @SuppressWarnings("checkstyle:visibilitymodifier")
      Angle slope = null;
  
      /** The calculated Node, either through a coordinate or after calculation. */
      @SuppressWarnings("checkstyle:visibilitymodifier")
      OTSNode node = null;
  
      /**
       * @param nodeList nodeList the top-level nodes of the XML-file
       * @param parser the parser with the lists of information
       * @throws SAXException when parsing of GTU tag fails
       * @throws NetworkException when parsing of GTU tag fails
       */
      @SuppressWarnings("checkstyle:needbraces")
      static void parseNodes(final NodeList nodeList, final XmlNetworkLaneParser parser) throws SAXException, NetworkException
      {
          for (Node node : XMLParser.getNodes(nodeList, "NODE"))
          {
              NamedNodeMap attributes = node.getAttributes();
              NodeTag nodeTag = new NodeTag();
  
              Node name = attributes.getNamedItem("NAME");
              if (name == null)
                  throw new SAXException("NODE: missing attribute NAME");
              nodeTag.name = name.getNodeValue().trim();
              if (parser.nodeTags.keySet().contains(nodeTag.name))
                  throw new SAXException("NODE: NAME " + nodeTag.name + " defined twice");
  
              if (attributes.getNamedItem("COORDINATE") != null)
                  nodeTag.coordinate = Coordinates.parseCoordinate(attributes.getNamedItem("COORDINATE").getNodeValue());
  
              if (attributes.getNamedItem("ANGLE") != null)
                  nodeTag.angle = AngleUnits.parseDirection(attributes.getNamedItem("ANGLE").getNodeValue());
  
              // TODO slope for the Node.
  
              parser.nodeTags.put(nodeTag.name, nodeTag);
  
              if (nodeTag.coordinate != null && nodeTag.angle != null)
              {
                  // only make a node if we know the coordinate and angle. Otherwise, wait till we can calculate it.
                  try
                  {
                      makeOTSNode(nodeTag, parser);
                  }
                  catch (NamingException exception)
                  {
                      throw new NetworkException(exception);
                 }
             }
         }
     }
 
     /**
      * Parse a list of Nodes, e.g. for a ROUTE.
      * @param nodeNames the space separated String with the node names
      * @param parser the parser with the lists of information
      * @return a list of NodeTags
      * @throws SAXException when parsing of the tag fails
      * @throws NetworkException when parsing of the tag fails
      */
     static List<NodeTag> parseNodeList(final String nodeNames, final XmlNetworkLaneParser parser)
             throws SAXException, NetworkException
     {
         List<NodeTag> nodeList = new ArrayList<>();
         String[] ns = nodeNames.split("\\s");
         for (String s : ns)
         {
             if (!parser.nodeTags.containsKey(s))
             {
                 throw new SAXException("Node " + s + " from node list [" + nodeNames + "] was not defined");
             }
             nodeList.add(parser.nodeTags.get(s));
         }
         return nodeList;
 
     }
 
     /**
      * @param nodeTag the tag with the info for the node.
      * @param parser the parser with the lists of information
      * @return a constructed node
      * @throws NetworkException when point cannot be instantiated
      * @throws NamingException when animation context cannot be found.
      */
     static OTSNode makeOTSNode(final NodeTag nodeTag, final XmlNetworkLaneParser parser)
             throws NetworkException, NamingException
     {
         Throw.whenNull(nodeTag.angle, "NodeTag: " + nodeTag.name + " angle == null");
         String id = nodeTag.name;
         Direction angle = nodeTag.angle;
         Angle slope = nodeTag.slope == null ? Angle.ZERO : nodeTag.slope;
         OTSNode node = new OTSNode(parser.network, id, nodeTag.coordinate, angle, slope);
         nodeTag.node = node;
 
         try
         {
             new NodeAnimation(nodeTag.node, parser.simulator);
         }
         catch (RemoteException exception)
         {
             exception.printStackTrace();
         }
 
         return node;
     }
 
     /** {@inheritDoc} */
     @Override
     public String toString()
     {
         return "NodeTag [name=" + this.name + ", coordinate=" + this.coordinate + ", node=" + this.node + "]";
     }
 
 }