datavisualizer::XYZSimpleDataset Class Reference

A simple implementation of the jorg.jfree.data.xyXYZDataset interface that stores data values in arrays of bool primitives. More...

List of all members.

Public Member Functions

 XYZSimpleDataset (int iNumSeries, int iNumXCells, int iNumYCells)
 Constructor.
int getSeriesCount ()
 Returns the number of series in the dataset.
Comparable getSeriesKey (int series)
 Returns the key for a series.
int indexOf (Comparable seriesKey)
 Returns the index of the series with the specified key, or -1 if there is no such series in the dataset.
org.jfree.data.DomainOrder getDomainOrder ()
 Returns the order of the domain (x-) values in the dataset.
int getItemCount (int series)
 Returns the number of items in the specified series.
double getXValue (int series, int item)
 Returns the x-value for an item within a series.
Number getX (int series, int item)
 Returns the x-value for an item within a series.
double getYValue (int series, int item)
 Returns the y-value for an item within a series.
Number getY (int series, int item)
 Returns the y-value for an item within a series.
double getZValue (int series, int item)
 Returns the z-value for an item within a series.
Number getZ (int series, int item)
 Returns the z-value for an item within a series.

Public Attributes

String[] mp_sSeriesKeys
 Storage for the series keys.
boolean[][][] mp_bData
 Storage for the series in the dataset.
int m_iNumXCells = 0
 Number of X cells.
int m_iNumYCells = 0
 Number of Y cells.


Detailed Description

A simple implementation of the jorg.jfree.data.xyXYZDataset interface that stores data values in arrays of bool primitives.

Stolen and modded from the original in JFreeChart by Lora E. Murphy. I did this for speed and ease, and to work with my XYSimpleCellRenderer.


Edit history:
------------------
December 21, 2006: Created during upgrade to JFreeChart 1.0.3 (LEM)


Constructor & Destructor Documentation

datavisualizer::XYZSimpleDataset::XYZSimpleDataset ( int  iNumSeries,
int  iNumXCells,
int  iNumYCells 
) [inline]

Constructor.

Parameters:
iNumSeries Number of dataset series.
iNumXCells Number of X cells.
iNumYCells Number of Y cells.


Member Function Documentation

int datavisualizer::XYZSimpleDataset::getSeriesCount (  )  [inline]

Returns the number of series in the dataset.

Returns:
The series count.

Comparable datavisualizer::XYZSimpleDataset::getSeriesKey ( int  series  )  [inline]

Returns the key for a series.

Parameters:
series the series index (in the range 0 to getSeriesCount() - 1).
Returns:
The key for the series.
Exceptions:
IllegalArgumentException if series is not in the specified range.

int datavisualizer::XYZSimpleDataset::indexOf ( Comparable  seriesKey  )  [inline]

Returns the index of the series with the specified key, or -1 if there is no such series in the dataset.

Parameters:
seriesKey the series key (null permitted).
Returns:
The index, or -1.

org.jfree.data.DomainOrder datavisualizer::XYZSimpleDataset::getDomainOrder (  )  [inline]

Returns the order of the domain (x-) values in the dataset.

In this implementation, we cannot guarantee that the x-values are ordered, so this method returns DomainOrder.NONE.

Returns:
DomainOrder.NONE.

int datavisualizer::XYZSimpleDataset::getItemCount ( int  series  )  [inline]

Returns the number of items in the specified series.

Parameters:
series the series index (in the range 0 to getSeriesCount() - 1).
Returns:
The item count.
Exceptions:
IllegalArgumentException if series is not in the specified range.

double datavisualizer::XYZSimpleDataset::getXValue ( int  series,
int  item 
) [inline]

Returns the x-value for an item within a series.

Parameters:
series the series index (in the range 0 to getSeriesCount() - 1).
item the item index (in the range 0 to getItemCount(series)).
Returns:
The x-value.

Number datavisualizer::XYZSimpleDataset::getX ( int  series,
int  item 
) [inline]

Returns the x-value for an item within a series.

Parameters:
series the series index (in the range 0 to getSeriesCount() - 1).
item the item index (in the range 0 to getItemCount(series)).
Returns:
The x-value.

double datavisualizer::XYZSimpleDataset::getYValue ( int  series,
int  item 
) [inline]

Returns the y-value for an item within a series.

Parameters:
series the series index (in the range 0 to getSeriesCount() - 1).
item the item index (in the range 0 to getItemCount(series)).
Returns:
The y-value.

Number datavisualizer::XYZSimpleDataset::getY ( int  series,
int  item 
) [inline]

Returns the y-value for an item within a series.

Parameters:
series the series index (in the range 0 to getSeriesCount() - 1).
item the item index (in the range 0 to getItemCount(series)).
Returns:
The y-value.

double datavisualizer::XYZSimpleDataset::getZValue ( int  series,
int  item 
) [inline]

Returns the z-value for an item within a series.

Parameters:
series the series index (in the range 0 to getSeriesCount() - 1).
item the item index (in the range 0 to getItemCount(series)).
Returns:
The z-value, 1 for true, 0 for false.

Number datavisualizer::XYZSimpleDataset::getZ ( int  series,
int  item 
) [inline]

Returns the z-value for an item within a series.

Parameters:
series the series index (in the range 0 to getSeriesCount() - 1).
item the item index (in the range 0 to getItemCount(series)).
Returns:
The z-value.


Member Data Documentation

boolean [][][] datavisualizer::XYZSimpleDataset::mp_bData

Storage for the series in the dataset.

This is a grid of values sized # series by # plot X cells by # plot Y cells.

Now: We will fake the XYZ data structure of JFreeChart. That would mean that each series was a collection of objects each with 3 values, one being X, one being Y, and one being Z. We will pretend that we are doing it that way, holding all values for the grid in order, and the indexing goes (X Cell * Num X Cells) + Y Cell.

True means a value is selected. False means it is not.


The documentation for this class was generated from the following file:
Generated on Thu May 24 09:34:52 2007 for SORTIE Java Interface by  doxygen 1.5.2