1. /* ===========================================================
  2. * JFreeChart : a free chart library for the Java(tm) platform
  3. * ===========================================================
  4. *
  5. * (C) Copyright 2000-2005, 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 License
  20. * along with this library; if not, write to the Free Software Foundation,
  21. * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
  22. *
  23. * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
  24. * in the United States and other countries.]
  25. *
  26. * --------------------
  27. * XYZURLGenerator.java
  28. * --------------------
  29. * (C) Copyright 2003-2005, by Object Refinery Limited and Contributors.
  30. *
  31. * Original Author: David Gilbert (for Object Refinery Limited);
  32. * Contributors: -;
  33. *
  34. * $Id: XYZURLGenerator.java,v 1.3 2005/03/09 13:45:32 mungady Exp $
  35. *
  36. * Changes:
  37. * --------
  38. * 03-Feb-2003 : Version 1 (DG);
  39. *
  40. */
  41. package org.jfree.chart.urls;
  42. import org.jfree.data.xy.XYZDataset;
  43. /**
  44. * Interface for a URL generator for plots that uses data from an
  45. * {@link XYZDataset}.
  46. */
  47. public interface XYZURLGenerator extends XYURLGenerator {
  48. /**
  49. * Generates a URL for a particular item within a series. As a guideline,
  50. * the URL should be valid within the context of an XHTML 1.0 document.
  51. *
  52. * @param dataset the dataset (<code>null</code> not permitted).
  53. * @param series the series index (zero-based).
  54. * @param item the item index (zero-based).
  55. *
  56. * @return A string containing the generated URL.
  57. */
  58. public String generateURL(XYZDataset dataset, int series, int item);
  59. }