001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-2022, by David Gilbert and Contributors.
006 *
007 * Project Info:  http://www.jfree.org/jfreechart/index.html
008 *
009 * This library is free software; you can redistribute it and/or modify it
010 * under the terms of the GNU Lesser General Public License as published by
011 * the Free Software Foundation; either version 2.1 of the License, or
012 * (at your option) any later version.
013 *
014 * This library is distributed in the hope that it will be useful, but
015 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
016 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
017 * License for more details.
018 *
019 * You should have received a copy of the GNU Lesser General Public
020 * License along with this library; if not, write to the Free Software
021 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
022 * USA.
023 *
024 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 
025 * Other names may be trademarks of their respective owners.]
026 *
027 * -----------------------
028 * XYAnnotationEntity.java
029 * -----------------------
030 * (C) Copyright 2004-2022, by David Gilbert.
031 *
032 * Original Author:  David Gilbert;
033 * Contributor(s):   -;
034 *
035 */
036
037package org.jfree.chart.entity;
038
039import java.awt.Shape;
040import java.io.Serializable;
041
042/**
043 * A chart entity that represents an annotation on an
044 * {@link org.jfree.chart.plot.XYPlot}.
045 */
046public class XYAnnotationEntity extends ChartEntity implements Serializable {
047
048    /** For serialization. */
049    private static final long serialVersionUID = 2340334068383660799L;
050
051    /** The renderer index. */
052    private int rendererIndex;
053
054    /**
055     * Creates a new entity.
056     *
057     * @param hotspot  the area.
058     * @param rendererIndex  the rendererIndex (zero-based index).
059     * @param toolTipText  the tool tip text.
060     * @param urlText  the URL text for HTML image maps.
061     */
062    public XYAnnotationEntity(Shape hotspot, int rendererIndex,
063                              String toolTipText, String urlText) {
064        super(hotspot, toolTipText, urlText);
065        this.rendererIndex = rendererIndex;
066    }
067
068    /**
069     * Returns the renderer index.
070     *
071     * @return The renderer index.
072     */
073    public int getRendererIndex() {
074        return this.rendererIndex;
075    }
076
077    /**
078     * Sets the renderer index.
079     *
080     * @param index  the item index (zero-based).
081     */
082    public void setRendererIndex(int index) {
083        this.rendererIndex = index;
084    }
085
086    /**
087     * Tests the entity for equality with an arbitrary object.
088     *
089     * @param obj  the object ({@code null} permitted).
090     *
091     * @return A boolean.
092     */
093    @Override
094    public boolean equals(Object obj) {
095        if (obj == this) {
096            return true;
097        }
098        if (!super.equals(obj)) {
099            return false;
100        }
101        if (!(obj instanceof XYAnnotationEntity)) {
102            return false;
103        }
104        XYAnnotationEntity that = (XYAnnotationEntity) obj;
105        if (this.rendererIndex != that.rendererIndex) {
106            return false;
107        }
108        return true;
109    }
110
111}