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 * YisSymbolic.java
029 * ----------------
030 * (C) Copyright 2006-present, by Anthony Boulestreau and Contributors.
031 *
032 * Original Author:  Anthony Boulestreau;
033 * Contributor(s):   David Gilbert;
034 *
035 */
036
037package org.jfree.data.xy;
038
039/**
040 * Represent a data set where Y is a symbolic values. Each symbolic value is
041 * linked with an Integer.
042 */
043public interface YisSymbolic {
044
045    /**
046     * Returns the list of symbolic values.
047     *
048     * @return The symbolic values.
049     */
050    String[] getYSymbolicValues();
051
052    /**
053     * Returns the symbolic value of the data set specified by
054     * {@code series} and {@code item} parameters.
055     *
056     * @param series  the series index (zero-based).
057     * @param item  the item index (zero-based).
058     *
059     * @return The symbolic value.
060     */
061    String getYSymbolicValue(int series, int item);
062
063    /**
064     * Returns the symbolic value linked with the specified {@code Integer}.
065     *
066     * @param val  value of the integer linked with the symbolic value.
067     *
068     * @return The symbolic value.
069     */
070    String getYSymbolicValue(Integer val);
071
072}