    001/* ===========================================================
    002 * Orson Charts : a 3D chart library for the Java(tm) platform
    003 * ===========================================================
    004 *
    005 * (C)opyright 2013-2016, by Object Refinery Limited.  All rights reserved.
    006 *
    007 * http://www.object-refinery.com/orsoncharts/index.html
    008 *
    009 * This program is free software: you can redistribute it and/or modify
    010 * it under the terms of the GNU General Public License as published by
    011 * the Free Software Foundation, either version 3 of the License, or
    012 * (at your option) any later version.
    013 *
    014 * This program is distributed in the hope that it will be useful,
    015 * but WITHOUT ANY WARRANTY; without even the implied warranty of
    016 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    017 * GNU General Public License for more details.
    018 *
    019 * You should have received a copy of the GNU General Public License
    020 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
    021 *
    022 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates.
    023 * Other names may be trademarks of their respective owners.]
    024 *
    025 * If you do not wish to be bound by the terms of the GPL, an alternative
    026 * commercial license can be purchased.  For details, please see visit the
    027 * Orson Charts home page:
    028 *
    029 * http://www.object-refinery.com/orsoncharts/index.html
    030 *
    031 */
    032
    033package com.orsoncharts.data;
    034
    035import java.util.EventObject;
    036
    037/**
    038 * A dataset change event.  Any object that implements the
    039 * {@link Dataset3DChangeListener} interface can register with a dataset to
    040 * receive notification of change events.  By default, the plot classes in
    041 * Orson Charts register with their dataset to monitor dataset changes.
    042 * <br><br>
    043 * NOTE: This class is serializable, but the serialization format is subject
    044 * to change in future releases and should not be relied upon for persisting
    045 * instances of this class.
    046 */
    047@SuppressWarnings("serial")
    048public class Dataset3DChangeEvent extends EventObject {
    049
    050    private Object dataset;
    051
    052    /**
    053     * Creates a new dataset change event.  The source can be the same as the
    054     * dataset, but this is not required.
    055     *
    056     * @param source  the source.
    057     * @param dataset  the dataset.
    058     */
    059    public Dataset3DChangeEvent(Object source, Object dataset) {
    060        super(source);
    061        this.dataset = dataset;
    062    }
    063
    064    /**
    065     * Returns the dataset that this event is associated with.  This will
    066     * normally be an instance of {@link PieDataset3D},
    067     * {@link com.orsoncharts.data.category.CategoryDataset3D} or
    068     * {@link com.orsoncharts.data.xyz.XYZDataset}.
    069     *
    070     * @return The dataset.
    071     */
    072    public Object getDataset() {
    073        return this.dataset;
    074    }
    075}