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