001/* =========================================================== 002 * JFreeChart : a free chart library for the Java(tm) platform 003 * =========================================================== 004 * 005 * (C) Copyright 2000-2020, by Object Refinery Limited 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 * MultipleXYSeriesLabelGenerator.java 029 * ----------------------------------- 030 * (C) Copyright 2004-2016, by Object Refinery Limited. 031 * 032 * Original Author: David Gilbert (for Object Refinery Limited); 033 * Contributor(s): -; 034 * 035 * Changes 036 * ------- 037 * 19-Nov-2004 : Version 1 (DG); 038 * 18-Apr-2005 : Use StringBuffer (DG); 039 * 20-Feb-2007 : Fixed for equals() and cloning() (DG); 040 * 31-Mar-2008 : Added hashCode() method to appease FindBugs (DG); 041 * 03-Jul-2013 : Use ParamChecks (DG); 042 * 043 */ 044 045package org.jfree.chart.labels; 046 047import java.io.Serializable; 048import java.text.MessageFormat; 049import java.util.HashMap; 050import java.util.Iterator; 051import java.util.List; 052import java.util.Map; 053import java.util.Set; 054 055import org.jfree.chart.HashUtils; 056import org.jfree.chart.util.Args; 057import org.jfree.chart.util.PublicCloneable; 058import org.jfree.data.xy.XYDataset; 059 060/** 061 * A series label generator for plots that use data from 062 * an {@link org.jfree.data.xy.XYDataset}. 063 */ 064public class MultipleXYSeriesLabelGenerator implements XYSeriesLabelGenerator, 065 Cloneable, PublicCloneable, Serializable { 066 067 /** For serialization. */ 068 private static final long serialVersionUID = 138976236941898560L; 069 070 /** The default item label format. */ 071 public static final String DEFAULT_LABEL_FORMAT = "{0}"; 072 073 /** The format pattern for the initial part of the label. */ 074 private String formatPattern; 075 076 /** The format pattern for additional labels. */ 077 private String additionalFormatPattern; 078 079 /** Storage for the additional series labels. */ 080 private Map seriesLabelLists; 081 082 /** 083 * Creates an item label generator using default number formatters. 084 */ 085 public MultipleXYSeriesLabelGenerator() { 086 this(DEFAULT_LABEL_FORMAT); 087 } 088 089 /** 090 * Creates a new series label generator. 091 * 092 * @param format the format pattern ({@code null} not permitted). 093 */ 094 public MultipleXYSeriesLabelGenerator(String format) { 095 Args.nullNotPermitted(format, "format"); 096 this.formatPattern = format; 097 this.additionalFormatPattern = "\n{0}"; 098 this.seriesLabelLists = new HashMap(); 099 } 100 101 /** 102 * Adds an extra label for the specified series. 103 * 104 * @param series the series index. 105 * @param label the label. 106 */ 107 public void addSeriesLabel(int series, String label) { 108 Integer key = series; 109 List labelList = (List) this.seriesLabelLists.get(key); 110 if (labelList == null) { 111 labelList = new java.util.ArrayList(); 112 this.seriesLabelLists.put(key, labelList); 113 } 114 labelList.add(label); 115 } 116 117 /** 118 * Clears the extra labels for the specified series. 119 * 120 * @param series the series index. 121 */ 122 public void clearSeriesLabels(int series) { 123 this.seriesLabelLists.put(series, null); 124 } 125 126 /** 127 * Generates a label for the specified series. This label will be 128 * used for the chart legend. 129 * 130 * @param dataset the dataset ({@code null} not permitted). 131 * @param series the series. 132 * 133 * @return A series label. 134 */ 135 @Override 136 public String generateLabel(XYDataset dataset, int series) { 137 Args.nullNotPermitted(dataset, "dataset"); 138 StringBuilder label = new StringBuilder(); 139 label.append(MessageFormat.format(this.formatPattern, 140 createItemArray(dataset, series))); 141 List extraLabels = (List) this.seriesLabelLists.get(series); 142 if (extraLabels != null) { 143 Object[] temp = new Object[1]; 144 for (int i = 0; i < extraLabels.size(); i++) { 145 temp[0] = extraLabels.get(i); 146 String labelAddition = MessageFormat.format( 147 this.additionalFormatPattern, temp); 148 label.append(labelAddition); 149 } 150 } 151 return label.toString(); 152 } 153 154 /** 155 * Creates the array of items that can be passed to the 156 * {@link MessageFormat} class for creating labels. 157 * 158 * @param dataset the dataset ({@code null} not permitted). 159 * @param series the series (zero-based index). 160 * 161 * @return The items (never {@code null}). 162 */ 163 protected Object[] createItemArray(XYDataset dataset, int series) { 164 Object[] result = new Object[1]; 165 result[0] = dataset.getSeriesKey(series).toString(); 166 return result; 167 } 168 169 /** 170 * Returns an independent copy of the generator. 171 * 172 * @return A clone. 173 * 174 * @throws CloneNotSupportedException if cloning is not supported. 175 */ 176 @Override 177 public Object clone() throws CloneNotSupportedException { 178 MultipleXYSeriesLabelGenerator clone 179 = (MultipleXYSeriesLabelGenerator) super.clone(); 180 clone.seriesLabelLists = new HashMap(); 181 Set keys = this.seriesLabelLists.keySet(); 182 Iterator iterator = keys.iterator(); 183 while (iterator.hasNext()) { 184 Object key = iterator.next(); 185 Object entry = this.seriesLabelLists.get(key); 186 Object toAdd = entry; 187 if (entry instanceof PublicCloneable) { 188 PublicCloneable pc = (PublicCloneable) entry; 189 toAdd = pc.clone(); 190 } 191 clone.seriesLabelLists.put(key, toAdd); 192 } 193 return clone; 194 } 195 196 /** 197 * Tests this object for equality with an arbitrary object. 198 * 199 * @param obj the other object ({@code null} permitted). 200 * 201 * @return A boolean. 202 */ 203 @Override 204 public boolean equals(Object obj) { 205 if (obj == this) { 206 return true; 207 } 208 if (!(obj instanceof MultipleXYSeriesLabelGenerator)) { 209 return false; 210 } 211 MultipleXYSeriesLabelGenerator that 212 = (MultipleXYSeriesLabelGenerator) obj; 213 if (!this.formatPattern.equals(that.formatPattern)) { 214 return false; 215 } 216 if (!this.additionalFormatPattern.equals( 217 that.additionalFormatPattern)) { 218 return false; 219 } 220 if (!this.seriesLabelLists.equals(that.seriesLabelLists)) { 221 return false; 222 } 223 return true; 224 } 225 226 /** 227 * Returns a hash code for this instance. 228 * 229 * @return A hash code. 230 */ 231 @Override 232 public int hashCode() { 233 int result = 127; 234 result = HashUtils.hashCode(result, this.formatPattern); 235 result = HashUtils.hashCode(result, this.additionalFormatPattern); 236 result = HashUtils.hashCode(result, this.seriesLabelLists); 237 return result; 238 } 239 240}