org.jfree.chart.urls.CustomPieURLGenerator Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jfreechart Show documentation
Show all versions of jfreechart Show documentation
JFreeChart is a class library, written in Java, for generating charts.
Utilising the Java2D APIs, it currently supports bar charts, pie charts,
line charts, XY-plots and time series plots.
/* ======================================
* JFreeChart : a free Java chart library
* ======================================
*
* (C) Copyright 2000-2020, by Object Refinery Limited and Contributors.
*
* Project Info: http://www.jfree.org/jfreechart/index.html
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
* License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
* USA.
*
* [Oracle and Java are registered trademarks of Oracle and/or its affiliates.
* Other names may be trademarks of their respective owners.]
*
* --------------------------
* CustomPieURLGenerator.java
* --------------------------
* (C) Copyright 2004-2020, by David Basten and Contributors.
*
* Original Author: David Basten;
* Contributors: -;
*
*/
package org.jfree.chart.urls;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
import org.jfree.chart.plot.MultiplePiePlot;
import org.jfree.chart.util.PublicCloneable;
import org.jfree.data.general.PieDataset;
/**
* A custom URL generator for pie charts.
*/
public class CustomPieURLGenerator implements PieURLGenerator,
Cloneable, PublicCloneable, Serializable {
/** For serialization. */
private static final long serialVersionUID = 7100607670144900503L;
/** Storage for the URLs. */
private ArrayList urls;
/**
* Creates a new {@code CustomPieURLGenerator} instance, initially
* empty. Call {@link #addURLs(Map)} to specify the URL fragments to be
* used.
*/
public CustomPieURLGenerator() {
this.urls = new ArrayList();
}
/**
* Generates a URL fragment.
*
* @param dataset the dataset (ignored).
* @param key the item key.
* @param pieIndex the pie index.
*
* @return A string containing the generated URL.
*
* @see #getURL(Comparable, int)
*/
@Override
public String generateURL(PieDataset dataset, Comparable key,
int pieIndex) {
return getURL(key, pieIndex);
}
/**
* Returns the number of URL maps stored by the renderer.
*
* @return The list count.
*
* @see #addURLs(Map)
*/
public int getListCount() {
return this.urls.size();
}
/**
* Returns the number of URLs in a given map (specified by its position
* in the map list).
*
* @param list the list index (zero based).
*
* @return The URL count.
*
* @see #getListCount()
*/
public int getURLCount(int list) {
int result = 0;
Map urlMap = (Map) this.urls.get(list);
if (urlMap != null) {
result = urlMap.size();
}
return result;
}
/**
* Returns the URL for a section in the specified map.
*
* @param key the key.
* @param mapIndex the map index.
*
* @return The URL.
*/
public String getURL(Comparable key, int mapIndex) {
String result = null;
if (mapIndex < getListCount()) {
Map urlMap = (Map) this.urls.get(mapIndex);
if (urlMap != null) {
result = (String) urlMap.get(key);
}
}
return result;
}
/**
* Adds a map containing {@code (key, URL)} mappings where each
* {@code key} is an instance of {@code Comparable}
* (corresponding to the key for an item in a pie dataset) and each
* {@code URL} is a {@code String} representing a URL fragment.
*
* The map is appended to an internal list...you can add multiple maps
* if you are working with, say, a {@link MultiplePiePlot}.
*
* @param urlMap the URLs ({@code null} permitted).
*/
public void addURLs(Map urlMap) {
this.urls.add(urlMap);
}
/**
* Tests if this object is equal to another.
*
* @param o the other object.
*
* @return A boolean.
*/
@Override
public boolean equals(Object o) {
if (o == this) {
return true;
}
if (o instanceof CustomPieURLGenerator) {
CustomPieURLGenerator generator = (CustomPieURLGenerator) o;
if (getListCount() != generator.getListCount()) {
return false;
}
Set keySet;
for (int pieItem = 0; pieItem < getListCount(); pieItem++) {
if (getURLCount(pieItem) != generator.getURLCount(pieItem)) {
return false;
}
keySet = ((HashMap) this.urls.get(pieItem)).keySet();
String key;
for (Iterator i = keySet.iterator(); i.hasNext();) {
key = (String) i.next();
if (!getURL(key, pieItem).equals(
generator.getURL(key, pieItem))) {
return false;
}
}
}
return true;
}
return false;
}
/**
* Returns a clone of the generator.
*
* @return A clone.
*
* @throws CloneNotSupportedException if cloning is not supported.
*/
@Override
public Object clone() throws CloneNotSupportedException {
CustomPieURLGenerator urlGen = new CustomPieURLGenerator();
Map map;
Map newMap;
String key;
for (Iterator i = this.urls.iterator(); i.hasNext();) {
map = (Map) i.next();
newMap = new HashMap();
for (Iterator j = map.keySet().iterator(); j.hasNext();) {
key = (String) j.next();
newMap.put(key, map.get(key));
}
urlGen.addURLs(newMap);
}
return urlGen;
}
}