com.jrefinery.chart.demo
Class SampleYSymbolicDataset

java.lang.Object
  |
  +--com.jrefinery.data.AbstractDataset
        |
        +--com.jrefinery.data.AbstractSeriesDataset
              |
              +--com.jrefinery.chart.demo.SampleYSymbolicDataset
All Implemented Interfaces:
Dataset, SeriesChangeListener, SeriesDataset, XYDataset, YisSymbolic

public class SampleYSymbolicDataset
extends AbstractSeriesDataset
implements XYDataset, YisSymbolic

Random data for a symbolic plot demo.

Author:
AB

Constructor Summary
SampleYSymbolicDataset(java.lang.String datasetName, java.lang.Double[][] xValues, java.lang.Integer[][] yValues, java.lang.String[] ySymbolicValues, int serie, int item, java.lang.String[] serieNames)
          Creates a new sample dataset.
SampleYSymbolicDataset(java.lang.String datasetName, int xRange, java.lang.String[] tabString)
          Creates a new sample dataset.
SampleYSymbolicDataset(java.lang.String datasetName, int xRange, java.lang.String[] tabString, int serie, int item, java.lang.String[] serieNames)
          Creates a new sample dataset.
 
Method Summary
 java.lang.Object clone()
          Clone the SampleYSymbolicDataset object
static java.lang.String[] combineYSymbolicDataset(YisSymbolic dataset1, YisSymbolic dataset2)
          This function modify dataset1 and dataset1 in order that they share the same symbolic value list.
 int getItemCount(int series)
          Returns the number of items in the specified series.
 int getSeriesCount()
          Returns the number of series in the dataset.
 java.lang.String getSeriesName(int series)
          Returns the name of the series.
 java.lang.Number getXValue(int series, int item)
          Returns the x-value for the specified series and item.
 java.lang.String getYSymbolicValue(java.lang.Integer val)
          Returns the symbolic value linked with the specified Integer.
 java.lang.String getYSymbolicValue(int series, int item)
          Returns the symbolic value of the data set specified by series and item parameters.
 java.lang.String[] getYSymbolicValues()
          Returns the list of symbolic values.
 java.lang.Number getYValue(int series, int item)
          Returns the y-value for the specified series and item.
 void setYSymbolicValues(java.lang.String[] sValues)
          Sets the list of symbolic values.
 void setYValue(int series, int item, java.lang.Number newValue)
          Sets the y-value for the specified series and item with the specified new Number value.
 
Methods inherited from class com.jrefinery.data.AbstractSeriesDataset
getLegendItemCount, getLegendItemLabels, seriesChanged
 
Methods inherited from class com.jrefinery.data.AbstractDataset
addChangeListener, fireDatasetChanged, getGroup, notifyListeners, removeChangeListener, setGroup
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.jrefinery.data.Dataset
addChangeListener, getGroup, removeChangeListener, setGroup
 

Constructor Detail

SampleYSymbolicDataset

public SampleYSymbolicDataset(java.lang.String datasetName,
                              int xRange,
                              java.lang.String[] tabString)
Creates a new sample dataset.
Parameters:
datasetName - the dataset name.
xRange - the x range.
tabString - ??

SampleYSymbolicDataset

public SampleYSymbolicDataset(java.lang.String datasetName,
                              int xRange,
                              java.lang.String[] tabString,
                              int serie,
                              int item,
                              java.lang.String[] serieNames)
Creates a new sample dataset.
Parameters:
datasetName - the dataset name.
xRange - the x range.
tabString - ??
serie - the series index.
item - the item index.
serieNames - the series names.

SampleYSymbolicDataset

public SampleYSymbolicDataset(java.lang.String datasetName,
                              java.lang.Double[][] xValues,
                              java.lang.Integer[][] yValues,
                              java.lang.String[] ySymbolicValues,
                              int serie,
                              int item,
                              java.lang.String[] serieNames)
Creates a new sample dataset.
Parameters:
datasetName - the dataset name.
xValues - the x values.
yValues - the y values.
ySymbolicValues - the y symbols
serie - the series index.
item - the item index.
serieNames - the series names.
Method Detail

getXValue

public java.lang.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.

getYValue

public java.lang.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.

setYValue

public void setYValue(int series,
                      int item,
                      java.lang.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
Overrides:
getSeriesCount in class AbstractSeriesDataset
Returns:
The number of series in the dataset.

getSeriesName

public java.lang.String getSeriesName(int series)
Returns the name of the series.
Specified by:
getSeriesName in interface SeriesDataset
Overrides:
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 java.lang.String[] getYSymbolicValues()
Returns the list of symbolic values.
Specified by:
getYSymbolicValues in interface YisSymbolic
Returns:
array of symbolic value.

setYSymbolicValues

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

getYSymbolicValue

public java.lang.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 java.lang.String getYSymbolicValue(java.lang.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 java.lang.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.
Throws:
ClassCastException - if dataset1 and dataset2 is not an instance of SampleYSymbolicDataset.

clone

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