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 * AbstractXYDataset.java
029 * ----------------------
030 * (C) Copyright 2004-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.DomainOrder;
040import org.jfree.data.general.AbstractSeriesDataset;
041
042/**
043 * An base class that you can use to create new implementations of the
044 * {@link XYDataset} interface.
045 * 
046 * @param <S> type for the series keys.
047 */
048public abstract class AbstractXYDataset<S extends Comparable<S>> 
049        extends AbstractSeriesDataset<S> implements XYDataset<S> {
050
051    /**
052     * Returns the order of the domain (X) values.
053     *
054     * @return The domain order.
055     */
056    @Override
057    public DomainOrder getDomainOrder() {
058        return DomainOrder.NONE;
059    }
060
061    /**
062     * Returns the x-value (as a double primitive) for an item within a series.
063     *
064     * @param series  the series index (zero-based).
065     * @param item  the item index (zero-based).
066     *
067     * @return The value.
068     */
069    @Override
070    public double getXValue(int series, int item) {
071        double result = Double.NaN;
072        Number x = getX(series, item);
073        if (x != null) {
074            result = x.doubleValue();
075        }
076        return result;
077    }
078
079    /**
080     * Returns the y-value (as a double primitive) for an item within a series.
081     *
082     * @param series  the series index (zero-based).
083     * @param item  the item index (zero-based).
084     *
085     * @return The value.
086     */
087    @Override
088    public double getYValue(int series, int item) {
089        double result = Double.NaN;
090        Number y = getY(series, item);
091        if (y != null) {
092            result = y.doubleValue();
093        }
094        return result;
095    }
096
097}