org.jfree.data.xy

Class DefaultWindDataset

public class DefaultWindDataset extends AbstractXYDataset implements WindDataset, PublicCloneable

A default implementation of the WindDataset interface.
Constructor Summary
DefaultWindDataset()
Constructs a new, empty, dataset.
DefaultWindDataset(Object[][][] data)
Constructs a dataset based on the specified data array.
DefaultWindDataset(String[] seriesNames, Object[][][] data)
Constructs a dataset based on the specified data array.
DefaultWindDataset(List seriesKeys, Object[][][] data)
Constructs a dataset based on the specified data array.
Method Summary
booleanequals(Object obj)
Checks this WindDataset for equality with an arbitrary object.
intgetItemCount(int series)
Returns the number of items in a series.
intgetSeriesCount()
Returns the number of series in the dataset.
ComparablegetSeriesKey(int series)
Returns the key for a series.
NumbergetWindDirection(int series, int item)
Returns the wind direction for one item within a series.
NumbergetWindForce(int series, int item)
Returns the wind force for one item within a series.
NumbergetX(int series, int item)
Returns the x-value for one item within a series.
NumbergetY(int series, int item)
Returns the y-value for one item within a series.
static ListseriesNameListFromDataArray(Object[][] data)
Utility method for automatically generating series names.

Constructor Detail

DefaultWindDataset

public DefaultWindDataset()
Constructs a new, empty, dataset. Since there are currently no methods to add data to an existing dataset, you should probably use a different constructor.

DefaultWindDataset

public DefaultWindDataset(Object[][][] data)
Constructs a dataset based on the specified data array.

Parameters: data the data (null not permitted).

Throws: NullPointerException if data is null.

DefaultWindDataset

public DefaultWindDataset(String[] seriesNames, Object[][][] data)
Constructs a dataset based on the specified data array.

Parameters: seriesNames the names of the series (null not permitted). data the wind data.

Throws: NullPointerException if seriesNames is null.

DefaultWindDataset

public DefaultWindDataset(List seriesKeys, Object[][][] data)
Constructs a dataset based on the specified data array. The array can contain multiple series, each series can contain multiple items, and each item is as follows:

Parameters: seriesKeys the names of the series (null not permitted). data the wind dataset (null not permitted).

Throws: IllegalArgumentException if seriesKeys is null. IllegalArgumentException if the number of series keys does not match the number of series in the array. NullPointerException if data is null.

Method Detail

equals

public boolean equals(Object obj)
Checks this WindDataset for equality with an arbitrary object. This method returns true if and only if:

getItemCount

public int getItemCount(int series)
Returns the number of items in a series.

Parameters: series the series (zero-based index).

Returns: The item count.

getSeriesCount

public int getSeriesCount()
Returns the number of series in the dataset.

Returns: The series count.

getSeriesKey

public Comparable getSeriesKey(int series)
Returns the key for a series.

Parameters: series the series (zero-based index).

Returns: The series key.

getWindDirection

public Number getWindDirection(int series, int item)
Returns the wind direction for one item within a series. This is a number between 0 and 12, like the numbers on an upside-down clock face.

Parameters: series the series (zero-based index). item the item (zero-based index).

Returns: The wind direction for the item within the series.

getWindForce

public Number getWindForce(int series, int item)
Returns the wind force for one item within a series. This is a number between 0 and 12, as defined by the Beaufort scale.

Parameters: series the series (zero-based index). item the item (zero-based index).

Returns: The wind force for the item within the series.

getX

public Number getX(int series, int item)
Returns the x-value for one item within a series. This should represent a point in time, encoded as milliseconds in the same way as java.util.Date.

Parameters: series the series (zero-based index). item the item (zero-based index).

Returns: The x-value for the item within the series.

getY

public Number getY(int series, int item)
Returns the y-value for one item within a series. This maps to the DefaultWindDataset method and is implemented because WindDataset is an extension of XYDataset.

Parameters: series the series (zero-based index). item the item (zero-based index).

Returns: The y-value for the item within the series.

seriesNameListFromDataArray

public static List seriesNameListFromDataArray(Object[][] data)
Utility method for automatically generating series names.

Parameters: data the wind data (null not permitted).

Returns: An array of Series N with N = { 1 .. data.length }.

Throws: NullPointerException if data is null.

Copyright © 2000-2009 by Object Refinery Limited. All Rights Reserved.