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