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 * KeyedValues2D.java
029 * ------------------
030 * (C) Copyright 2002-present, 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 extends Values2D {
046
047    /**
048     * Returns the row key for a given index.
049     *
050     * @param row  the row index (zero-based).
051     *
052     * @return The row key.
053     *
054     * @throws IndexOutOfBoundsException if {@code row} is out of bounds.
055     */
056    Comparable getRowKey(int row);
057
058    /**
059     * Returns the row index for a given key.
060     *
061     * @param key  the row key.
062     *
063     * @return The row index, or {@code -1} if the key is unrecognised.
064     */
065    int getRowIndex(Comparable key);
066
067    /**
068     * Returns the row keys.
069     *
070     * @return The keys.
071     */
072    List getRowKeys();
073
074    /**
075     * Returns the column key for a given index.
076     *
077     * @param column  the column index (zero-based).
078     *
079     * @return The column key.
080     *
081     * @throws IndexOutOfBoundsException if {@code row} is out of bounds.
082     */
083    Comparable getColumnKey(int column);
084
085    /**
086     * Returns the column index for a given key.
087     *
088     * @param key  the column key.
089     *
090     * @return The column index, or {@code -1} if the key is unrecognised.
091     */
092    int getColumnIndex(Comparable key);
093
094    /**
095     * Returns the column keys.
096     *
097     * @return The keys.
098     */
099    List getColumnKeys();
100
101    /**
102     * Returns the value associated with the specified keys.
103     *
104     * @param rowKey  the row key ({@code null} not permitted).
105     * @param columnKey  the column key ({@code null} not permitted).
106     *
107     * @return The value.
108     *
109     * @throws UnknownKeyException if either key is not recognised.
110     */
111    Number getValue(Comparable rowKey, Comparable columnKey);
112
113}