001 /* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-2007, by Object Refinery Limited 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 * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
025 * in the United States and other countries.]
026 *
027 * ------------------
028 * ContourEntity.java
029 * ------------------
030 * (C) Copyright 2002-2007, by David M. O'Donnell and Contributors.
031 *
032 * Original Author: David M. O'Donnell;
033 * Contributor(s): David Gilbert (for Object Refinery Limited);
034 *
035 * $Id: ContourEntity.java,v 1.3.2.4 2007/04/04 09:06:38 mungady Exp $
036 *
037 * Changes
038 * -------
039 * 26-Nov-2002 : Version 1 contributed by David M. O'Donnell (DG);
040 * 20-May-2004 : Added equals() and clone() methods and implemented
041 * Serializable (DG);
042 * ------------- JFREECHART 1.0.x ---------------------------------------------
043 * 02-Feb-2007 : Removed author tags all over JFreeChart sources (DG);
044 *
045 */
046
047 package org.jfree.chart.entity;
048
049 import java.awt.Shape;
050 import java.io.Serializable;
051
052 import org.jfree.chart.plot.XYPlot;
053 import org.jfree.chart.renderer.xy.XYBlockRenderer;
054
055 /**
056 * Represents an item on a contour chart.
057 *
058 * @deprecated This class is no longer supported (as of version 1.0.4). If
059 * you are creating contour plots, please try to use {@link XYPlot} and
060 * {@link XYBlockRenderer}.
061 */
062 public class ContourEntity extends ChartEntity
063 implements Cloneable, Serializable {
064
065 /** For serialization. */
066 private static final long serialVersionUID = 1249570520505992847L;
067
068 /** Holds the index into the dataset for this entity. */
069 private int index = -1;
070
071 /**
072 * Constructor for ContourEntity.
073 *
074 * @param area the area.
075 * @param toolTipText the tooltip text.
076 */
077 public ContourEntity(Shape area, String toolTipText) {
078 super(area, toolTipText);
079 }
080
081 /**
082 * Constructor for ContourEntity.
083 *
084 * @param area the area.
085 * @param toolTipText the tooltip text.
086 * @param urlText the URL text.
087 */
088 public ContourEntity(Shape area, String toolTipText, String urlText) {
089 super(area, toolTipText, urlText);
090 }
091
092 /**
093 * Returns the index.
094 *
095 * @return The index.
096 */
097 public int getIndex() {
098 return this.index;
099 }
100
101 /**
102 * Sets the index.
103 *
104 * @param index the index.
105 */
106 public void setIndex(int index) {
107 this.index = index;
108 }
109
110 /**
111 * Tests the entity for equality with an arbitrary object.
112 *
113 * @param obj the object (<code>null</code> permitted).
114 *
115 * @return A boolean.
116 */
117 public boolean equals(Object obj) {
118 if (obj == this) {
119 return true;
120 }
121 if (obj instanceof ContourEntity && super.equals(obj)) {
122 ContourEntity ce = (ContourEntity) obj;
123 if (this.index != ce.index) {
124 return false;
125 }
126 return true;
127 }
128 return false;
129 }
130
131 /**
132 * Returns a clone of the entity.
133 *
134 * @return A clone.
135 *
136 * @throws CloneNotSupportedException if cloning is not supported.
137 */
138 public Object clone() throws CloneNotSupportedException {
139 return super.clone();
140 }
141
142 }