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: * VectorSeries.java 29: * ----------------- 30: * (C) Copyright 2007, by Object Refinery Limited. 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() --> getVectorXValue(), and likewise 39: * for getDeltaYValue() (DG); 40: * 25-May-2007 : Added remove(int) and clear() methods, and moved from the 41: * experimental to the main source tree (DG); 42: * 43: */ 44: 45: package org.jfree.data.xy; 46: 47: import org.jfree.data.ComparableObjectItem; 48: import org.jfree.data.ComparableObjectSeries; 49: import org.jfree.data.general.SeriesChangeEvent; 50: 51: /** 52: * A list of (x,y, deltaX, deltaY) data items. 53: * 54: * @since 1.0.6 55: * 56: * @see VectorSeriesCollection 57: */ 58: public class VectorSeries extends ComparableObjectSeries { 59: 60: /** 61: * Creates a new empty series. 62: * 63: * @param key the series key (<code>null</code> not permitted). 64: */ 65: public VectorSeries(Comparable key) { 66: this(key, false, true); 67: } 68: 69: /** 70: * Constructs a new series that contains no data. You can specify 71: * whether or not duplicate x-values are allowed for the series. 72: * 73: * @param key the series key (<code>null</code> not permitted). 74: * @param autoSort a flag that controls whether or not the items in the 75: * series are sorted. 76: * @param allowDuplicateXValues a flag that controls whether duplicate 77: * x-values are allowed. 78: */ 79: public VectorSeries(Comparable key, boolean autoSort, 80: boolean allowDuplicateXValues) { 81: super(key, autoSort, allowDuplicateXValues); 82: } 83: 84: /** 85: * Adds a data item to the series. 86: * 87: * @param x the x-value. 88: * @param y the y-value. 89: * @param deltaX the vector x. 90: * @param deltaY the vector y. 91: */ 92: public void add(double x, double y, double deltaX, double deltaY) { 93: super.add(new VectorDataItem(x, y, deltaX, deltaY), true); 94: } 95: 96: /** 97: * Removes the item at the specified index and sends a 98: * {@link SeriesChangeEvent} to all registered listeners. 99: * 100: * @param index the index. 101: * 102: * @return The item removed. 103: */ 104: public ComparableObjectItem remove(int index) { 105: VectorDataItem result = (VectorDataItem) this.data.remove(index); 106: fireSeriesChanged(); 107: return result; 108: } 109: 110: /** 111: * Removes all data items from the series and sends a 112: * {@link SeriesChangeEvent} to all registered listeners. 113: */ 114: public void clear() { 115: if (this.data.size() > 0) { 116: this.data.clear(); 117: fireSeriesChanged(); 118: } 119: } 120: 121: /** 122: * Returns the x-value for the specified item. 123: * 124: * @param index the item index. 125: * 126: * @return The x-value. 127: */ 128: public double getXValue(int index) { 129: VectorDataItem item = (VectorDataItem) this.getDataItem(index); 130: return item.getXValue(); 131: } 132: 133: /** 134: * Returns the y-value for the specified item. 135: * 136: * @param index the item index. 137: * 138: * @return The y-value. 139: */ 140: public double getYValue(int index) { 141: VectorDataItem item = (VectorDataItem) getDataItem(index); 142: return item.getYValue(); 143: } 144: 145: /** 146: * Returns the x-component of the vector for an item in the series. 147: * 148: * @param index the item index. 149: * 150: * @return The x-component of the vector. 151: */ 152: public double getVectorXValue(int index) { 153: VectorDataItem item = (VectorDataItem) getDataItem(index); 154: return item.getVectorX(); 155: } 156: 157: /** 158: * Returns the y-component of the vector for an item in the series. 159: * 160: * @param index the item index. 161: * 162: * @return The y-component of the vector. 163: */ 164: public double getVectorYValue(int index) { 165: VectorDataItem item = (VectorDataItem) getDataItem(index); 166: return item.getVectorY(); 167: } 168: 169: /** 170: * Returns the data item at the specified index. 171: * 172: * @param index the item index. 173: * 174: * @return The data item. 175: */ 176: public ComparableObjectItem getDataItem(int index) { 177: // overridden to make public 178: return super.getDataItem(index); 179: } 180: 181: }