Package org.jfree.chart.urls

Class StandardPieURLGenerator

  • All Implemented Interfaces:
    java.io.Serializable, PieURLGenerator
    public class StandardPieURLGenerator
extends java.lang.Object
implements PieURLGenerator, java.io.Serializable
    A URL generator for pie charts. Instances of this class are immutable.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String categoryParamName
      The category parameter name.
      private java.lang.String indexParamName
      The pie index parameter name.
      private java.lang.String prefix
      The prefix.
      private static long serialVersionUID
      For serialization.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)
      Tests if this object is equal to another.
      java.lang.String generateURL​(PieDataset dataset, java.lang.Comparable key, int pieIndex)
      Generates a URL.

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • serialVersionUID

        private static final long serialVersionUID
        For serialization.
        See Also:
        Constant Field Values

      • prefix

        private java.lang.String prefix
        The prefix.

      • categoryParamName

        private java.lang.String categoryParamName
        The category parameter name.

      • indexParamName

        private java.lang.String indexParamName
        The pie index parameter name.

    • Constructor Detail

      • StandardPieURLGenerator

        public StandardPieURLGenerator()
        Default constructor.

      • StandardPieURLGenerator

        public StandardPieURLGenerator​(java.lang.String prefix)
        Creates a new generator.
        Parameters:
        prefix - the prefix (null not permitted).

      • StandardPieURLGenerator

        public StandardPieURLGenerator​(java.lang.String prefix,
                               java.lang.String categoryParamName)
        Creates a new generator.
        Parameters:
        prefix - the prefix (null not permitted).
        categoryParamName - the category parameter name (null not permitted).

      • StandardPieURLGenerator

        public StandardPieURLGenerator​(java.lang.String prefix,
                               java.lang.String categoryParamName,
                               java.lang.String indexParamName)
        Creates a new generator.
        Parameters:
        prefix - the prefix (null not permitted).
        categoryParamName - the category parameter name (null not permitted).
        indexParamName - the index parameter name (null permitted).

    • Method Detail

      • generateURL

        public java.lang.String generateURL​(PieDataset dataset,
                                    java.lang.Comparable key,
                                    int pieIndex)
        Generates a URL.
        Specified by:
        generateURL in interface PieURLGenerator
        Parameters:
        dataset - the dataset (ignored).
        key - the item key (null not permitted).
        pieIndex - the pie index.
        Returns:
        A string containing the generated URL.

      • equals

        public boolean equals​(java.lang.Object obj)
        Tests if this object is equal to another.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        obj - the object (null permitted).
        Returns:
        A boolean.