001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-2020, 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-2020, by Object Refinery Limited.
031 *
032 * Original Author:  David Gilbert (for Object Refinery Limited);
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 extends ComparableObjectSeries {
051
052    /**
053     * Creates a new empty series.
054     *
055     * @param key  the series key ({@code null} not permitted).
056     */
057    public VectorSeries(Comparable 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(Comparable key, boolean autoSort,
072            boolean allowDuplicateXValues) {
073        super(key, autoSort, allowDuplicateXValues);
074    }
075
076    /**
077     * Adds a data item to the series.
078     *
079     * @param x  the x-value.
080     * @param y  the y-value.
081     * @param deltaX  the vector x.
082     * @param deltaY  the vector y.
083     */
084    public void add(double x, double y, double deltaX, double deltaY) {
085        add(new VectorDataItem(x, y, deltaX, deltaY), true);
086    }
087    
088    /**
089     * Adds a data item to the series and, if requested, sends a 
090     * {@link SeriesChangeEvent} to all registered listeners.
091     * 
092     * @param item  the data item ({@code null} not permitted).
093     * @param notify  notify listeners?
094     * 
095     * @since 1.0.18
096     */
097    public void add(VectorDataItem item, boolean notify) {
098        super.add(item, notify);
099    }
100
101    /**
102     * Removes the item at the specified index and sends a
103     * {@link SeriesChangeEvent} to all registered listeners.
104     *
105     * @param index  the index.
106     *
107     * @return The item removed.
108     */
109    @Override
110    public ComparableObjectItem remove(int index) {
111        VectorDataItem result = (VectorDataItem) this.data.remove(index);
112        fireSeriesChanged();
113        return result;
114    }
115
116    /**
117     * Returns the x-value for the specified item.
118     *
119     * @param index  the item index.
120     *
121     * @return The x-value.
122     */
123    public double getXValue(int index) {
124        VectorDataItem item = (VectorDataItem) this.getDataItem(index);
125        return item.getXValue();
126    }
127
128    /**
129     * Returns the y-value for the specified item.
130     *
131     * @param index  the item index.
132     *
133     * @return The y-value.
134     */
135    public double getYValue(int index) {
136        VectorDataItem item = (VectorDataItem) getDataItem(index);
137        return item.getYValue();
138    }
139
140    /**
141     * Returns the x-component of the vector for an item in the series.
142     *
143     * @param index  the item index.
144     *
145     * @return The x-component of the vector.
146     */
147    public double getVectorXValue(int index) {
148        VectorDataItem item = (VectorDataItem) getDataItem(index);
149        return item.getVectorX();
150    }
151
152    /**
153     * Returns the y-component of the vector for an item in the series.
154     *
155     * @param index  the item index.
156     *
157     * @return The y-component of the vector.
158     */
159    public double getVectorYValue(int index) {
160        VectorDataItem item = (VectorDataItem) getDataItem(index);
161        return item.getVectorY();
162    }
163
164    /**
165     * Returns the data item at the specified index.
166     *
167     * @param index  the item index.
168     *
169     * @return The data item.
170     */
171    @Override
172    public ComparableObjectItem getDataItem(int index) {
173        // overridden to make public
174        return super.getDataItem(index);
175    }
176
177}