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 under the terms

  10.  * of the GNU Lesser General Public License as published by the Free Software Foundation;

  11.  * either version 2.1 of the License, or (at your option) any later version.

  12.  *

  13.  * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;

  14.  * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

  15.  * See the GNU Lesser General Public License for more details.

  16.  *

  17.  * You should have received a copy of the GNU Lesser General Public License along with this

  18.  * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,

  19.  * Boston, MA 02111-1307, USA.

  20.  *

  21.  * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 

  22.  * in the United States and other countries.]

  23.  *

  24.  * ------------

  25.  * Dataset.java

  26.  * ------------

  27.  * (C) Copyright 2000-2005, by Object Refinery Limited.

  28.  *

  29.  * Original Author:  David Gilbert (for Object Refinery Limited);

  30.  * Contributor(s):   -;

  31.  *

  32.  * $Id: Dataset.java,v 1.2 2005/01/11 15:24:07 mungady Exp $

  33.  *

  34.  * Changes (from 18-Sep-2001)

  35.  * --------------------------

  36.  * 18-Sep-2001 : Added standard header and fixed DOS encoding problem (DG);

  37.  * 15-Oct-2001 : Moved to a new package (com.jrefinery.data.*) (DG);

  38.  * 22-Oct-2001 : Changed name to Dataset.java (DG);

  39.  * 17-Nov-2001 : Added getLegendItemCount() and getLegendItemLabels() methods, created

  40.  *               SeriesDataset interface and transferred series related methods out (DG);

  41.  * 22-Jan-2002 : Reconsidered (and removed) the getLegendItemCount() and getLegendItemLabels()

  42.  *               methods...leave this to client code (DG);

  43.  * 27-Sep-2002 : Added get/setDatasetGroup() methods (DG);

  44.  * 10-Jan-2003 : Updated Javadocs (DG);

  45.  *

  46.  */

  47. 

  48. package org.jfree.data.general;

  49. 

  50. /**

  51.  * The base interface for data sets.

  52.  * <P>

  53.  * All datasets are required to support the {@link DatasetChangeEvent} mechanism by allowing

  54.  * listeners to register and receive notification of any changes to the dataset.

  55.  * <P>

  56.  * In addition, all datasets must belong to one (and only one) {@link DatasetGroup}.  The group

  57.  * object maintains a reader-writer lock which provides synchronised access to the datasets in

  58.  * multi-threaded code.

  59.  *

  60.  *

  61.  */

  62. public interface Dataset {

  63. 

  64.     /**

  65.      * Registers an object for notification of changes to the dataset.

  66.      *

  67.      * @param listener  the object to register.

  68.      */

  69.     public void addChangeListener(DatasetChangeListener listener);

  70. 

  71.     /**

  72.      * Deregisters an object for notification of changes to the dataset.

  73.      *

  74.      * @param listener  the object to deregister.

  75.      */

  76.     public void removeChangeListener(DatasetChangeListener listener);

  77. 

  78.     /**

  79.      * Returns the dataset group.

  80.      *

  81.      * @return The dataset group.

  82.      */

  83.     public DatasetGroup getGroup();

  84. 

  85.     /**

  86.      * Sets the dataset group.

  87.      *

  88.      * @param group  the dataset group.

  89.      */

  90.     public void setGroup(DatasetGroup group);

  91. 

  92. }