KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jfree > chart > entity > XYItemEntity


1 /* ===========================================================
2  * JFreeChart : a free chart library for the Java(tm) platform
3  * ===========================================================
4  *
5  * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
6  *
7  * Project Info: http://www.jfree.org/jfreechart/index.html
8  *
9  * This library is free software; you can redistribute it and/or modify it
10  * under the terms of the GNU Lesser General Public License as published by
11  * the Free Software Foundation; either version 2.1 of the License, or
12  * (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful, but
15  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
16  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
17  * License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public License
20  * along with this library; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
22  *
23  * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
24  * in the United States and other countries.]
25  *
26  * -----------------
27  * XYItemEntity.java
28  * -----------------
29  * (C) Copyright 2002-2005, by Object Refinery Limited.
30  *
31  * Original Author: David Gilbert (for Object Refinery Limited);
32  * Contributor(s): Richard Atkinson;
33  * Christian W. Zuckschwerdt;
34  *
35  * $Id: XYItemEntity.java,v 1.5 2005/05/19 15:42:54 mungady Exp $
36  *
37  * Changes:
38  * --------
39  * 23-May-2002 : Version 1 (DG);
40  * 12-Jun-2002 : Added accessor methods and Javadoc comments (DG);
41  * 26-Jun-2002 : Added getImageMapAreaTag() method (DG);
42  * 05-Aug-2002 : Added new constructor to populate URLText
43  * Moved getImageMapAreaTag() to ChartEntity (superclass) (RA);
44  * 03-Oct-2002 : Fixed errors reported by Checkstyle (DG);
45  * 30-Jun-2003 : Added XYDataset reference (CZ);
46  * 20-May-2004 : Added equals() and clone() methods and implemented
47  * Serializable (DG);
48  * 11-Jan-2005 : Removed deprecated code in preparation for 1.0.0 release (DG);
49  *
50  */
51
52 package org.jfree.chart.entity;
53
54 import java.awt.Shape JavaDoc;
55
56 import org.jfree.data.xy.XYDataset;
57
58 /**
59  * A chart entity that represents one item within an
60  * {@link org.jfree.chart.plot.XYPlot}.
61  */
62 public class XYItemEntity extends ChartEntity {
63
64     /** For serialization. */
65     private static final long serialVersionUID = -3870862224880283771L;
66     
67     /** The dataset. */
68     private transient XYDataset dataset;
69     
70     /** The series. */
71     private int series;
72
73     /** The item. */
74     private int item;
75
76     /**
77      * Creates a new entity.
78      *
79      * @param area the area.
80      * @param dataset the dataset.
81      * @param series the series (zero-based index).
82      * @param item the item (zero-based index).
83      * @param toolTipText the tool tip text.
84      * @param urlText the URL text for HTML image maps.
85      */
86     public XYItemEntity(Shape JavaDoc area,
87                         XYDataset dataset, int series, int item,
88                         String JavaDoc toolTipText, String JavaDoc urlText) {
89         super(area, toolTipText, urlText);
90         this.dataset = dataset;
91         this.series = series;
92         this.item = item;
93     }
94
95     /**
96      * Returns the dataset this entity refers to.
97      *
98      * @return The dataset.
99      */
100     public XYDataset getDataset() {
101         return this.dataset;
102     }
103
104     /**
105      * Sets the dataset this entity refers to.
106      *
107      * @param dataset the dataset.
108      */
109     public void setDataset(XYDataset dataset) {
110         this.dataset = dataset;
111     }
112
113     /**
114      * Returns the series index.
115      *
116      * @return The series index.
117      */
118     public int getSeriesIndex() {
119         return this.series;
120     }
121
122     /**
123      * Sets the series index.
124      *
125      * @param series the series index (zero-based).
126      */
127     public void setSeriesIndex(int series) {
128         this.series = series;
129     }
130
131     /**
132      * Returns the item index.
133      *
134      * @return The item index.
135      */
136     public int getItem() {
137         return this.item;
138     }
139
140     /**
141      * Sets the item index.
142      *
143      * @param item the item index (zero-based).
144      */
145     public void setItem(int item) {
146         this.item = item;
147     }
148
149     /**
150      * Tests the entity for equality with an arbitrary object.
151      *
152      * @param obj the object (<code>null</code> permitted).
153      *
154      * @return A boolean.
155      */
156     public boolean equals(Object JavaDoc obj) {
157         if (obj == this) {
158             return true;
159         }
160         if (obj instanceof XYItemEntity && super.equals(obj)) {
161             XYItemEntity ie = (XYItemEntity) obj;
162             if (this.series != ie.series) {
163                 return false;
164             }
165             if (this.item != ie.item) {
166                 return false;
167             }
168             return true;
169         }
170         return false;
171     }
172
173     /**
174      * Returns a string representation of this instance, useful for debugging
175      * purposes.
176      *
177      * @return A string.
178      */
179     public String JavaDoc toString() {
180         return "XYItemEntity: series = " + getSeriesIndex() + ", item = "
181             + getItem() + ", dataset = " + getDataset();
182     }
183     
184 }
185
Popular Tags