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

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

*

* (C) Copyright 2000-2014, 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,

* USA.

*

* [Oracle and Java are registered trademarks of Oracle and/or its affiliates.

* Other names may be trademarks of their respective owners.]

*

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

* PiePlot.java

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

* (C) Copyright 2000-2014, by Andrzej Porebski and Contributors.

*

* Original Author:  Andrzej Porebski;

* Contributor(s):   David Gilbert (for Object Refinery Limited);

*                   Martin Cordova (percentages in labels);

*                   Richard Atkinson (URL support for image maps);

*                   Christian W. Zuckschwerdt;

*                   Arnaud Lelievre;

*                   Martin Hilpert (patch 1891849);

*                   Andreas Schroeder (very minor);

*                   Christoph Beck (bug 2121818);

*

* Changes

* -------

* 21-Jun-2001 : Removed redundant JFreeChart parameter from constructors (DG);

* 18-Sep-2001 : Updated header (DG);

* 15-Oct-2001 : Data source classes moved to com.jrefinery.data.* (DG);

* 19-Oct-2001 : Moved series paint and stroke methods from JFreeChart.java to

*               Plot.java (DG);

* 22-Oct-2001 : Renamed DataSource.java --> Dataset.java etc. (DG);

* 13-Nov-2001 : Modified plot subclasses so that null axes are possible for

*               pie plot (DG);

* 17-Nov-2001 : Added PieDataset interface and amended this class accordingly,

*               and completed removal of BlankAxis class as it is no longer

*               required (DG);

* 19-Nov-2001 : Changed 'drawCircle' property to 'circular' property (DG);

* 21-Nov-2001 : Added options for exploding pie sections and filled out range

*               of properties (DG);

*               Added option for percentages in chart labels, based on code

*               by Martin Cordova (DG);

* 30-Nov-2001 : Changed default font from "Arial" --> "SansSerif" (DG);

* 12-Dec-2001 : Removed unnecessary 'throws' clause in constructor (DG);

* 13-Dec-2001 : Added tooltips (DG);

* 16-Jan-2002 : Renamed tooltips class (DG);

* 22-Jan-2002 : Fixed bug correlating legend labels with pie data (DG);

* 05-Feb-2002 : Added alpha-transparency to plot class, and updated

*               constructors accordingly (DG);

* 06-Feb-2002 : Added optional background image and alpha-transparency to Plot

*               and subclasses.  Clipped drawing within plot area (DG);

* 26-Mar-2002 : Added an empty zoom method (DG);

* 18-Apr-2002 : PieDataset is no longer sorted (oldman);

* 23-Apr-2002 : Moved dataset from JFreeChart to Plot.  Added

*               getLegendItemLabels() method (DG);

* 19-Jun-2002 : Added attributes to control starting angle and direction

*               (default is now clockwise) (DG);

* 25-Jun-2002 : Removed redundant imports (DG);

* 02-Jul-2002 : Fixed sign of percentage bug introduced in 0.9.2 (DG);

* 16-Jul-2002 : Added check for null dataset in getLegendItemLabels() (DG);

* 30-Jul-2002 : Moved summation code to DatasetUtilities (DG);

* 05-Aug-2002 : Added URL support for image maps - new member variable for

*               urlGenerator, modified constructor and minor change to the

*               draw method (RA);

* 18-Sep-2002 : Modified the percent label creation and added setters for the

*               formatters (AS);

* 24-Sep-2002 : Added getLegendItems() method (DG);

* 02-Oct-2002 : Fixed errors reported by Checkstyle (DG);

* 09-Oct-2002 : Added check for null entity collection (DG);

* 30-Oct-2002 : Changed PieDataset interface (DG);

* 18-Nov-2002 : Changed CategoryDataset to TableDataset (DG);

* 02-Jan-2003 : Fixed "no data" message (DG);

* 23-Jan-2003 : Modified to extract data from rows OR columns in

*               CategoryDataset (DG);

* 14-Feb-2003 : Fixed label drawing so that foreground alpha does not apply

*               (bug id 685536) (DG);

* 07-Mar-2003 : Modified to pass pieIndex on to PieSectionEntity and tooltip

*               and URL generators (DG);

* 21-Mar-2003 : Added a minimum angle for drawing arcs

*               (see bug id 620031) (DG);

* 24-Apr-2003 : Switched around PieDataset and KeyedValuesDataset (DG);

* 02-Jun-2003 : Fixed bug 721733 (DG);

* 30-Jul-2003 : Modified entity constructor (CZ);

* 19-Aug-2003 : Implemented Cloneable (DG);

* 29-Aug-2003 : Fixed bug 796936 (null pointer on setOutlinePaint()) (DG);

* 08-Sep-2003 : Added internationalization via use of properties

*               resourceBundle (RFE 690236) (AL);

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

* 29-Oct-2003 : Added workaround for font alignment in PDF output (DG);

* 05-Nov-2003 : Fixed missing legend bug (DG);

* 10-Nov-2003 : Re-added the DatasetChangeListener to constructors (CZ);

* 29-Jan-2004 : Fixed clipping bug in draw() method (DG);

* 11-Mar-2004 : Major overhaul to improve labelling (DG);

* 31-Mar-2004 : Made an adjustment for the plot area when the label generator

*               is null.  Fixed null pointer exception when the label

*               generator returns null for a label (DG);

* 06-Apr-2004 : Added getter, setter, serialization and draw support for

*               labelBackgroundPaint (AS);

* 08-Apr-2004 : Added flag to control whether null values are ignored or

*               not (DG);

* 15-Apr-2004 : Fixed some minor warnings from Eclipse (DG);

* 26-Apr-2004 : Added attributes for label outline and shadow (DG);

* 04-Oct-2004 : Renamed ShapeUtils --> ShapeUtilities (DG);

* 04-Nov-2004 : Fixed null pointer exception with new LegendTitle class (DG);

* 09-Nov-2004 : Added user definable legend item shape (DG);

* 25-Nov-2004 : Added new legend label generator (DG);

* 20-Apr-2005 : Added a tool tip generator for legend labels (DG);

* 26-Apr-2005 : Removed LOGGER (DG);

* 05-May-2005 : Updated draw() method parameters (DG);

* 10-May-2005 : Added flag to control visibility of label linking lines, plus

*               another flag to control the handling of zero values (DG);

* 08-Jun-2005 : Fixed bug in getLegendItems() method (not respecting flags

*               for ignoring null and zero values), and fixed equals() method

*               to handle GradientPaint (DG);

* 15-Jul-2005 : Added sectionOutlinesVisible attribute (DG);

* ------------- JFREECHART 1.0.x ---------------------------------------------

* 09-Jan-2006 : Fixed bug 1400442, inconsistent treatment of null and zero

*               values in dataset (DG);

* 28-Feb-2006 : Fixed bug 1440415, bad distribution of pie section

*               labels (DG);

* 27-Sep-2006 : Initialised baseSectionPaint correctly, added lookup methods

*               for section paint, outline paint and outline stroke (DG);

* 27-Sep-2006 : Refactored paint and stroke methods to use keys rather than

*               section indices (DG);

* 03-Oct-2006 : Replaced call to JRE 1.5 method (DG);

* 23-Nov-2006 : Added support for URLs for the legend items (DG);

* 24-Nov-2006 : Cloning fixes (DG);

* 17-Apr-2007 : Check for null label in legend items (DG);

* 19-Apr-2007 : Deprecated override settings (DG);

* 18-May-2007 : Set dataset for LegendItem (DG);

* 14-Jun-2007 : Added label distributor attribute (DG);

* 18-Jul-2007 : Added simple label option (DG);

* 21-Nov-2007 : Fixed labelling bugs, added debug code, restored default

*               white background (DG);

* 19-Mar-2008 : Fixed IllegalArgumentException when drawing with null

*               dataset (DG);

* 31-Mar-2008 : Adjust the label area for the interiorGap (DG);

* 31-Mar-2008 : Added quad and cubic curve label link lines - see patch

*               1891849 by Martin Hilpert (DG);

* 02-Jul-2008 : Added autoPopulate flags (DG);

* 15-Aug-2008 : Added methods to clear section attributes (DG);

* 15-Aug-2008 : Fixed bug 2051168 - problem with LegendItemEntity

*               generation (DG);

* 23-Sep-2008 : Added getLabelLinkDepth() method - see bug 2121818 reported

*               by Christoph Beck (DG);

* 18-Dec-2008 : Use ResourceBundleWrapper - see patch 1607918 by

*               Jess Thrysoee (DG);

* 10-Jul-2009 : Added optional drop shadow generator (DG);

* 03-Sep-2009 : Fixed bug where sinmpleLabelOffset is ignored (DG);

* 04-Nov-2009 : Add mouse wheel rotation support (DG);

* 18-Oct-2011 : Fixed tooltip offset with shadow generator (DG);

* 20-Nov-2011 : Initialise shadow generator as null (DG);

* 16-Jun-2012 : Removed JCommon dependencies (DG);

* 01-Jul-2012 : Removed deprecated code (DG);

* 10-Mar-2014 : Removed LegendItemCollection (DG);

*

*/

* A plot that displays data in the form of a pie chart, using data from any

* class that implements the {@link PieDataset} interface.

* The example shown here is generated by the <code>PieChartDemo2.java</code>

* program included in the JFreeChart Demo Collection:

* <br><br>

* <img src="../../../../images/PiePlotSample.png" alt="PiePlotSample.png">

* <P>

* Special notes:

* <ol>

* <li>the default starting point is 12 o'clock and the pie sections proceed

* in a clockwise direction, but these settings can be changed;</li>

* <li>negative values in the dataset are ignored;</li>

* <li>there are utility methods for creating a {@link PieDataset} from a

* {@link org.jfree.data.category.CategoryDataset};</li>

* </ol>

*

* @see Plot

* @see PieDataset

*/

    /** For serialization. */

    private static final long serialVersionUID = -795612466005590431L;

    /** The default interior gap. */

    public static final double DEFAULT_INTERIOR_GAP = 0.08;

    /** The maximum interior gap (currently 40%). */

    public static final double MAX_INTERIOR_GAP = 0.40;

    /** The default starting angle for the pie chart. */

    public static final double DEFAULT_START_ANGLE = 90.0;

    /** The default section label font. */

    public static final Font DEFAULT_LABEL_FONT = new Font("SansSerif",

            Font.PLAIN, 10);

    /** The default section label paint. */

    public static final Paint DEFAULT_LABEL_PAINT = Color.BLACK;

    /** The default section label background paint. */

    public static final Paint DEFAULT_LABEL_BACKGROUND_PAINT = new Color(255,

            255, 192);

    /** The default section label outline paint. */

    public static final Paint DEFAULT_LABEL_OUTLINE_PAINT = Color.BLACK;

    /** The default section label outline stroke. */

    public static final Stroke DEFAULT_LABEL_OUTLINE_STROKE = new BasicStroke(

            0.5f);

    /** The default section label shadow paint. */

    public static final Paint DEFAULT_LABEL_SHADOW_PAINT = new Color(151, 151,

            151, 128);

    /** The default minimum arc angle to draw. */

    public static final double DEFAULT_MINIMUM_ARC_ANGLE_TO_DRAW = 0.00001;

    /** The dataset for the pie chart. */

    private PieDataset dataset;

    /** The pie index (used by the {@link MultiplePiePlot} class). */

    private int pieIndex;

    /**

     * The amount of space left around the outside of the pie plot, expressed

     * as a percentage of the plot area width and height.

     */

    private double interiorGap;

    /** Flag determining whether to draw an ellipse or a perfect circle. */

    private boolean circular;

    /** The starting angle. */

    private double startAngle;

    /** The direction for the pie segments. */

    private Rotation direction;

    /** The section paint map. */

    private PaintMap sectionPaintMap;

    /** The base section paint (fallback). */

    private transient Paint baseSectionPaint;

    /**

     * A flag that controls whether or not the section paint is auto-populated

     * from the drawing supplier.

     *

     * @since 1.0.11

     */

    private boolean autoPopulateSectionPaint;

    /**

     * A flag that controls whether or not an outline is drawn for each

     * section in the plot.

     */

    private boolean sectionOutlinesVisible;

    /** The section outline paint map. */

    private PaintMap sectionOutlinePaintMap;

    /** The base section outline paint (fallback). */

    private transient Paint baseSectionOutlinePaint;

    /**

     * A flag that controls whether or not the section outline paint is

     * auto-populated from the drawing supplier.

     *

     * @since 1.0.11

     */

    private boolean autoPopulateSectionOutlinePaint;

    /** The section outline stroke map. */

    private StrokeMap sectionOutlineStrokeMap;

    /** The base section outline stroke (fallback). */

    private transient Stroke baseSectionOutlineStroke;

    /**

     * A flag that controls whether or not the section outline stroke is

     * auto-populated from the drawing supplier.

     *

     * @since 1.0.11

     */

    private boolean autoPopulateSectionOutlineStroke;

    /** The shadow paint. */

    private transient Paint shadowPaint = Color.GRAY;

    /** The x-offset for the shadow effect. */

    private double shadowXOffset = 4.0f;

    /** The y-offset for the shadow effect. */

    private double shadowYOffset = 4.0f;

    /** The percentage amount to explode each pie section. */

    private Map<Comparable<?>, Number> explodePercentages;

    /** The section label generator. */

    private PieSectionLabelGenerator labelGenerator;

    /** The font used to display the section labels. */

    private Font labelFont;

    /** The color used to draw the section labels. */

    private transient Paint labelPaint;

    /**

     * The color used to draw the background of the section labels.  If this

     * is <code>null</code>, the background is not filled.

     */

    private transient Paint labelBackgroundPaint;

    /**

     * The paint used to draw the outline of the section labels

     * (<code>null</code> permitted).

     */

    private transient Paint labelOutlinePaint;

    /**

     * The stroke used to draw the outline of the section labels

     * (<code>null</code> permitted).

     */

    private transient Stroke labelOutlineStroke;

    /**

     * The paint used to draw the shadow for the section labels

     * (<code>null</code> permitted).

     */

    private transient Paint labelShadowPaint;

    /**

     * A flag that controls whether simple or extended labels are used.

     *

     * @since 1.0.7

     */

    private boolean simpleLabels = true;

    /**

     * The padding between the labels and the label outlines.  This is not

     * allowed to be <code>null</code>.

     *

     * @since 1.0.7

     */

    private RectangleInsets labelPadding;

    /**

     * The simple label offset.

     *

     * @since 1.0.7

     */

    private RectangleInsets simpleLabelOffset;

    /** The maximum label width as a percentage of the plot width. */

    private double maximumLabelWidth = 0.14;

    /**

     * The gap between the labels and the link corner, as a percentage of the

     * plot width.

     */

    private double labelGap = 0.025;

    /** A flag that controls whether or not the label links are drawn. */

    private boolean labelLinksVisible;

    /**

     * The label link style.

     *

     * @since 1.0.10

     */

    private PieLabelLinkStyle labelLinkStyle = PieLabelLinkStyle.STANDARD;

    /** The link margin. */

    private double labelLinkMargin = 0.025;

    /** The paint used for the label linking lines. */

    private transient Paint labelLinkPaint = Color.BLACK;

    /** The stroke used for the label linking lines. */

    private transient Stroke labelLinkStroke = new BasicStroke(0.5f);

    /**

     * The pie section label distributor.

     *

     * @since 1.0.6

     */

    private AbstractPieLabelDistributor labelDistributor;

    /** The tooltip generator. */

    private PieToolTipGenerator toolTipGenerator;

    /** The URL generator. */

    private PieURLGenerator urlGenerator;

    /** The legend label generator. */

    private PieSectionLabelGenerator legendLabelGenerator;

    /** A tool tip generator for the legend. */

    private PieSectionLabelGenerator legendLabelToolTipGenerator;

    /**

     * A URL generator for the legend items (optional).

     *

     * @since 1.0.4.

     */

    private PieURLGenerator legendLabelURLGenerator;

    /**