Source for org.jfree.data.general.CombinationDataset

   1: /* ===========================================================
   2:  * JFreeChart : a free chart library for the Java(tm) platform
   3:  * ===========================================================
   4:  *
   5:  * (C) Copyright 2000-2007, 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:  * CombinationDataset.java
  29:  * -----------------------
  30:  * (C) Copyright 2001-2007, by Bill Kelemen.
  31:  *
  32:  * Original Author:  Bill Kelemen;
  33:  * Contributor(s):   -;
  34:  *
  35:  * Changes
  36:  * -------
  37:  * 06-Dec-2001 : Version 1 (BK);
  38:  * ------------- JFREECHART 1.0.x ---------------------------------------------
  39:  * 02-Feb-2007 : Removed author tags from all over JFreeChart sources (DG);
  40:  *
  41:  */
  42: 
  43: package org.jfree.data.general;
  44: 
  45: /**
  46:  * Interface that describes the new methods that any combined dataset needs to
  47:  * implement. A combined dataset object will combine one or more datasets and
  48:  * expose a sub-set or union of the combined datasets.
  49:  */
  50: public interface CombinationDataset {
  51: 
  52:     ///////////////////////////////////////////////////////////////////////////
  53:     // New methods from CombinationDataset
  54:     ///////////////////////////////////////////////////////////////////////////
  55: 
  56:     /**
  57:      * Returns the parent Dataset of this combination. If there is more than
  58:      * one parent, or a child is found that is not a combination, then returns
  59:      * <code>null</code>.
  60:      *
  61:      * @return The parent Dataset of this combination.
  62:      */
  63:     public SeriesDataset getParent();
  64: 
  65:     /**
  66:      * Returns a map or indirect indexing form our series into parent's series.
  67:      *
  68:      * @return A map or indirect indexing form our series into parent's series.
  69:      */
  70:     public int[] getMap();
  71: 
  72: }