/*
    * @(#) IntrospectionUtil.java Jan 24, 2005
    * 
    * 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.gameleader.interactionlayer.util;
  
  import java.io.Serializable;
  import java.lang.reflect.Field;
  import java.text.DateFormat;
  import java.util.ArrayList;
  import java.util.Calendar;
  import java.util.List;
  
  import nl.tudelft.simulation.actor.ActorInterface;
  import nl.tudelft.simulation.dsol.experiment.TimeUnit;
  import nl.tudelft.simulation.dsol.experiment.TimeUnitInterface;
  import nl.tudelft.simulation.dsol.simulators.SimulatorInterface;
  import nl.tudelft.simulation.language.reflection.ClassUtil;
  import nl.tudelft.simulation.logger.Logger;
  import nl.tudelft.simulation.supplychain.actor.SupplyChainActor;
  import nl.tudelft.simulation.supplychain.actor.Trader;
  import nl.tudelft.simulation.supplychain.banking.BankAccount;
  import nl.tudelft.simulation.supplychain.content.Bill;
  import nl.tudelft.simulation.supplychain.content.Content;
  import nl.tudelft.simulation.supplychain.content.Order;
  import nl.tudelft.simulation.supplychain.content.OrderBasedOnQuote;
  import nl.tudelft.simulation.supplychain.content.OrderConfirmation;
  import nl.tudelft.simulation.supplychain.content.Payment;
  import nl.tudelft.simulation.supplychain.content.Quote;
  import nl.tudelft.simulation.supplychain.content.RequestForQuote;
  import nl.tudelft.simulation.supplychain.content.Shipment;
  import nl.tudelft.simulation.supplychain.product.Product;
  //import nl.tudelft.simulation.supplychain.reference.Manufacturer;
  import org.gscg.gameactors.GameDistributorInteractive;
  import org.gscg.gameleader.animation2D.mouse.IntrospectedFieldData;
  import org.gscg.gameleader.animation2D.mouse.IntrospectionData;
  
  /***
   * Utility class for introspection. This class contains methods which either
   * introspect an object and return date for the fields, or updates the values of
   * atributes based on changes made to an object using the introspection diaglog
   * of an animation panel.
   * <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.3 $ $Date: 2005/08/10 11:23:30 $
   * @since 1.1.2
   */
  public final class IntrospectionUtil implements Serializable
  {
  	/*** the serial version uid */
  	private static final long serialVersionUID = 11L;
  
  	/*** the balance field */
  	private static Field balanceField = null;
  
  	/*** the calendar */
  	private static Calendar calendar = Calendar.getInstance();
  
  	/*** the date formatter */
  	private static DateFormat dateFormat = DateFormat.getDateInstance();
  
  	/*** the start time of the simulator */
  	private static long startTime = 0L;
  
  	/*** the time unit of the simulator */
  	private static TimeUnitInterface timeUnit = null;
  
  	/*** initialize the field */
  	static
  	{
  		try
  		{
  			IntrospectionUtil.balanceField = ClassUtil.resolveField(
  					BankAccount.class, "balance");
  			balanceField.setAccessible(true);
  		} catch (Exception exception)
  		{
  			Logger.severe(IntrospectionUtil.class, "<class>", exception);
  		}
  	}
 
 	/***
 	 * constructs a new IntrospectionUtil
 	 */
 	private IntrospectionUtil()
 	{
 		// Utility classes should not be instantiated
 		super();
 	}
 
 	/***
 	 * Introspects the given object
 	 * 
 	 * @param object the object to get the data from
 	 * @param key the key
 	 * @return Returns an array of introspection data or null if there is no
 	 *         logic to process the object
 	 */
 	public static IntrospectionData introspectObject(final Object object,
 			final Serializable key)
 	{
 		if (object != null)
 		{
 			List fields = new ArrayList();
 			String name = null;
 			// determine the class of the object
 			if (object instanceof ActorInterface)
 			{
 				name = "Dialog for actor: "
 						+ ((ActorInterface) object).getName();
 				if (GameDistributorInteractive.class.isAssignableFrom(object
 								.getClass())
 						|| Trader.class.isAssignableFrom(object.getClass()))
 				{
 					IntrospectionUtil.introspectSupplyChainActor(
 							(SupplyChainActor) object, fields);
 					// add some stock info
 
 					// add info field
 					// the ## are used to indicate that we are dealing with an
 					// info field
 					fields.add(new IntrospectedFieldData("Stock Info", "##",
 							false));
 					List products = ((Trader) object).getProductsOnStock();
 					for (int i = 0; i < products.size(); i++)
 					{
 						fields.add(new IntrospectedFieldData("Product: "
 								+ ((Product) products.get(i)).getName(),
 								new Double(((Trader) object).getStock()
 										.getActualAmount(
 												(Product) products.get(i))),
 								true));
 					}
 				} else
 				{
 					IntrospectionUtil.introspectSupplyChainActor(
 							(SupplyChainActor) object, fields);
 				}
 			} else if (object instanceof Content)
 			{
 				IntrospectionUtil.introspectContent((Content) object, fields);
 				if (RequestForQuote.class.isAssignableFrom(object.getClass()))
 				{
 					name = "Dialog for Request for Quote";
 					RequestForQuote rfq = (RequestForQuote) object;
 					IntrospectionUtil.introspectRFQ(rfq, fields);
 				} else if (Quote.class.isAssignableFrom(object.getClass()))
 				{
 					name = "Dialog for Quote";
 					Quote quote = (Quote) object;
 					IntrospectionUtil.introspectRFQ(quote.getRequestForQuote(),
 							fields);
 					IntrospectionUtil.introspectQuote(quote, fields);
 				} else if (OrderBasedOnQuote.class.isAssignableFrom(object
 						.getClass()))
 				{
 					name = "Dialog for Order";
 					OrderBasedOnQuote order = (OrderBasedOnQuote) object;
 					IntrospectionUtil.introspectRFQ(order.getQuote()
 							.getRequestForQuote(), fields);
 					IntrospectionUtil.introspectQuote(order.getQuote(), fields);
 					IntrospectionUtil.introspectOrder(order, fields);
 				} else if (OrderConfirmation.class.isAssignableFrom(object
 						.getClass()))
 				{
 					name = "Dialog for Order Confirmation";
 					OrderConfirmation confirmation = (OrderConfirmation) object;
 					IntrospectionUtil.introspectRFQ(
 							((OrderBasedOnQuote) confirmation.getOrder())
 									.getQuote().getRequestForQuote(), fields);
 					IntrospectionUtil.introspectQuote(
 							((OrderBasedOnQuote) confirmation.getOrder())
 									.getQuote(), fields);
 					IntrospectionUtil.introspectOrder(
 							(confirmation.getOrder()), fields);
 					IntrospectionUtil.introspectOrderConfirmation(
 							(confirmation), fields);
 				} else if (Shipment.class.isAssignableFrom(object.getClass()))
 				{
 					name = "Dialog for Shipment";
 					Shipment shipment = (Shipment) object;
 					IntrospectionUtil.introspectRFQ(
 							((OrderBasedOnQuote) shipment.getOrder())
 									.getQuote().getRequestForQuote(), fields);
 					IntrospectionUtil.introspectQuote(
 							((OrderBasedOnQuote) shipment.getOrder())
 									.getQuote(), fields);
 					IntrospectionUtil.introspectOrder((shipment.getOrder()),
 							fields);
 				} else if (Bill.class.isAssignableFrom(object.getClass()))
 				{
 					name = "Dialog for Bill";
 					Bill bill = (Bill) object;
 					IntrospectionUtil.introspectRFQ(((OrderBasedOnQuote) bill
 							.getOrder()).getQuote().getRequestForQuote(),
 							fields);
 					IntrospectionUtil.introspectQuote(((OrderBasedOnQuote) bill
 							.getOrder()).getQuote(), fields);
 					IntrospectionUtil
 							.introspectOrder((bill.getOrder()), fields);
 					IntrospectionUtil.introspectBill(bill, fields);
 				} else if (Payment.class.isAssignableFrom(object.getClass()))
 				{
 					name = "Dialog for Payment";
 					Payment payment = (Payment) object;
 					IntrospectionUtil.introspectRFQ(
 							((OrderBasedOnQuote) payment.getBill().getOrder())
 									.getQuote().getRequestForQuote(), fields);
 					IntrospectionUtil.introspectQuote(
 							((OrderBasedOnQuote) payment.getBill().getOrder())
 									.getQuote(), fields);
 					IntrospectionUtil.introspectOrder((payment.getBill()
 							.getOrder()), fields);
 					IntrospectionUtil.introspectBill(payment.getBill(), fields);
 					IntrospectionUtil.introspectPayment(payment, fields);
 				}
 			} else
 			{
 				Logger.severe(IntrospectionUtil.class, "introspectObject",
 						"No logic to introspect object of class:  "
 								+ object.getClass());
 				return null;
 			}
 
 			return new IntrospectionData(key, (IntrospectedFieldData[]) fields
 					.toArray(new IntrospectedFieldData[fields.size()]), name);
 		}
 		return null;
 	}
 
 	/***
 	 * Method updateIntrospectedObject updates an introspected object based on
 	 * the given data.
 	 * 
 	 * @param object the object to update
 	 * @param data the data
 	 */
 	public static void updateIntrospectedObject(final Object object,
 			final IntrospectionData data)
 	{
 		if (object != null)
 		{
 			IntrospectedFieldData[] fieldData = data.getData();
 			for (int i = 0; i < fieldData.length; i++)
 			{
 				if (fieldData[i].getName().equalsIgnoreCase("Balance"))
 				{
 					// resolve bank account balance field
 					BankAccount account = ((SupplyChainActor) object)
 							.getBankAccount();
 					try
 					{
 						double value = ((Number) (fieldData[i].getValue()))
 								.doubleValue();
 						value = 0.01 * Math.round(100.0 * value);
 						IntrospectionUtil.balanceField.set(account, new Double(
 								value));
 						account.sendBalanceUpdateEvent();
 					} catch (Exception exception)
 					{
 						exception.printStackTrace();
 						Logger.severe(IntrospectionUtil.class,
 								"updateIntrospectedObject", exception);
 					}
 				} else if (fieldData[i].getName().startsWith("Product: "))
 				{
 					String[] split = fieldData[i].getName().split(": ");
 					// the second part of the split contains the product name
 					String productName = split[1];
 
 					// look for the product
 					List products = ((Trader) object).getProductsOnStock();
 					for (int ii = 0; ii < products.size(); ii++)
 					{
 						Product product = (Product) products.get(ii);
 						if (product.getName().equalsIgnoreCase(productName))
 						{
 							double amount = ((Number) fieldData[i].getValue())
 									.doubleValue();
 							double currentAmount = ((Trader) object)
 									.getStock().getActualAmount(product);
 
 							// only change if there is a change
 							// otherwise a divide by 0 occurs
 							if (amount != currentAmount && amount >= 0)
 							{
 								((Trader) object).getStock().addStock(
 										product,
 										amount - currentAmount,
 										product.getUnitMarketPrice()
 												* (amount - currentAmount));
 								// send an update event
 								((Trader) object).getStock()
 										.sendStockUpdateEvent(product);
 							}
 							break;
 						}
 					}
 				} else
 				{
 					Logger.warning(IntrospectionUtil.class,
 							"updateIntrospectedObject",
 							"IntrospectionUtil: unknown field"
 									+ fieldData[i].getName());
 				}
 			}
 		} else
 		{
 			Logger.severe(IntrospectionUtil.class, "updateIntrospectedObject",
 					"Introspected object to update is null");
 		}
 	}
 
 	//
 	// private methods
 	//
 
 	/***
 	 * Introspects a supply chain actor object and adds fields to the list
 	 * 
 	 * @param actor the actor
 	 * @param fields the list with fields to edit
 	 */
 	private static void introspectSupplyChainActor(
 			final SupplyChainActor actor, final List fields)
 	{
 		// the ## are used to indicate that we are dealing with an info field
 		fields.add(new IntrospectedFieldData("General Info", "##", false));
 		fields.add(new IntrospectedFieldData("Name", actor.getName(), false));
 		fields.add(new IntrospectedFieldData("Location", "lat: "
 				+ actor.getLocation().y + " lon: " + actor.getLocation().x,
 				false));
 		fields.add(new IntrospectedFieldData("Place", actor
 				.getLocationDescription(), false));
 		// the ## are used to indicate that we are dealing with an info field
 		fields.add(new IntrospectedFieldData("Balance Info", "##", false));
 		fields.add(new IntrospectedFieldData("Balance", new Double(actor
 				.getBankAccount().getBalance()), true));
 	}
 
 	/***
 	 * Introspects a content object and adds fields to the list
 	 * 
 	 * @param content the content
 	 * @param fields the list with fields to edit
 	 */
 	private static void introspectContent(final Content content,
 			final List fields)
 	{
 		// the ## are used to indicate that we are dealing with an info field
 		fields.add(new IntrospectedFieldData("General Info", "##", false));
 		fields.add(new IntrospectedFieldData("Sender", content.getSender()
 				.getName(), false));
 		fields.add(new IntrospectedFieldData("Sender place", content
 				.getSender().getLocationDescription(), false));
 		fields.add(new IntrospectedFieldData("Receiver", content.getReceiver()
 				.getName(), false));
 		fields.add(new IntrospectedFieldData("Receiver place", content
 				.getReceiver().getLocationDescription(), false));
 		fields.add(new IntrospectedFieldData("Product", content.getProduct()
 				.getName(), false));
 	}
 
 	/***
 	 * Introspects a rfq object and adds fields to the list
 	 * 
 	 * @param rfq the request for quote
 	 * @param fields the list with fields to edit
 	 */
 	private static void introspectRFQ(final RequestForQuote rfq,
 			final List fields)
 	{
 		// the ## are used to indicate that we are dealing with an info field
 		fields.add(new IntrospectedFieldData("Request for Quote Info", "##",
 				false));
 		fields.add(new IntrospectedFieldData("Amount", new Double(rfq
 				.getAmount()), false));
 		fields.add(new IntrospectedFieldData("Earliest delivery date",
 				IntrospectionUtil.formatTime(rfq.getSender().getSimulator(),
 						rfq.getEarliestDeliveryDate()), false));
 		fields.add(new IntrospectedFieldData("Latest delivery date",
 				IntrospectionUtil.formatTime(rfq.getSender().getSimulator(),
 						rfq.getLatestDeliveryDate()), false));
 	}
 
 	/***
 	 * Introspects a quote object and adds fields to the list
 	 * 
 	 * @param quote the quote
 	 * @param fields the list with fields to edit
 	 */
 	private static void introspectQuote(final Quote quote, final List fields)
 	{
 		// the ## are used to indicate that we are dealing with an info field
 		fields.add(new IntrospectedFieldData("Quote Info", "##", false));
 		fields.add(new IntrospectedFieldData("Proposed amount", new Double(
 				quote.getAmount()), false));
 		fields.add(new IntrospectedFieldData("Proposed delivery date",
 				IntrospectionUtil.formatTime(quote.getSender().getSimulator(),
 						quote.getProposedDeliveryDate()), false));
 		fields.add(new IntrospectedFieldData("Proposed price", new Double(quote
 				.getPrice()), false));
 	}
 
 	/***
 	 * Introspects an order object and adds fields to the list
 	 * 
 	 * @param order the order
 	 * @param fields the list with fields to edit
 	 */
 	private static void introspectOrder(final Order order, final List fields)
 	{
 		// the ## are used to indicate that we are dealing with an info field
 		fields.add(new IntrospectedFieldData("Order Info", "##", false));
 		fields.add(new IntrospectedFieldData("Amount", new Double(order
 				.getAmount()), false));
 		fields.add(new IntrospectedFieldData("Delivery date", IntrospectionUtil
 				.formatTime(order.getSender().getSimulator(), order
 						.getDeliveryDate()), false));
 	}
 
 	/***
 	 * Introspects an order confirmation object and adds fields to the list
 	 * 
 	 * @param orderConfirmation the order confirmation
 	 * @param fields the list with fields to edit
 	 */
 	private static void introspectOrderConfirmation(
 			final OrderConfirmation orderConfirmation, final List fields)
 	{
 		// the ## are used to indicate that we are dealing with an info field
 		fields.add(new IntrospectedFieldData("Order Confirmation Info", "##",
 				false));
 		fields.add(new IntrospectedFieldData("Status", orderConfirmation
 				.getStatusString(), false));
 	}
 
 	/***
 	 * Introspects a bill object and adds fields to the list
 	 * 
 	 * @param bill the bill
 	 * @param fields the list with fields to edit
 	 */
 	private static void introspectBill(final Bill bill, final List fields)
 	{
 		// the ## are used to indicate that we are dealing with an info field
 		fields.add(new IntrospectedFieldData("Bill Info", "##", false));
 		fields.add(new IntrospectedFieldData("Price", new Double(bill
 				.getPrice()), false));
 	}
 
 	/***
 	 * Introspects a payment object and adds fields to the list
 	 * 
 	 * @param payment the payment
 	 * @param fields the list with fields to edit
 	 */
 	private static void introspectPayment(final Payment payment,
 			final List fields)
 	{
 		// the ## are used to indicate that we are dealing with an info field
 		fields.add(new IntrospectedFieldData("Payment Info", "##", false));
 		fields.add(new IntrospectedFieldData("Price", new Double(payment
 				.getPayment()), false));
 	}
 
 	/***
 	 * Method formatTime formats the given time to a String representing the
 	 * date.
 	 * 
 	 * @param simulator the simulator to use
 	 * @param time the time
 	 * @return returns a string representing the date
 	 */
 	private static String formatTime(final SimulatorInterface simulator,
 			final double time)
 	{
 		try
 		{
 			if (IntrospectionUtil.startTime == 0L)
 			{
 				IntrospectionUtil.startTime = simulator.getReplication()
 						.getRunControl().getTreatment().getStartTime();
 			}
 
 			if (IntrospectionUtil.timeUnit == null)
 			{
 				IntrospectionUtil.timeUnit = simulator.getReplication()
 						.getRunControl().getTreatment().getTimeUnit();
 			}
 
 			// convert the time to milliseconds
 			double timeInMilliSeconds = TimeUnit.convert(time, timeUnit,
 					TimeUnitInterface.MILLISECOND);
 
 			IntrospectionUtil.calendar
 					.setTimeInMillis(IntrospectionUtil.startTime
 							+ (long) timeInMilliSeconds);
 		} catch (Exception exception)
 		{
 			Logger.severe(IntrospectionUtil.class, "formatTime", exception);
 		}
 		return IntrospectionUtil.dateFormat.format(IntrospectionUtil.calendar
 				.getTime());
 	}
 }