Package org.jfree.chart.demo

Class SampleYSymbolicDataset

java.lang.Object
org.jfree.data.AbstractDataset
org.jfree.data.AbstractSeriesDataset
org.jfree.chart.demo.SampleYSymbolicDataset
All Implemented Interfaces:
ObjectInputValidation, Serializable, Cloneable, EventListener, Dataset, SeriesChangeListener, SeriesDataset, XYDataset, YisSymbolic
public class SampleYSymbolicDataset
extends AbstractSeriesDataset
implements XYDataset, YisSymbolic
A dataset implementation that provides random data for a symbolic plot demo. This sample dataset has numerical x-values, and symbolic y-values.
Author:
Anthony Boulestreau
See Also:
Serialized Form

  • Constructor Details

    • SampleYSymbolicDataset

      public SampleYSymbolicDataset​(String datasetName, int xRange, String[] tabString)
      Creates a new sample dataset.
      Parameters:
      datasetName - the dataset name.
      xRange - the upper limit of the (random) x-values.
      tabString - the symbols for the y-values.

    • SampleYSymbolicDataset

      public SampleYSymbolicDataset​(String datasetName, int xRange, String[] tabString, int seriesCount, int itemCount, String[] serieNames)
      Creates a new sample dataset.
      Parameters:
      datasetName - the dataset name.
      xRange - the upper limit of the (random) x-values.
      tabString - the symbolic y-values.
      seriesCount - the number of series to create.
      itemCount - the number of items to create for each series.
      serieNames - the series names.

    • SampleYSymbolicDataset

      public SampleYSymbolicDataset​(String datasetName, Double[][] xValues, Integer[][] yValues, String[] ySymbolicValues, int seriesCount, int itemCount, String[] serieNames)
      Creates a new sample dataset.
      Parameters:
      datasetName - the dataset name.
      xValues - the x values.
      yValues - the y values.
      ySymbolicValues - the y symbols
      seriesCount - the series count.
      itemCount - the item count.
      serieNames - the series names.

  • Method Details

    • getXValue

      public Number getXValue​(int series, int item)
      Returns the x-value for the specified series and item. Series are numbered 0, 1, ...
      Specified by:
      getXValue in interface XYDataset
      Parameters:
      series - the index (zero-based) of the series.
      item - the index (zero-based) of the required item.
      Returns:
      the x-value for the specified series and item.

    • getX

      public double getX​(int series, int item)
      Returns the x-value (as a double primitive) for an item within a series.
      Specified by:
      getX in interface XYDataset
      Parameters:
      series - the series (zero-based index).
      item - the item (zero-based index).
      Returns:
      The x-value.

    • getYValue

      public Number getYValue​(int series, int item)
      Returns the y-value for the specified series and item. Series are numbered 0, 1, ...
      Specified by:
      getYValue in interface XYDataset
      Parameters:
      series - the index (zero-based) of the series.
      item - the index (zero-based) of the required item.
      Returns:
      the y-value for the specified series and item.

    • getY

      public double getY​(int series, int item)
      Returns the y-value (as a double primitive) for an item within a series.
      Specified by:
      getY in interface XYDataset
      Parameters:
      series - the series (zero-based index).
      item - the item (zero-based index).
      Returns:
      The y-value.

    • setYValue

      public void setYValue​(int series, int item, Number newValue)
      Sets the y-value for the specified series and item with the specified new Number value. Series are numbered 0, 1, ...

      This method is used by combineYSymbolicDataset to modify the reference to the symbolic value ...

      Parameters:
      series - the index (zero-based) of the series.
      item - the index (zero-based) of the required item.
      newValue - the value to set.

    • getSeriesCount

      public int getSeriesCount()
      Returns the number of series in the dataset.
      Specified by:
      getSeriesCount in interface SeriesDataset
      Specified by:
      getSeriesCount in class AbstractSeriesDataset
      Returns:
      The number of series in the dataset.

    • getSeriesName

      public String getSeriesName​(int series)
      Returns the name of the series.
      Specified by:
      getSeriesName in interface SeriesDataset
      Specified by:
      getSeriesName in class AbstractSeriesDataset
      Parameters:
      series - the index (zero-based) of the series.
      Returns:
      the name of the series.

    • getItemCount

      public int getItemCount​(int series)
      Returns the number of items in the specified series.
      Specified by:
      getItemCount in interface XYDataset
      Parameters:
      series - The index (zero-based) of the series.
      Returns:
      the number of items in the specified series.

    • getYSymbolicValues

      public String[] getYSymbolicValues()
      Returns the list of symbolic values.
      Specified by:
      getYSymbolicValues in interface YisSymbolic
      Returns:
      array of symbolic value.

    • setYSymbolicValues

      public void setYSymbolicValues​(String[] sValues)
      Sets the list of symbolic values.
      Parameters:
      sValues - the new list of symbolic value.

    • getYSymbolicValue

      public String getYSymbolicValue​(int series, int item)
      Returns the symbolic value of the data set specified by series and item parameters.
      Specified by:
      getYSymbolicValue in interface YisSymbolic
      Parameters:
      series - value of the serie.
      item - value of the item.
      Returns:
      the symbolic value.

    • getYSymbolicValue

      public String getYSymbolicValue​(Integer val)
      Returns the symbolic value linked with the specified Integer.
      Specified by:
      getYSymbolicValue in interface YisSymbolic
      Parameters:
      val - value of the integer linked with the symbolic value.
      Returns:
      the symbolic value.

    • combineYSymbolicDataset

      public static String[] combineYSymbolicDataset​(YisSymbolic dataset1, YisSymbolic dataset2)
      This function modify dataset1 and dataset1 in order that they share the same symbolic value list.

      The sharing symbolic value list is obtained adding the symbolic data list of the fist data set to the symbolic data list of the second data set.

      This function is use with the combined plot functions of JFreeChart.

      Parameters:
      dataset1 - the first data set to combine.
      dataset2 - the second data set to combine.
      Returns:
      the shared symbolic array.

    • clone

      public Object clone()
      Clone the SampleYSymbolicDataset object
      Overrides:
      clone in class AbstractDataset
      Returns:
      the cloned object.