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: * VectorSeries.java
029: * -----------------
030: * (C) Copyright 2007, by Object Refinery Limited.
031: *
032: * Original Author: David Gilbert (for Object Refinery Limited);
033: * Contributor(s): -;
034: *
035: * $Id: VectorSeries.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() --> getVectorXValue(), and likewise
041: * for getDeltaYValue() (DG);
042: * 25-May-2007 : Added remove(int) and clear() methods, and moved from the
043: * experimental to the main source tree (DG);
044: *
045: */
046:
047: package org.jfree.data.xy;
048:
049: import org.jfree.data.ComparableObjectItem;
050: import org.jfree.data.ComparableObjectSeries;
051: import org.jfree.data.general.SeriesChangeEvent;
052:
053: /**
054: * A list of (x,y, deltaX, deltaY) data items.
055: *
056: * @since 1.0.6
057: *
058: * @see VectorSeriesCollection
059: */
060: public class VectorSeries extends ComparableObjectSeries {
061:
062: /**
063: * Creates a new empty series.
064: *
065: * @param key the series key (<code>null</code> not permitted).
066: */
067: public VectorSeries(Comparable key) {
068: this (key, false, true);
069: }
070:
071: /**
072: * Constructs a new series that contains no data. You can specify
073: * whether or not duplicate x-values are allowed for the series.
074: *
075: * @param key the series key (<code>null</code> not permitted).
076: * @param autoSort a flag that controls whether or not the items in the
077: * series are sorted.
078: * @param allowDuplicateXValues a flag that controls whether duplicate
079: * x-values are allowed.
080: */
081: public VectorSeries(Comparable key, boolean autoSort,
082: boolean allowDuplicateXValues) {
083: super (key, autoSort, allowDuplicateXValues);
084: }
085:
086: /**
087: * Adds a data item to the series.
088: *
089: * @param x the x-value.
090: * @param y the y-value.
091: * @param deltaX the vector x.
092: * @param deltaY the vector y.
093: */
094: public void add(double x, double y, double deltaX, double deltaY) {
095: super .add(new VectorDataItem(x, y, deltaX, deltaY), true);
096: }
097:
098: /**
099: * Removes the item at the specified index and sends a
100: * {@link SeriesChangeEvent} to all registered listeners.
101: *
102: * @param index the index.
103: *
104: * @return The item removed.
105: */
106: public ComparableObjectItem remove(int index) {
107: VectorDataItem result = (VectorDataItem) this .data
108: .remove(index);
109: fireSeriesChanged();
110: return result;
111: }
112:
113: /**
114: * Removes all data items from the series and sends a
115: * {@link SeriesChangeEvent} to all registered listeners.
116: */
117: public void clear() {
118: if (this .data.size() > 0) {
119: this .data.clear();
120: fireSeriesChanged();
121: }
122: }
123:
124: /**
125: * Returns the x-value for the specified item.
126: *
127: * @param index the item index.
128: *
129: * @return The x-value.
130: */
131: public double getXValue(int index) {
132: VectorDataItem item = (VectorDataItem) this .getDataItem(index);
133: return item.getXValue();
134: }
135:
136: /**
137: * Returns the y-value for the specified item.
138: *
139: * @param index the item index.
140: *
141: * @return The y-value.
142: */
143: public double getYValue(int index) {
144: VectorDataItem item = (VectorDataItem) getDataItem(index);
145: return item.getYValue();
146: }
147:
148: /**
149: * Returns the x-component of the vector for an item in the series.
150: *
151: * @param index the item index.
152: *
153: * @return The x-component of the vector.
154: */
155: public double getVectorXValue(int index) {
156: VectorDataItem item = (VectorDataItem) getDataItem(index);
157: return item.getVectorX();
158: }
159:
160: /**
161: * Returns the y-component of the vector for an item in the series.
162: *
163: * @param index the item index.
164: *
165: * @return The y-component of the vector.
166: */
167: public double getVectorYValue(int index) {
168: VectorDataItem item = (VectorDataItem) getDataItem(index);
169: return item.getVectorY();
170: }
171:
172: /**
173: * Returns the data item at the specified index.
174: *
175: * @param index the item index.
176: *
177: * @return The data item.
178: */
179: public ComparableObjectItem getDataItem(int index) {
180: // overridden to make public
181: return super.getDataItem(index);
182: }
183:
184: }
|