001 /* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-2007, by Object Refinery Limited and Contributors.
006 *
007 * Project Info: http://www.jfree.org/jfreechart/index.html
008 *
009 * This library is free software; you can redistribute it and/or modify it
010 * under the terms of the GNU Lesser General Public License as published by
011 * the Free Software Foundation; either version 2.1 of the License, or
012 * (at your option) any later version.
013 *
014 * This library is distributed in the hope that it will be useful, but
015 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
016 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
017 * License for more details.
018 *
019 * You should have received a copy of the GNU Lesser General Public
020 * License along with this library; if not, write to the Free Software
021 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
022 * USA.
023 *
024 * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
025 * in the United States and other countries.]
026 *
027 * -----------------------
028 * CombinationDataset.java
029 * -----------------------
030 * (C) Copyright 2001-2007, by Bill Kelemen.
031 *
032 * Original Author: Bill Kelemen;
033 * Contributor(s): -;
034 *
035 * Changes
036 * -------
037 * 06-Dec-2001 : Version 1 (BK);
038 * ------------- JFREECHART 1.0.x ---------------------------------------------
039 * 02-Feb-2007 : Removed author tags from all over JFreeChart sources (DG);
040 *
041 */
042
043 package org.jfree.data.general;
044
045 /**
046 * Interface that describes the new methods that any combined dataset needs to
047 * implement. A combined dataset object will combine one or more datasets and
048 * expose a sub-set or union of the combined datasets.
049 */
050 public interface CombinationDataset {
051
052 ///////////////////////////////////////////////////////////////////////////
053 // New methods from CombinationDataset
054 ///////////////////////////////////////////////////////////////////////////
055
056 /**
057 * Returns the parent Dataset of this combination. If there is more than
058 * one parent, or a child is found that is not a combination, then returns
059 * <code>null</code>.
060 *
061 * @return The parent Dataset of this combination.
062 */
063 public SeriesDataset getParent();
064
065 /**
066 * Returns a map or indirect indexing form our series into parent's series.
067 *
068 * @return A map or indirect indexing form our series into parent's series.
069 */
070 public int[] getMap();
071
072 }