001: /* ===========================================================
002: * JFreeChart : a free chart library for the Java(tm) platform
003: * ===========================================================
004: *
005: * (C) Copyright 2000-2007, 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: * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
025: * in the United States and other countries.]
026: *
027: * ---------------------------
028: * TimeSeriesURLGenerator.java
029: * ---------------------------
030: * (C) Copyright 2002-2006, by Richard Atkinson and Contributors.
031: *
032: * Original Author: Richard Atkinson;
033: * Contributors: David Gilbert (for Object Refinery Limited);
034: *
035: * $Id: TimeSeriesURLGenerator.java,v 1.5.2.4 2007/04/17 16:05:27 mungady Exp $
036: *
037: * Changes:
038: * --------
039: * 29-Aug-2002 : Initial version (RA);
040: * 09-Oct-2002 : Fixed errors reported by Checkstyle (DG);
041: * 23-Mar-2003 : Implemented Serializable (DG);
042: * 15-Jul-2004 : Switched getX() with getXValue() and getY() with
043: * getYValue() (DG);
044: * 13-Jan-2005 : Modified for XHTML 1.0 compliance (DG);
045: * ------------- JFREECHART 1.0.x ---------------------------------------------
046: * 06-Jul-2006 : Swap call to dataset's getX() --> getXValue() (DG);
047: * 17-Apr-2007 : Added null argument checks to constructor, new accessor
048: * methods, added equals() override and used new URLUtilities
049: * class to encode series key and date (DG);
050: *
051: */
052:
053: package org.jfree.chart.urls;
054:
055: import java.io.Serializable;
056: import java.text.DateFormat;
057: import java.util.Date;
058:
059: import org.jfree.data.xy.XYDataset;
060:
061: /**
062: * A URL generator for time series charts.
063: */
064: public class TimeSeriesURLGenerator implements XYURLGenerator,
065: Serializable {
066:
067: /** For serialization. */
068: private static final long serialVersionUID = -9122773175671182445L;
069:
070: /** A formatter for the date. */
071: private DateFormat dateFormat = DateFormat.getInstance();
072:
073: /** Prefix to the URL */
074: private String prefix = "index.html";
075:
076: /** Name to use to identify the series */
077: private String seriesParameterName = "series";
078:
079: /** Name to use to identify the item */
080: private String itemParameterName = "item";
081:
082: /**
083: * Default constructor.
084: */
085: public TimeSeriesURLGenerator() {
086: super ();
087: }
088:
089: /**
090: * Construct TimeSeriesURLGenerator overriding defaults.
091: *
092: * @param dateFormat a formatter for the date (<code>null</code> not
093: * permitted).
094: * @param prefix the prefix of the URL (<code>null</code> not permitted).
095: * @param seriesParameterName the name of the series parameter in the URL
096: * (<code>null</code> not permitted).
097: * @param itemParameterName the name of the item parameter in the URL
098: * (<code>null</code> not permitted).
099: */
100: public TimeSeriesURLGenerator(DateFormat dateFormat, String prefix,
101: String seriesParameterName, String itemParameterName) {
102:
103: if (dateFormat == null) {
104: throw new IllegalArgumentException(
105: "Null 'dateFormat' argument.");
106: }
107: if (prefix == null) {
108: throw new IllegalArgumentException(
109: "Null 'prefix' argument.");
110: }
111: if (seriesParameterName == null) {
112: throw new IllegalArgumentException(
113: "Null 'seriesParameterName' argument.");
114: }
115: if (itemParameterName == null) {
116: throw new IllegalArgumentException(
117: "Null 'itemParameterName' argument.");
118: }
119:
120: this .dateFormat = (DateFormat) dateFormat.clone();
121: this .prefix = prefix;
122: this .seriesParameterName = seriesParameterName;
123: this .itemParameterName = itemParameterName;
124:
125: }
126:
127: /**
128: * Returns a clone of the date format assigned to this URL generator.
129: *
130: * @return The date format (never <code>null</code>).
131: *
132: * @since 1.0.6
133: */
134: public DateFormat getDateFormat() {
135: return (DateFormat) this .dateFormat.clone();
136: }
137:
138: /**
139: * Returns the prefix string.
140: *
141: * @return The prefix string (never <code>null</code>).
142: *
143: * @since 1.0.6
144: */
145: public String getPrefix() {
146: return this .prefix;
147: }
148:
149: /**
150: * Returns the series parameter name.
151: *
152: * @return The series parameter name (never <code>null</code>).
153: *
154: * @since 1.0.6
155: */
156: public String getSeriesParameterName() {
157: return this .seriesParameterName;
158: }
159:
160: /**
161: * Returns the item parameter name.
162: *
163: * @return The item parameter name (never <code>null</code>).
164: *
165: * @since 1.0.6
166: */
167: public String getItemParameterName() {
168: return this .itemParameterName;
169: }
170:
171: /**
172: * Generates a URL for a particular item within a series.
173: *
174: * @param dataset the dataset (<code>null</code> not permitted).
175: * @param series the series number (zero-based index).
176: * @param item the item number (zero-based index).
177: *
178: * @return The generated URL.
179: */
180: public String generateURL(XYDataset dataset, int series, int item) {
181: String result = this .prefix;
182: boolean firstParameter = result.indexOf("?") == -1;
183: Comparable seriesKey = dataset.getSeriesKey(series);
184: if (seriesKey != null) {
185: result += firstParameter ? "?" : "&";
186: result += this .seriesParameterName
187: + "="
188: + URLUtilities
189: .encode(seriesKey.toString(), "UTF-8");
190: firstParameter = false;
191: }
192:
193: long x = (long) dataset.getXValue(series, item);
194: String xValue = this .dateFormat.format(new Date(x));
195: result += firstParameter ? "?" : "&";
196: result += this .itemParameterName + "="
197: + URLUtilities.encode(xValue, "UTF-8");
198:
199: return result;
200: }
201:
202: /**
203: * Tests this generator for equality with an arbitrary object.
204: *
205: * @param obj the object (<code>null</code> permitted).
206: *
207: * @return A boolean.
208: */
209: public boolean equals(Object obj) {
210: if (obj == this ) {
211: return true;
212: }
213: if (!(obj instanceof TimeSeriesURLGenerator)) {
214: return false;
215: }
216: TimeSeriesURLGenerator that = (TimeSeriesURLGenerator) obj;
217: if (!this .dateFormat.equals(that.dateFormat)) {
218: return false;
219: }
220: if (!this .itemParameterName.equals(that.itemParameterName)) {
221: return false;
222: }
223: if (!this .prefix.equals(that.prefix)) {
224: return false;
225: }
226: if (!this .seriesParameterName.equals(that.seriesParameterName)) {
227: return false;
228: }
229: return true;
230: }
231:
232: }
|