/*
    * @(#) HistogramSeries.java Sep 22, 2003
    * 
    * Copyright (c) 2003 Delft University of Technology Jaffalaan 5, 2628 BX Delft,
    * the Netherlands All rights reserved.
    * 
    * This software is proprietary information of Delft University of Technology
    * The code is published under the General Public License
    */
  package nl.tudelft.simulation.jstats.charts.histogram;
  
  import nl.tudelft.simulation.event.EventInterface;
  import nl.tudelft.simulation.event.EventListenerInterface;
  
  import org.jfree.data.AbstractDataset;
  
  
  /***
   * The serie defines a histogram series containing the entries of a set.
   * <p>
   * (c) copyright 2002-2004 <a href="http://www.simulation.tudelft.nl">Delft
   * University of Technology </a>, the Netherlands. <br>
   * See for project information <a href="http://www.simulation.tudelft.nl">
   * www.simulation.tudelft.nl </a> <br>
   * License of use: <a href="http://www.gnu.org/copyleft/gpl.html">General Public
   * License (GPL) </a>, no warranty <br>
   * 
   * @author <a href="http://www.tbm.tudelft.nl/webstaf/alexandv/index.htm">
   *         Alexander Verbraeck </a> <br>
   *         <a href="http://www.tbm.tudelft.nl/webstaf/peterja/index.htm"> Peter
   *         Jacobs </a>
   * @version 1.7 2004-03-22
   * @since 1.2
   */
  public class HistogramSeries extends AbstractDataset implements
  		EventListenerInterface
  {
  
  	/***
  	 * name refers to the name of the serie
  	 * 
  	 * @uml.property name="name"
  	 */
  	private String name;
  
  
  	/*** bins refers to the bins in this serie */
  	private Bin[] bins = null;
  
  	/***
  	 * constructs a new HistogramSeries
  	 * 
  	 * @param name the name of the dataset
  	 * @param domain the domain of the serie
  	 * @param range the range of the serie
  	 * @param numberOfBins the number of bins to be used
  	 */
  	public HistogramSeries(final String name, final double[] domain,
  			final double[] range, final int numberOfBins)
  	{
  
  		super();
  		this.name = name;
  		this.bins = new Bin[numberOfBins + 2];
  		double binWidth = (domain[1] - domain[0]) / numberOfBins * 1.0;
  		double min = domain[0] - binWidth;
  		for (int i = 0; i < numberOfBins + 2; i++)
  		{
  			this.bins[i] = new Bin(new double[]{min, min + binWidth}, range);
  			if (range != null)
  			{
  				this.bins[i].setFixed(true);
  			}
  			min = min + binWidth;
  		}
  		this.fireDatasetChanged();
  	}
  
  	/***
  	 * returns the name of the serie
  	 * 
  	 * @return String the name
  	 * 
  	 * @uml.property name="name"
  	 */
  	public String getName()
  	{
  		return this.name;
  	}
  
  	/***
  	 * returns the maxX value for bin
  	 * 
  	 * @param bin the bin number
  	 * @return Number
  	 */
  	public Number getEndXValue(final int bin)
  	{
  		return this.bins[bin].getEndXValue();
 	}
 
 	/***
 	 * returns the maxY value
 	 * 
 	 * @param bin the bin number
 	 * @return Number
 	 */
 	public Number getEndYValue(final int bin)
 	{
 		return this.bins[bin].getEndYValue();
 	}
 
 	/***
 	 * returns the minimumX value
 	 * 
 	 * @param bin the bin number
 	 * @return Number
 	 */
 	public Number getStartXValue(final int bin)
 	{
 		return this.bins[bin].getStartXValue();
 	}
 
 	/***
 	 * returns the minimumY value
 	 * 
 	 * @param bin the bin number
 	 * @return Number
 	 */
 	public Number getStartYValue(final int bin)
 	{
 		return this.bins[bin].getStartYValue();
 	}
 
 	/***
 	 * returns the number of bins in the histogram
 	 * 
 	 * @return int
 	 */
 	public int getBinCount()
 	{
 		return this.bins.length;
 	}
 
 	/***
 	 * returns the x value
 	 * 
 	 * @param bin the bin number
 	 * @return Number
 	 */
 	public Number getXValue(final int bin)
 	{
 		return this.bins[bin].getXValue();
 	}
 
 	/***
 	 * returns the Y value
 	 * 
 	 * @param bin the bin number
 	 * @return Number
 	 */
 	public Number getYValue(final int bin)
 	{
 		return this.bins[bin].getYValue();
 	}
 
 	/***
 	 * @see nl.tudelft.simulation.event.EventListenerInterface
 	 *      #notify(nl.tudelft.simulation.event.EventInterface)
 	 */
 	public synchronized void notify(final EventInterface event)
 	{
 		double value = ((Number) event.getContent()).doubleValue();
 		this.bins[this.resolveBin(value)].increase();
 		this.fireDatasetChanged();
 	}
 
 	/***
 	 * resolves the bin for a particular value
 	 * 
 	 * @param value the value of the incomming event
 	 * @return int the bin number
 	 */
 	private int resolveBin(final double value)
 	{
 		if (value <= this.bins[1].getStartXValue().doubleValue())
 		{
 			return 0;
 		}
 		for (int i = 1; i < this.bins.length - 1; i++)
 		{
 			if (value > this.bins[i].getStartXValue().doubleValue()
 					&& value <= this.bins[i].getEndXValue().doubleValue())
 			{
 				return i;
 			}
 		}
 		return this.bins.length - 1;
 	}
 
 	/***
 	 * defines the bins in the histogram.
 	 */
 	private class Bin
 	{
 		/*** the domain of the bin */
 		private double[] domain;
 
 		/*** the range of the bin */
 		private double[] range = null;
 
 		/*** observations refers to the value of this bin */
 		private int observations = 0;
 
 		/*** fixed refers to autoscaling versus fixed scaling */
 		private boolean fixed = false;
 
 		/***
 		 * constructs a new Bin
 		 * 
 		 * @param domain the domain of the bin
 		 * @param range the range of the bin
 		 */
 		public Bin(final double[] domain, final double[] range)
 		{
 			this.domain = domain;
 			if (range == null)
 			{
 				this.range = new double[]{0, 1};
 			} else
 			{
 				this.range = range;
 				this.fixed = true;
 			}
 		}
 
 		/***
 		 * increases the value of the bin with 1
 		 */
 		public void increase()
 		{
 			this.observations++;
 			if (!this.fixed && this.observations >= this.range[1])
 			{
 				this.range[1] = this.observations;
 			}
 		}
 
 		/***
 		 * returns the minimum x value
 		 * 
 		 * @return Number
 		 */
 		public Number getStartXValue()
 		{
 			return new Double(this.domain[0]);
 		}
 
 		/***
 		 * returns the minimum y value
 		 * 
 		 * @return Number
 		 */
 		public Number getStartYValue()
 		{
 			return new Double(this.range[0]);
 		}
 
 		/***
 		 * returns the maximum X value
 		 * 
 		 * @return Number
 		 */
 		public Number getEndXValue()
 		{
 			return new Double(this.domain[1]);
 		}
 
 		/***
 		 * returns the maximum Y value
 		 * 
 		 * @return Number
 		 */
 		public Number getEndYValue()
 		{
 			return new Double(this.range[1]);
 		}
 
 		/***
 		 * returns the x value
 		 * 
 		 * @return Number
 		 */
 		public synchronized Number getXValue()
 		{
 			return new Double(0.5 * (this.domain[1] - this.domain[0]));
 		}
 
 		/***
 		 * returns the y value
 		 * 
 		 * @return Number
 		 */
 		public Number getYValue()
 		{
 			return new Integer(this.observations);
 		}
 
 		/***
 		 * sets the fixed attributed
 		 * 
 		 * @param fixed is the bin fixed in range
 		 */
 		public void setFixed(final boolean fixed)
 		{
 			this.fixed = fixed;
 		}
 	}
 }