/* ===========================================================

 * JFreeChart : a free chart library for the Java(tm) platform

 * ===========================================================

 *

 * (C) Copyright 2000-2004, by Object Refinery Limited and Contributors.

 *

 * Project Info:  http://www.jfree.org/jfreechart/index.html

 *

 * This library is free software; you can redistribute it and/or modify it under the terms

 * of the GNU Lesser General Public License as published by the Free Software Foundation;

 * either version 2.1 of the License, or (at your option) any later version.

 *

 * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;

 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

 * See the GNU Lesser General Public License for more details.

 *

 * You should have received a copy of the GNU Lesser General Public License along with this

 * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,

 * Boston, MA 02111-1307, USA.

 *

 * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 

 * in the United States and other countries.]

 *

 * ----------------------

 * YIntervalRenderer.java

 * ----------------------

 * (C) Copyright 2002-2004, by Object Refinery Limited.

 *

 * Original Author:  David Gilbert (for Object Refinery Limited);

 * Contributor(s):   -;

 *

 * $Id: YIntervalRenderer.java,v 1.1 2004/08/31 14:49:29 mungady Exp $

 *

 * Changes

 * -------

 * 05-Nov-2002 : Version 1 (DG);

 * 25-Mar-2003 : Implemented Serializable (DG);

 * 01-May-2003 : Modified drawItem(...) method signature (DG);

 * 20-Aug-2003 : Implemented Cloneable and PublicCloneable (DG);

 * 16-Sep-2003 : Changed ChartRenderingInfo --> PlotRenderingInfo (DG);

 * 25-Feb-2004 : Replaced CrosshairInfo with CrosshairState (DG);

 * 

 */



package org.jfree.chart.renderer.xy;



import java.awt.Graphics2D;

import java.awt.Paint;

import java.awt.Shape;

import java.awt.Stroke;

import java.awt.geom.Line2D;

import java.awt.geom.Rectangle2D;

import java.io.Serializable;



import org.jfree.chart.axis.ValueAxis;

import org.jfree.chart.entity.EntityCollection;

import org.jfree.chart.entity.XYItemEntity;

import org.jfree.chart.labels.XYToolTipGenerator;

import org.jfree.chart.plot.CrosshairState;

import org.jfree.chart.plot.PlotOrientation;

import org.jfree.chart.plot.PlotRenderingInfo;

import org.jfree.chart.plot.XYPlot;

import org.jfree.data.xy.IntervalXYDataset;

import org.jfree.data.xy.XYDataset;

import org.jfree.ui.RectangleEdge;

import org.jfree.util.PublicCloneable;



/**

 * A renderer that draws a line connecting the start and end Y values for an {@link XYPlot}.

 */

public class YIntervalRenderer extends AbstractXYItemRenderer 

                               implements XYItemRenderer, 

                                          Cloneable,

                                          PublicCloneable,

                                          Serializable {



    /**

     * The default constructor.

     */

    public YIntervalRenderer() {

        super();

    }



    /**

     * Draws the visual representation of a single data item.

     *

     * @param g2  the graphics device.

     * @param state  the renderer state.

     * @param dataArea  the area within which the plot is being drawn.

     * @param info  collects information about the drawing.

     * @param plot  the plot (can be used to obtain standard color information etc).

     * @param domainAxis  the domain axis.

     * @param rangeAxis  the range axis.

     * @param dataset  the dataset.

     * @param series  the series index (zero-based).

     * @param item  the item index (zero-based).

     * @param crosshairState  crosshair information for the plot (<code>null</code> permitted).

     * @param pass  the pass index (ignored here).

     */

    public void drawItem(Graphics2D g2, 

                         XYItemRendererState state,

                         Rectangle2D dataArea,

                         PlotRenderingInfo info,

                         XYPlot plot, 

                         ValueAxis domainAxis, 

                         ValueAxis rangeAxis,

                         XYDataset dataset, 

                         int series, 

                         int item,

                         CrosshairState crosshairState, 

                         int pass) {



        // setup for collecting optional entity info...

        Shape entityArea = null;

        EntityCollection entities = null;

        if (info != null) {

            entities = info.getOwner().getEntityCollection();

        }



        IntervalXYDataset intervalData = (IntervalXYDataset) dataset;



        Number x = intervalData.getX(series, item);

        Number yLow   = intervalData.getStartY(series, item);

        Number yHigh  = intervalData.getEndY(series, item);



        RectangleEdge xAxisLocation = plot.getDomainAxisEdge();

        RectangleEdge yAxisLocation = plot.getRangeAxisEdge();

        

        double xx = domainAxis.valueToJava2D(x.doubleValue(), dataArea, xAxisLocation);

        double yyLow = rangeAxis.valueToJava2D(yLow.doubleValue(), dataArea, yAxisLocation);

        double yyHigh = rangeAxis.valueToJava2D(yHigh.doubleValue(), dataArea, yAxisLocation);



        Paint p = getItemPaint(series, item);

        Stroke s = getItemStroke(series, item);

        

        Line2D line = null;

        Shape shape = getItemShape(series, item);

        Shape top = null;

        Shape bottom = null;

        PlotOrientation orientation = plot.getOrientation();

        if (orientation == PlotOrientation.HORIZONTAL) {

            line = new Line2D.Double(yyLow, xx, yyHigh, xx);

            top = createTransformedShape(shape, yyHigh, xx);

            bottom = createTransformedShape(shape, yyLow, xx);

        }

        else if (orientation == PlotOrientation.VERTICAL) {

            line = new Line2D.Double(xx, yyLow, xx, yyHigh);

            top = createTransformedShape(shape, xx, yyHigh);

            bottom = createTransformedShape(shape, xx, yyLow);

        }

        g2.setPaint(p);

        g2.setStroke(s);

        g2.draw(line);



        g2.fill(top);

        g2.fill(bottom);



        // add an entity for the item...

        if (entities != null) {

            if (entityArea == null) {

                entityArea = line.getBounds();

            }

            String tip = null;

            XYToolTipGenerator generator = getToolTipGenerator(series, item);

            if (generator != null) {

                tip = generator.generateToolTip(dataset, series, item);

            }

            String url = null;

            if (getURLGenerator() != null) {

                url = getURLGenerator().generateURL(dataset, series, item);

            }

            XYItemEntity entity = new XYItemEntity(entityArea, dataset, series, item, tip, url);

            entities.addEntity(entity);

        }



    }

    

    /**

     * Returns a clone of the renderer.

     * 

     * @return A clone.

     * 

     * @throws CloneNotSupportedException  if the renderer cannot be cloned.

     */

    public Object clone() throws CloneNotSupportedException {

        return super.clone();

    }



}

