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 * KeyedValues2D.java
029 * ------------------
030 * (C) Copyright 2002-2022, by David Gilbert.
031 *
032 * Original Author:  David Gilbert;
033 * Contributor(s):   -;
034 *
035 */
036
037package org.jfree.data;
038
039import java.util.List;
040
041/**
042 * An extension of the {@link Values2D} interface where a unique key is
043 * associated with the row and column indices.
044 */
045public interface KeyedValues2D<R extends Comparable<R>, C extends Comparable<C>> 
046        extends Values2D {
047
048    /**
049     * Returns the row key for a given index.
050     *
051     * @param row  the row index (zero-based).
052     *
053     * @return The row key.
054     *
055     * @throws IndexOutOfBoundsException if {@code row} is out of bounds.
056     */
057    R getRowKey(int row);
058
059    /**
060     * Returns the row index for a given key.
061     *
062     * @param key  the row key.
063     *
064     * @return The row index, or a negative value if the key is unrecognised.
065     */
066    int getRowIndex(R key);
067
068    /**
069     * Returns the row keys.
070     *
071     * @return The keys.
072     */
073    List<R> getRowKeys();
074
075    /**
076     * Returns the column key for a given index.
077     *
078     * @param column  the column index (zero-based).
079     *
080     * @return The column key.
081     *
082     * @throws IndexOutOfBoundsException if {@code row} is out of bounds.
083     */
084    C getColumnKey(int column);
085
086    /**
087     * Returns the column index for a given key.
088     *
089     * @param key  the column key.
090     *
091     * @return The column index, or {@code -1} if the key is unrecognised.
092     */
093    int getColumnIndex(C key);
094
095    /**
096     * Returns the column keys.
097     *
098     * @return The keys.
099     */
100    List<C> getColumnKeys();
101
102    /**
103     * Returns the value associated with the specified keys.
104     *
105     * @param rowKey  the row key ({@code null} not permitted).
106     * @param columnKey  the column key ({@code null} not permitted).
107     *
108     * @return The value.
109     *
110     * @throws UnknownKeyException if either key is not recognised.
111     */
112    Number getValue(R rowKey, C columnKey);
113
114}