Frames | No Frames |
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: * VectorXYDataset.java 29: * -------------------- 30: * (C) Copyright 2007, by Object Refinery Limited and Contributors. 31: * 32: * Original Author: David Gilbert (for Object Refinery Limited); 33: * Contributor(s): -; 34: * 35: * Changes 36: * ------- 37: * 30-Jan-2007 : Version 1 (DG); 38: * 24-May-2007 : Renamed getDeltaXValue() as getVectorXValue(), and likewise 39: * for getDeltaYValue(), and replaced getDeltaX()/getDeltaY() 40: * with getVector() (DG); 41: * 25-May-2007 : Moved from experimental to the main source tree (DG); 42: * 43: */ 44: 45: package org.jfree.data.xy; 46: 47: 48: 49: /** 50: * An extension of the {@link XYDataset} interface that allows a vector to be 51: * defined at a specific (x, y) location. 52: * 53: * @since 1.0.6 54: */ 55: public interface VectorXYDataset extends XYDataset { 56: 57: /** 58: * Returns the x-component of the vector for an item in a series. 59: * 60: * @param series the series index. 61: * @param item the item index. 62: * 63: * @return The x-component of the vector. 64: */ 65: public double getVectorXValue(int series, int item); 66: 67: /** 68: * Returns the y-component of the vector for an item in a series. 69: * 70: * @param series the series index. 71: * @param item the item index. 72: * 73: * @return The y-component of the vector. 74: */ 75: public double getVectorYValue(int series, int item); 76: 77: /** 78: * Returns the vector for an item in a series. Depending on the particular 79: * dataset implementation, this may involve creating a new {@link Vector} 80: * instance --- if you are just interested in the x and y components, 81: * use the {@link #getVectorXValue(int, int)} and 82: * {@link #getVectorYValue(int, int)} methods instead. 83: * 84: * @param series the series index. 85: * @param item the item index. 86: * 87: * @return The vector (possibly <code>null</code>). 88: */ 89: public Vector getVector(int series, int item); 90: 91: }