datavisualizer::XYZSeriesCollection Class Reference

For creating an XYZ dataset. More...

List of all members.

Public Member Functions

 XYZSeriesCollection ()
 Constructs an empty dataset.
 XYZSeriesCollection (XYZSeries series)
 Constructs a dataset and populates it with a single time series.
void addSeries (XYZSeries series)
 Adds a series to the collection.
int getSeriesCount ()
 Returns the number of series in the collection.
List getSeries ()
 Returns a list of all the series in the collection.
XYZSeries getSeries (int series)
 Returns a series.
String getSeriesName (int series)
 Returns the name of a series.
int getItemCount (int series)
 Returns the number of items in the specified series.
Number getXValue (int series, int item)
 Returns the x-value for the specified series and item.
Number getYValue (int series, int index)
 Returns the y-value for the specified series and item.
void removeAllSeries ()
 Removes all the series from the collection.
void removeSeries (XYZSeries series)
 Removes a series from the collection.
void removeSeries (int series)
 Removes a series from the collection.
boolean equals (Object obj)
 Tests this collection for equality with an arbitrary object.
Number getZValue (int series, int index)
 Returns the z-value for the specified series and item.

Private Attributes

List data
 The series that are included in the collection.


Detailed Description

For creating an XYZ dataset.

I, Lora E. Murphy, am only the author in the weakest possible sense. I got this wholesale from the JFreeChart package - XYSeriesCollection.java. I merely added the method for getZValue so that this implements the XYZDataset interface.

Copyright: Copyright (c) Charles D. Canham 2003

Company: Institute of Ecosystem Studies

Author:
Lora E. Murphy
Version:
1.0

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)


Constructor & Destructor Documentation

datavisualizer::XYZSeriesCollection::XYZSeriesCollection (  )  [inline]

Constructs an empty dataset.


Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

datavisualizer::XYZSeriesCollection::XYZSeriesCollection ( XYZSeries  series  )  [inline]

Constructs a dataset and populates it with a single time series.

Parameters:
series the time series.
Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)


Member Function Documentation

void datavisualizer::XYZSeriesCollection::addSeries ( XYZSeries  series  )  [inline]

Adds a series to the collection.

Notifies all registered listeners that the dataset has changed.

Parameters:
series the series.
Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

boolean datavisualizer::XYZSeriesCollection::equals ( Object  obj  )  [inline]

Tests this collection for equality with an arbitrary object.

Parameters:
obj the object.
Returns:
A boolean.
Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

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

Returns the number of items in the specified series.

Parameters:
series the series (zero-based index).
Returns:
the number of items in the specified series.
Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

XYZSeries datavisualizer::XYZSeriesCollection::getSeries ( int  series  )  [inline]

Returns a series.

Parameters:
series the series (zero-based index).
Returns:
The series.
Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

List datavisualizer::XYZSeriesCollection::getSeries (  )  [inline]

Returns a list of all the series in the collection.

Returns:
The list (which is unmodifiable).
Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

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

Returns the number of series in the collection.

Returns:
the number of series in the collection.
Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

String datavisualizer::XYZSeriesCollection::getSeriesName ( int  series  )  [inline]

Returns the name of a series.

Parameters:
series the series (zero-based index).
Returns:
the name of a series.
Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

Number datavisualizer::XYZSeriesCollection::getXValue ( int  series,
int  item 
) [inline]

Returns the x-value for the specified series and item.

Parameters:
series the series (zero-based index).
item the item (zero-based index).
Returns:
the x-value for the specified series and item.
Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

Number datavisualizer::XYZSeriesCollection::getYValue ( int  series,
int  index 
) [inline]

Returns the y-value for the specified series and item.

Parameters:
series the series (zero-based index).
index the index of the item of interest (zero-based).
Returns:
the y-value for the specified series and item.
Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

Number datavisualizer::XYZSeriesCollection::getZValue ( int  series,
int  index 
) [inline]

Returns the z-value for the specified series and item.

Parameters:
series the series (zero-based index).
index the index of the item of interest (zero-based).
Returns:
the z-value for the specified series and item.
Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

void datavisualizer::XYZSeriesCollection::removeAllSeries (  )  [inline]

Removes all the series from the collection.

Notifies all registered listeners that the dataset has changed.
Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

void datavisualizer::XYZSeriesCollection::removeSeries ( int  series  )  [inline]

Removes a series from the collection.

Notifies all registered listeners that the dataset has changed.

Parameters:
series the series (zero based index).
Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

void datavisualizer::XYZSeriesCollection::removeSeries ( XYZSeries  series  )  [inline]

Removes a series from the collection.

Notifies all registered listeners that the dataset has changed.

Parameters:
series the series.
Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)


The documentation for this class was generated from the following file:
Generated on Wed Nov 29 08:45:02 2006 for SORTIE Java Interface by  doxygen 1.4.7