001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-present, 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 * VectorDataItem.java
029 * -------------------
030 * (C) Copyright 2007-present, 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;
040
041/**
042 * A data item representing data in the form (x, y, deltaX, deltaY), intended
043 * for use by the {@link VectorSeries} class.
044 */
045public class VectorDataItem extends ComparableObjectItem {
046
047    /**
048     * Creates a new {@code VectorDataItem} instance.
049     *
050     * @param x  the x-value.
051     * @param y  the y-value.
052     * @param deltaX  the vector x.
053     * @param deltaY  the vector y.
054     */
055    public VectorDataItem(double x, double y, double deltaX, double deltaY) {
056        super(new XYCoordinate(x, y), new Vector(deltaX, deltaY));
057    }
058
059    /**
060     * Returns the x-value.
061     *
062     * @return The x-value (never {@code null}).
063     */
064    public double getXValue() {
065        XYCoordinate xy = (XYCoordinate) getComparable();
066        return xy.getX();
067    }
068
069    /**
070     * Returns the y-value.
071     *
072     * @return The y-value.
073     */
074    public double getYValue() {
075        XYCoordinate xy = (XYCoordinate) getComparable();
076        return xy.getY();
077    }
078
079    /**
080     * Returns the vector.
081     *
082     * @return The vector (possibly {@code null}).
083     */
084    public Vector getVector() {
085        return (Vector) getObject();
086    }
087
088    /**
089     * Returns the x-component for the vector.
090     *
091     * @return The x-component.
092     */
093    public double getVectorX() {
094        Vector vi = (Vector) getObject();
095        if (vi != null) {
096            return vi.getX();
097        }
098        else {
099            return Double.NaN;
100        }
101    }
102
103    /**
104     * Returns the y-component for the vector.
105     *
106     * @return The y-component.
107     */
108    public double getVectorY() {
109        Vector vi = (Vector) getObject();
110        if (vi != null) {
111            return vi.getY();
112        }
113        else {
114            return Double.NaN;
115        }
116    }
117
118}