KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jfree > data > general > DatasetChangeEvent


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
20  * License along with this library; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
22  * USA.
23  *
24  * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
25  * in the United States and other countries.]
26  *
27  * -----------------------
28  * DatasetChangeEvent.java
29  * -----------------------
30  * (C) Copyright 2000-2004, by Object Refinery Limited.
31  *
32  * Original Author: David Gilbert (for Object Refinery Limited);
33  * Contributor(s): -;
34  *
35  * $Id: DatasetChangeEvent.java,v 1.3.2.1 2005/10/25 21:32:29 mungady Exp $
36  *
37  * Changes (from 24-Aug-2001)
38  * --------------------------
39  * 24-Aug-2001 : Added standard source header. Fixed DOS encoding problem (DG);
40  * 15-Oct-2001 : Move to new package (com.jrefinery.data.*) (DG);
41  * 22-Oct-2001 : Renamed DataSource.java --> Dataset.java etc. (DG);
42  * 11-Jun-2002 : Separated the event source from the dataset to cover the case
43  * where the dataset is changed to null in the Plot class.
44  * Updated Javadocs (DG);
45  * 04-Oct-2002 : Fixed errors reported by Checkstyle (DG);
46  * 05-Oct-2004 : Minor Javadoc updates (DG);
47  *
48  */
49
50 package org.jfree.data.general;
51
52 /**
53  * A change event that encapsulates information about a change to a dataset.
54  */
55 public class DatasetChangeEvent extends java.util.EventObject JavaDoc {
56
57     /**
58      * The dataset that generated the change event.
59      */
60     private Dataset dataset;
61
62     /**
63      * Constructs a new event. The source is either the dataset or the
64      * {@link org.jfree.chart.plot.Plot} class. The dataset can be
65      * <code>null</code> (in this case the source will be the
66      * {@link org.jfree.chart.plot.Plot} class).
67      *
68      * @param source the source of the event.
69      * @param dataset the dataset that generated the event (<code>null</code>
70      * permitted).
71      */
72     public DatasetChangeEvent(Object JavaDoc source, Dataset dataset) {
73         super(source);
74         this.dataset = dataset;
75     }
76
77     /**
78      * Returns the dataset that generated the event. Note that the dataset
79      * may be <code>null</code> since adding a <code>null</code> dataset to a
80      * plot will generated a change event.
81      *
82      * @return The dataset (possibly <code>null</code>).
83      */
84     public Dataset getDataset() {
85         return this.dataset;
86     }
87
88 }
89
Popular Tags