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 * VectorXYDataset.java
029 * --------------------
030 * (C) Copyright 2007, by Object Refinery Limited and Contributors.
031 *
032 * Original Author: David Gilbert (for Object Refinery Limited);
033 * Contributor(s): -;
034 *
035 * $Id: VectorXYDataset.java,v 1.1.2.1 2007/05/25 14:44:38 mungady Exp $
036 *
037 * Changes
038 * -------
039 * 30-Jan-2007 : Version 1 (DG);
040 * 24-May-2007 : Renamed getDeltaXValue() as getVectorXValue(), and likewise
041 * for getDeltaYValue(), and replaced getDeltaX()/getDeltaY()
042 * with getVector() (DG);
043 * 25-May-2007 : Moved from experimental to the main source tree (DG);
044 *
045 */
046
047 package org.jfree.data.xy;
048
049
050
051 /**
052 * An extension of the {@link XYDataset} interface that allows a vector to be
053 * defined at a specific (x, y) location.
054 *
055 * @since 1.0.6
056 */
057 public interface VectorXYDataset extends XYDataset {
058
059 /**
060 * Returns the x-component of the vector for an item in a series.
061 *
062 * @param series the series index.
063 * @param item the item index.
064 *
065 * @return The x-component of the vector.
066 */
067 public double getVectorXValue(int series, int item);
068
069 /**
070 * Returns the y-component of the vector for an item in a series.
071 *
072 * @param series the series index.
073 * @param item the item index.
074 *
075 * @return The y-component of the vector.
076 */
077 public double getVectorYValue(int series, int item);
078
079 /**
080 * Returns the vector for an item in a series. Depending on the particular
081 * dataset implementation, this may involve creating a new {@link Vector}
082 * instance --- if you are just interested in the x and y components,
083 * use the {@link #getVectorXValue(int, int)} and
084 * {@link #getVectorYValue(int, int)} methods instead.
085 *
086 * @param series the series index.
087 * @param item the item index.
088 *
089 * @return The vector (possibly <code>null</code>).
090 */
091 public Vector getVector(int series, int item);
092
093 }