Frames | No Frames |
1: /* =========================================================== 2: * JFreeChart : a free chart library for the Java(tm) platform 3: * =========================================================== 4: * 5: * (C) Copyright 2000-2007, by Object Refinery Limited and Contributors. 6: * 7: * Project Info: http://www.jfree.org/jfreechart/index.html 8: * 9: * This library is free software; you can redistribute it and/or modify it 10: * under the terms of the GNU Lesser General Public License as published by 11: * the Free Software Foundation; either version 2.1 of the License, or 12: * (at your option) any later version. 13: * 14: * This library is distributed in the hope that it will be useful, but 15: * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 16: * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 17: * License for more details. 18: * 19: * You should have received a copy of the GNU Lesser General Public 20: * License along with this library; if not, write to the Free Software 21: * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 22: * USA. 23: * 24: * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 25: * in the United States and other countries.] 26: * 27: * ------------------ 28: * KeyedValues2D.java 29: * ------------------ 30: * (C) Copyright 2002-2007, by Object Refinery Limited. 31: * 32: * Original Author: David Gilbert (for Object Refinery Limited); 33: * Contributor(s): -; 34: * 35: * Changes 36: * ------- 37: * 28-Oct-2002 : Version 1 (DG); 38: * 12-Jan-2005 : Updated Javadocs (DG); 39: * 40: */ 41: 42: package org.jfree.data; 43: 44: import java.util.List; 45: 46: /** 47: * An extension of the {@link Values2D} interface where a unique key is 48: * associated with the row and column indices. 49: */ 50: public interface KeyedValues2D extends Values2D { 51: 52: /** 53: * Returns the row key for a given index. 54: * 55: * @param row the row index (zero-based). 56: * 57: * @return The row key. 58: * 59: * @throws IndexOutOfBoundsException if <code>row</code> is out of bounds. 60: */ 61: public Comparable getRowKey(int row); 62: 63: /** 64: * Returns the row index for a given key. 65: * 66: * @param key the row key. 67: * 68: * @return The row index, or <code>-1</code> if the key is unrecognised. 69: */ 70: public int getRowIndex(Comparable key); 71: 72: /** 73: * Returns the row keys. 74: * 75: * @return The keys. 76: */ 77: public List getRowKeys(); 78: 79: /** 80: * Returns the column key for a given index. 81: * 82: * @param column the column index (zero-based). 83: * 84: * @return The column key. 85: * 86: * @throws IndexOutOfBoundsException if <code>row</code> is out of bounds. 87: */ 88: public Comparable getColumnKey(int column); 89: 90: /** 91: * Returns the column index for a given key. 92: * 93: * @param key the column key. 94: * 95: * @return The column index, or <code>-1</code> if the key is unrecognised. 96: */ 97: public int getColumnIndex(Comparable key); 98: 99: /** 100: * Returns the column keys. 101: * 102: * @return The keys. 103: */ 104: public List getColumnKeys(); 105: 106: /** 107: * Returns the value associated with the specified keys. 108: * 109: * @param rowKey the row key (<code>null</code> not permitted). 110: * @param columnKey the column key (<code>null</code> not permitted). 111: * 112: * @return The value. 113: * 114: * @throws UnknownKeyException if either key is not recognised. 115: */ 116: public Number getValue(Comparable rowKey, Comparable columnKey); 117: 118: }