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: * SymbolicXYItemLabelGenerator.java 29: * --------------------------------- 30: * (C) Copyright 2001-2007, by Anthony Boulestreau and Contributors. 31: * 32: * Original Author: Anthony Boulestreau; 33: * Contributor(s): David Gilbert (for Object Refinery Limited); 34: * 35: * Changes 36: * ------- 37: * 29-Mar-2002 : Version 1, contributed by Anthony Boulestreau (DG); 38: * 26-Sep-2002 : Fixed errors reported by Checkstyle (DG); 39: * 23-Mar-2003 : Implemented Serializable (DG); 40: * 13-Aug-2003 : Implemented Cloneable (DG); 41: * 17-Nov-2003 : Implemented PublicCloneable (DG); 42: * 25-Feb-2004 : Renamed XYToolTipGenerator --> XYItemLabelGenerator (DG); 43: * 19-Jan-2005 : Now accesses primitives only from dataset (DG); 44: * 20-Apr-2005 : Renamed XYLabelGenerator --> XYItemLabelGenerator (DG); 45: * 02-Feb-2007 : Removed author tags all over JFreeChart sources (DG); 46: * 47: */ 48: 49: package org.jfree.chart.labels; 50: 51: import java.io.Serializable; 52: 53: import org.jfree.data.time.RegularTimePeriod; 54: import org.jfree.data.time.TimeSeriesCollection; 55: import org.jfree.data.xy.XYDataset; 56: import org.jfree.data.xy.XisSymbolic; 57: import org.jfree.data.xy.YisSymbolic; 58: import org.jfree.util.PublicCloneable; 59: 60: /** 61: * A standard item label generator for plots that use data from an 62: * {@link XYDataset}. 63: */ 64: public class SymbolicXYItemLabelGenerator implements XYItemLabelGenerator, 65: XYToolTipGenerator, 66: Cloneable, 67: PublicCloneable, 68: Serializable { 69: 70: /** For serialization. */ 71: private static final long serialVersionUID = 3963400354475494395L; 72: 73: /** 74: * Generates a tool tip text item for a particular item within a series. 75: * 76: * @param data the dataset. 77: * @param series the series number (zero-based index). 78: * @param item the item number (zero-based index). 79: * 80: * @return The tool tip text (possibly <code>null</code>). 81: */ 82: public String generateToolTip(XYDataset data, int series, int item) { 83: 84: String xStr, yStr; 85: if (data instanceof YisSymbolic) { 86: yStr = ((YisSymbolic) data).getYSymbolicValue(series, item); 87: } 88: else { 89: double y = data.getYValue(series, item); 90: yStr = Double.toString(round(y, 2)); 91: } 92: if (data instanceof XisSymbolic) { 93: xStr = ((XisSymbolic) data).getXSymbolicValue(series, item); 94: } 95: else if (data instanceof TimeSeriesCollection) { 96: RegularTimePeriod p 97: = ((TimeSeriesCollection) data).getSeries(series) 98: .getTimePeriod(item); 99: xStr = p.toString(); 100: } 101: else { 102: double x = data.getXValue(series, item); 103: xStr = Double.toString(round(x, 2)); 104: } 105: return "X: " + xStr + ", Y: " + yStr; 106: } 107: 108: /** 109: * Generates a label for the specified item. The label is typically a 110: * formatted version of the data value, but any text can be used. 111: * 112: * @param dataset the dataset (<code>null</code> not permitted). 113: * @param series the series index (zero-based). 114: * @param category the category index (zero-based). 115: * 116: * @return The label (possibly <code>null</code>). 117: */ 118: public String generateLabel(XYDataset dataset, int series, int category) { 119: return null; //TODO: implement this method properly 120: } 121: 122: /** 123: * Round a double value. 124: * 125: * @param value the value. 126: * @param nb the exponent. 127: * 128: * @return The rounded value. 129: */ 130: private static double round(double value, int nb) { 131: if (nb <= 0) { 132: return Math.floor(value + 0.5d); 133: } 134: double p = Math.pow(10, nb); 135: double tempval = Math.floor(value * p + 0.5d); 136: return tempval / p; 137: } 138: 139: /** 140: * Returns an independent copy of the generator. 141: * 142: * @return A clone. 143: * 144: * @throws CloneNotSupportedException if cloning is not supported. 145: */ 146: public Object clone() throws CloneNotSupportedException { 147: return super.clone(); 148: } 149: 150: /** 151: * Tests if this object is equal to another. 152: * 153: * @param obj the other object. 154: * 155: * @return A boolean. 156: */ 157: public boolean equals(Object obj) { 158: if (obj == this) { 159: return true; 160: } 161: if (obj instanceof SymbolicXYItemLabelGenerator) { 162: return true; 163: } 164: return false; 165: } 166: 167: }