com.jrefinery.data
Class DatasetUtilities

java.lang.Object
  |
  +--com.jrefinery.data.DatasetUtilities

public class DatasetUtilities
extends java.lang.Object

This class contains static methods that perform various useful functions relating to datasets.

Author:
DG

Constructor Summary
DatasetUtilities()
           
 
Method Summary
static java.lang.Number[] createNumberArray(double[] data)
          Constructs an array of Number objects from an array of doubles.
static java.lang.Number[][] createNumberArray2D(double[][] data)
          Constructs an array of arrays of Number objects from a corresponding structure containing double primitives.
static PieDataset createPieDataset(CategoryDataset data, int series)
          Creates a pie dataset from a category dataset by taking all the values for a single series.
static PieDataset createPieDataset(CategoryDataset data, java.lang.Object category)
          Creates a pie dataset from a category dataset by taking all the values (across series) for a single category.
static Range getDomainExtent(Dataset data)
          Returns the range of values in the domain for the dataset.
static java.lang.Number getMaximumDomainValue(Dataset data)
          Returns the maximum domain value for the specified dataset.
static java.lang.Number getMaximumRangeValue(Dataset data)
          Returns the maximum range value for the specified dataset.
static java.lang.Number getMaximumStackedRangeValue(CategoryDataset data)
          Returns the maximum value in the dataset range, assuming that values in each category are "stacked".
static java.lang.Number getMinimumDomainValue(Dataset data)
          Returns the minimum domain value for the specified dataset.
static java.lang.Number getMinimumRangeValue(Dataset data)
          Returns the minimum range value for the specified dataset.
static java.lang.Number getMinimumStackedRangeValue(CategoryDataset data)
          Returns the minimum value in the dataset range, assuming that values in each category are "stacked".
static double getPieDatasetTotal(PieDataset data)
          Calculates the total of all the values in a PieDataset.
static Range getRangeExtent(Dataset data)
          Returns the range of values in the range for the dataset.
static Range getStackedRangeExtent(CategoryDataset data)
          Returns the range of values for the range (as in domain/range) of the dataset, assuming that the series in one category are stacked.
static XYDataset sampleFunction2D(Function2D f, double start, double end, int samples, java.lang.String seriesName)
          Creates an XYDataset by sampling the specified function over a fixed range.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DatasetUtilities

public DatasetUtilities()
Method Detail

createNumberArray

public static java.lang.Number[] createNumberArray(double[] data)
Constructs an array of Number objects from an array of doubles.
Parameters:
data - the data.
Returns:
data as array of Number.

createNumberArray2D

public static java.lang.Number[][] createNumberArray2D(double[][] data)
Constructs an array of arrays of Number objects from a corresponding structure containing double primitives.
Parameters:
data - the data.
Returns:
data as array of Number.

getDomainExtent

public static Range getDomainExtent(Dataset data)
Returns the range of values in the domain for the dataset.
Parameters:
data - the dataset.
Returns:
the range of values.

getRangeExtent

public static Range getRangeExtent(Dataset data)
Returns the range of values in the range for the dataset. This method is the partner for the getDomainExtent method.
Parameters:
data - the dataset.
Returns:
the range of values in the range for the dataset.

getMinimumDomainValue

public static java.lang.Number getMinimumDomainValue(Dataset data)
Returns the minimum domain value for the specified dataset.

This is easy if the dataset implements the DomainInfo interface (a good idea if there is an efficient way to determine the minimum value). Otherwise, it involves iterating over the entire data-set.

Returns null if all the data values in the dataset are null.

Parameters:
data - the dataset.
Returns:
the minimum domain value in the dataset (or null).

getMaximumDomainValue

public static java.lang.Number getMaximumDomainValue(Dataset data)
Returns the maximum domain value for the specified dataset.

This is easy if the dataset implements the DomainInfo interface (a good idea if there is an efficient way to determine the maximum value). Otherwise, it involves iterating over the entire data-set.

Returns null if all the data values in the dataset are null.

Parameters:
data - the dataset.
Returns:
the maximum domain value in the dataset (or null).

getMinimumRangeValue

public static java.lang.Number getMinimumRangeValue(Dataset data)
Returns the minimum range value for the specified dataset.

This is easy if the dataset implements the RangeInfo interface (a good idea if there is an efficient way to determine the minimum value). Otherwise, it involves iterating over the entire data-set.

Returns null if all the data values in the dataset are null.

Parameters:
data - the dataset.
Returns:
the minimum range value in the dataset (or null).

getMaximumRangeValue

public static java.lang.Number getMaximumRangeValue(Dataset data)
Returns the maximum range value for the specified dataset.

This is easy if the dataset implements the RangeInfo interface (a good idea if there is an efficient way to determine the maximum value). Otherwise, it involves iterating over the entire data-set.

Returns null if all the data values are null.

Parameters:
data - the dataset.
Returns:
the maximum range value in the dataset (or null).

createPieDataset

public static PieDataset createPieDataset(CategoryDataset data,
                                          java.lang.Object category)
Creates a pie dataset from a category dataset by taking all the values (across series) for a single category.
Parameters:
data - the data.
category - the category.
Returns:
a pie dataset.

createPieDataset

public static PieDataset createPieDataset(CategoryDataset data,
                                          int series)
Creates a pie dataset from a category dataset by taking all the values for a single series.
Parameters:
data - the data.
series - the series (zero-based index).
Returns:
a pie dataset.

getPieDatasetTotal

public static double getPieDatasetTotal(PieDataset data)
Calculates the total of all the values in a PieDataset.
Parameters:
data - the dataset.
Returns:
the total.

getStackedRangeExtent

public static Range getStackedRangeExtent(CategoryDataset data)
Returns the range of values for the range (as in domain/range) of the dataset, assuming that the series in one category are stacked.
Parameters:
data - the dataset.
Returns:
the range of values for the range of the dataset.

getMinimumStackedRangeValue

public static java.lang.Number getMinimumStackedRangeValue(CategoryDataset data)
Returns the minimum value in the dataset range, assuming that values in each category are "stacked".
Parameters:
data - the dataset.
Returns:
the minimum value.

getMaximumStackedRangeValue

public static java.lang.Number getMaximumStackedRangeValue(CategoryDataset data)
Returns the maximum value in the dataset range, assuming that values in each category are "stacked".
Parameters:
data - the dataset.
Returns:
the maximum value.

sampleFunction2D

public static XYDataset sampleFunction2D(Function2D f,
                                         double start,
                                         double end,
                                         int samples,
                                         java.lang.String seriesName)
Creates an XYDataset by sampling the specified function over a fixed range.
Parameters:
f - the function.
start - the start value for the range.
end - the end value for the range.
samples - the number of samples (must be > 1).
seriesName - the name to give the resulting series.
Returns:
the XYDataset.