/*
    * @(#)ProductParser.java Aug 18, 2003
    * 
    * 
    * Copyright (c) 2003-2005 Delft University of Technology, Jaffalaan 5, 2628 BX
    * Delft, the Netherlands. All rights reserved.
    * 
    * See for project information <a href="http://www.simulation.tudelft.nl/">
    * www.simulation.tudelft.nl </a>.
   * 
   * The source code and binary code of this software is proprietary information
   * of Delft University of Technology.
   */
  package org.gscg.experiment;
  
  import java.io.IOException;
  import java.net.URL;
  import java.util.List;
  
  import nl.tudelft.simulation.logger.Logger;
  import nl.tudelft.simulation.supplychain.product.BillOfMaterials;
  import nl.tudelft.simulation.supplychain.product.Product;
  import nl.tudelft.simulation.supplychain.product.Unit;
  
  import org.jdom.Element;
  import org.jdom.Namespace;
  import org.jdom.input.SAXBuilder;
  
  /***
   * The ProductParser parses xml-based experiments into their java objects.
   * <p>
   * 
   * Copyright (c) 2003-2005 Delft University of Technology, Jaffalaan 5, 2628 BX
   * Delft, the Netherlands. All rights reserved.
   * 
   * See for project information <a href="http://www.simulation.tudelft.nl/">
   * www.simulation.tudelft.nl </a>.
   * 
   * The source code and binary code of this software is proprietary information
   * of Delft University of Technology.
   * 
   * @author <a
   *         href="http://www.tbm.tudelft.nl/webstaf/stijnh/index.htm">Stijn-Pieter
   *         van Houten </a>
   * @version $Revision: 1.2 $ $Date: 2005/08/09 15:43:40 $
   * @since 1.0.0
   */
  public class ProductParser
  {
  
  	/*** builder the xerces parser with validation turned on */
  	private static SAXBuilder builder = new SAXBuilder(
  			"org.apache.xerces.parsers.SAXParser", false);
  	static
  	{
  		// turns on Schema Validation with Xerces
  		builder.setFeature("http://xml.org/sax/features/validation", true);
  		builder.setFeature("http://apache.org/xml/features/validation/schema",
  				true);
  	}
  
  	/*** for debugging */
  	private static final boolean DEBUG = true;
  
  	/***
  	 * constructs a new ProductParser This is a Utility Class.
  	 */
  	protected ProductParser()
  	{
  		// A utility class should not be instantiated
  	}
  
  	/***
  	 * parses a product xml-file.
  	 * 
  	 * @param schema the schema for validation of the xml-file
  	 * @param input the inputstream
  	 * @return Scenario the experiment
  	 * @throws IOException whenever parsing fails
  	 */
  	public static Products parseProducts(final String schema, final URL input)
  			throws IOException
  	{
  		builder
  				.setProperty(
  						"http://apache.org/xml/properties/schema/external-schemaLocation",
  						"http://www.simulation.tudelft.nl " + schema);
  		try
  		{
  			Element rootElement = builder.build(input).getRootElement();
  			Products products = new Products();
  
  			List elements = rootElement.getChildren();
  
  			for (int i = 0; i < elements.size(); i++)
  			{
  				Product product = ProductParser.parseProduct((Element) elements
  						.get(i));
  				if (!Products.addProduct(product))
 				{
 					Logger
 							.severe(
 									ProductParser.class,
 									"parseProducts",
 									"ProductParser was unable to add product with name: "
 											+ product.getName()
 											+ ". Probably there is already a product with the same name. Check the .xml description.");
 				}
 			}
 			return products;
 		} catch (Exception exception)
 		{
 			Logger.warning(ProductParser.class, "parseExperiment", exception);
 			throw new IOException(exception.getMessage());
 		}
 	}
 
 	// *********************** PRIVATE PARSING FUNCTIONS *******************//
 
 	/***
 	 * parses the product
 	 * 
 	 * @param element the xml-element
 	 * @return Product
 	 * @throws Exception on failure
 	 */
 	private static Product parseProduct(final Element element) throws Exception
 	{
 		String name = null;
 		Unit unit = null;
 		double baseprice = Double.NaN;
 		double averageUnitWeight = Double.NaN;
 		double depreciation = Double.NaN;
 
 		if (element.getName().equalsIgnoreCase("productwithoutbom"))
 		{
 			Namespace space = element.getNamespace();
 			if (element.getChild("name", space) != null)
 			{
 				name = (element.getChildText("name", space));
 			}
 			if (element.getChild("unit", space) != null)
 			{
 				unit = ProductParser.parseUnit(element.getChildText("unit"));
 			}
 			if (element.getChild("baseprice", space) != null)
 			{
 				baseprice = new Double(element.getChildText("baseprice"))
 						.doubleValue();
 			}
 			if (element.getChild("averageunitweight", space) != null)
 			{
 				averageUnitWeight = new Double(element
 						.getChildText("averageunitweight")).doubleValue();
 			}
 			if (element.getChild("depreciation", space) != null)
 			{
 				depreciation = new Double(element.getChildText("depreciation"))
 						.doubleValue();
 			}
 			return new Product(name, unit, baseprice, averageUnitWeight,
 					depreciation);
 		}
 		if (element.getName().equalsIgnoreCase("productwithbom"))
 		{
 			Namespace space = element.getNamespace();
 			if (element.getChild("name", space) != null)
 			{
 				name = (element.getChildText("name", space));
 			}
 			if (element.getChild("unit", space) != null)
 			{
 				unit = ProductParser.parseUnit(element.getChildText("unit"));
 			}
 			if (element.getChild("baseprice", space) != null)
 			{
 				baseprice = new Double(element.getChildText("baseprice"))
 						.doubleValue();
 			}
 			if (element.getChild("averageunitweight", space) != null)
 			{
 				averageUnitWeight = new Double(element
 						.getChildText("averageunitweight")).doubleValue();
 			}
 			if (element.getChild("depreciation", space) != null)
 			{
 				depreciation = new Double(element.getChildText("depreciation"))
 						.doubleValue();
 			}
 
 			Product productWithBom = new Product(name, unit, baseprice,
 					averageUnitWeight, depreciation);
 			Element bomElement = element.getChild("bom");
 			List productsForBom = bomElement.getChildren("product");
 			BillOfMaterials bom = new BillOfMaterials(productWithBom);
 
 			for (int ii = 0; ii < productsForBom.size(); ii++)
 			{
 				Element bomProductElement = (Element) productsForBom.get(ii);
 				String bomProductName = null;
 				Product bomProduct = null;
 				double bomProductAmount = Double.NaN;
 				bomProductName = bomProductElement.getChildText("product",
 						space);
 				bomProductAmount = new Double(bomProductElement.getChildText(
 						"amount", space)).doubleValue();
 				bomProduct = Products.getProduct(bomProductName);
 				if (ProductParser.DEBUG)
 				{
 					System.out
 							.println("DEBUG -- ProductParser: bomProduct found: "
 									+ bomProduct);
 				}
 				// add the bom product to the bom
 				bom.add(bomProduct, bomProductAmount);
 			}
 			// set the bom
 			productWithBom.setBillOfMaterials(bom);
 			if (ProductParser.DEBUG)
 			{
 				System.out.println("DEBUG -- ProductParser: bom created: "
 						+ bom);
 			}
 			return productWithBom;
 		}
 		return null;
 	}
 
 	/***
 	 * Parses a string representing a unit into a unit
 	 * 
 	 * @param name the name of the unit
 	 * @return returns a unit based on the name
 	 * @throws Exception thrown in case of an unknown name
 	 */
 	public static Unit parseUnit(final String name) throws Exception
 	{
 		if (name.equals("BOX"))
 		{
 			return Unit.BOX;
 		}
 		if (name.equals("CONTAINER 20FT"))
 		{
 			return Unit.CONTAINER20FT;
 		}
 		if (name.equals("CONTAINER 40FT"))
 		{
 			return Unit.CONTAINER40FT;
 		}
 		if (name.equals("KG"))
 		{
 			return Unit.KG;
 		}
 		if (name.equals("M3"))
 		{
 			return Unit.M3;
 		}
 		if (name.equals("PALLET"))
 		{
 			return Unit.PALLET;
 		}
 		if (name.equals("PIECE"))
 		{
 			return Unit.PIECE;
 		}
 		throw new Exception("ProductParser: parseUnit.. unknown argument: "
 				+ name);
 	}
 }