/* ===========================================================
* JFreeChart : a free chart library for the Java(tm) platform
* ===========================================================
*
* (C) Copyright 2000-2007, by Object Refinery Limited and Contributors.
*
* Project Info: http://www.jfree.org/jfreechart/index.html
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
* License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
* USA.
*
* [Java is a trademark or registered trademark of Sun Microsystems, Inc.
* in the United States and other countries.]
*
* --------------------------
* DatasetUtilitiesTests.java
* --------------------------
* (C) Copyright 2003-2007, by Object Refinery Limited and Contributors.
*
* Original Author: David Gilbert (for Object Refinery Limited);
* Contributor(s): -;
*
* Changes
* -------
* 18-Sep-2003 : Version 1 (DG);
* 23-Mar-2004 : Added test for maximumStackedRangeValue() method (DG);
* 04-Oct-2004 : Eliminated NumberUtils usage (DG);
* 07-Jan-2005 : Updated for method name changes (DG);
* 03-Feb-2005 : Added testFindStackedRangeBounds2() method (DG);
* 26-Sep-2007 : Added testIsEmptyOrNullXYDataset() method (DG);
*
*/
package org.jfree.data.general.junit;
import junit.framework.Test;
import junit.framework.TestCase;
import junit.framework.TestSuite;
import org.jfree.data.KeyToGroupMap;
import org.jfree.data.Range;
import org.jfree.data.category.CategoryDataset;
import org.jfree.data.category.DefaultCategoryDataset;
import org.jfree.data.general.DatasetUtilities;
import org.jfree.data.general.DefaultPieDataset;
import org.jfree.data.general.PieDataset;
import org.jfree.data.xy.DefaultTableXYDataset;
import org.jfree.data.xy.TableXYDataset;
import org.jfree.data.xy.XYDataset;
import org.jfree.data.xy.XYSeries;
import org.jfree.data.xy.XYSeriesCollection;
/**
* Tests for the {@link DatasetUtilities} class.
*/
public class DatasetUtilitiesTests extends TestCase {
private static final double EPSILON = 0.0000000001;
/**
* Returns the tests as a test suite.
*
* @return The test suite.
*/
public static Test suite() {
return new TestSuite(DatasetUtilitiesTests.class);
}
/**
* Constructs a new set of tests.
*
* @param name the name of the tests.
*/
public DatasetUtilitiesTests(String name) {
super(name);
}
/**
* Some tests to verify that Java does what I think it does!
*/
public void testJava() {
assertTrue(Double.isNaN(Math.min(1.0, Double.NaN)));
assertTrue(Double.isNaN(Math.max(1.0, Double.NaN)));
}
/**
* Some tests for the calculatePieDatasetTotal() method.
*/
public void testCalculatePieDatasetTotal() {
DefaultPieDataset d = new DefaultPieDataset();
assertEquals(0.0, DatasetUtilities.calculatePieDatasetTotal(d),
EPSILON);
d.setValue("A", 1.0);
assertEquals(1.0, DatasetUtilities.calculatePieDatasetTotal(d),
EPSILON);
d.setValue("B", 3.0);
assertEquals(4.0, DatasetUtilities.calculatePieDatasetTotal(d),
EPSILON);
}
/**
* Some tests for the findDomainBounds() method.
*/
public void testFindDomainBounds() {
XYDataset dataset = createXYDataset1();
Range r = DatasetUtilities.findDomainBounds(dataset);
assertEquals(1.0, r.getLowerBound(), EPSILON);
assertEquals(3.0, r.getUpperBound(), EPSILON);
}
/**
* Some tests for the iterateDomainBounds() method.
*/
public void testIterateDomainBounds() {
XYDataset dataset = createXYDataset1();
Range r = DatasetUtilities.iterateDomainBounds(dataset);
assertEquals(1.0, r.getLowerBound(), EPSILON);
assertEquals(3.0, r.getUpperBound(), EPSILON);
}
/**
* Some tests for the findRangeExtent() method.
*/
public void testFindRangeBounds1() {
CategoryDataset dataset = createCategoryDataset1();
Range r = DatasetUtilities.findRangeBounds(dataset);
assertEquals(1.0, r.getLowerBound(), EPSILON);
assertEquals(6.0, r.getUpperBound(), EPSILON);
}
/**
* Some tests for the findRangeBounds() method.
*/
public void testFindRangeBounds2() {
XYDataset dataset = createXYDataset1();
Range r = DatasetUtilities.findRangeBounds(dataset);
assertEquals(100.0, r.getLowerBound(), EPSILON);
assertEquals(105.0, r.getUpperBound(), EPSILON);
}
/**
* Some tests for the iterateCategoryRangeBounds() method.
*/
public void testIterateCategoryRangeBounds() {
CategoryDataset dataset = createCategoryDataset1();
Range r = DatasetUtilities.iterateCategoryRangeBounds(dataset, false);
assertEquals(1.0, r.getLowerBound(), EPSILON);
assertEquals(6.0, r.getUpperBound(), EPSILON);
}
/**
* Some tests for the iterateXYRangeBounds() method.
*/
public void testIterateXYRangeBounds() {
XYDataset dataset = createXYDataset1();
Range r = DatasetUtilities.iterateXYRangeBounds(dataset);
assertEquals(100.0, r.getLowerBound(), EPSILON);
assertEquals(105.0, r.getUpperBound(), EPSILON);
}
/**
* Check the range returned when a series contains a null value.
*/
public void testIterateXYRangeBounds2() {
XYSeries s1 = new XYSeries("S1");
s1.add(1.0, 1.1);
s1.add(2.0, null);
s1.add(3.0, 3.3);
XYSeriesCollection dataset = new XYSeriesCollection(s1);
Range r = DatasetUtilities.iterateXYRangeBounds(dataset);
assertEquals(1.1, r.getLowerBound(), EPSILON);
assertEquals(3.3, r.getUpperBound(), EPSILON);
}
/**
* Some tests for the findMinimumDomainValue() method.
*/
public void testFindMinimumDomainValue() {
XYDataset dataset = createXYDataset1();
Number minimum = DatasetUtilities.findMinimumDomainValue(dataset);
assertEquals(new Double(1.0), minimum);
}
/**
* Some tests for the findMaximumDomainValue() method.
*/
public void testFindMaximumDomainValue() {
XYDataset dataset = createXYDataset1();
Number maximum = DatasetUtilities.findMaximumDomainValue(dataset);
assertEquals(new Double(3.0), maximum);
}
/**
* Some tests for the findMinimumRangeValue() method.
*/
public void testFindMinimumRangeValue() {
CategoryDataset d1 = createCategoryDataset1();
Number min1 = DatasetUtilities.findMinimumRangeValue(d1);
assertEquals(new Double(1.0), min1);
XYDataset d2 = createXYDataset1();
Number min2 = DatasetUtilities.findMinimumRangeValue(d2);
assertEquals(new Double(100.0), min2);
}
/**
* Some tests for the findMaximumRangeValue() method.
*/
public void testFindMaximumRangeValue() {
CategoryDataset d1 = createCategoryDataset1();
Number max1 = DatasetUtilities.findMaximumRangeValue(d1);
assertEquals(new Double(6.0), max1);
XYDataset dataset = createXYDataset1();
Number maximum = DatasetUtilities.findMaximumRangeValue(dataset);
assertEquals(new Double(105.0), maximum);
}
/**
* A quick test of the min and max range value methods.
*/
public void testMinMaxRange() {
DefaultCategoryDataset dataset = new DefaultCategoryDataset();
dataset.addValue(100.0, "Series 1", "Type 1");
dataset.addValue(101.1, "Series 1", "Type 2");
Number min = DatasetUtilities.findMinimumRangeValue(dataset);
assertTrue(min.doubleValue() < 100.1);
Number max = DatasetUtilities.findMaximumRangeValue(dataset);
assertTrue(max.doubleValue() > 101.0);
}
/**
* A test to reproduce bug report 803660.
*/
public void test803660() {
DefaultCategoryDataset dataset = new DefaultCategoryDataset();
dataset.addValue(100.0, "Series 1", "Type 1");
dataset.addValue(101.1, "Series 1", "Type 2");
Number n = DatasetUtilities.findMaximumRangeValue(dataset);
assertTrue(n.doubleValue() > 101.0);
}
/**
* A simple test for the cumulative range calculation. The sequence of
* "cumulative" values are considered to be { 0.0, 10.0, 25.0, 18.0 } so
* the range should be 0.0 -> 25.0.
*/
public void testCumulativeRange1() {
DefaultCategoryDataset dataset = new DefaultCategoryDataset();
dataset.addValue(10.0, "Series 1", "Start");
dataset.addValue(15.0, "Series 1", "Delta 1");
dataset.addValue(-7.0, "Series 1", "Delta 2");
Range range = DatasetUtilities.findCumulativeRangeBounds(dataset);
assertEquals(0.0, range.getLowerBound(), 0.00000001);
assertEquals(25.0, range.getUpperBound(), 0.00000001);
}
/**
* A further test for the cumulative range calculation.
*/
public void testCumulativeRange2() {
DefaultCategoryDataset dataset = new DefaultCategoryDataset();
dataset.addValue(-21.4, "Series 1", "Start Value");
dataset.addValue(11.57, "Series 1", "Delta 1");
dataset.addValue(3.51, "Series 1", "Delta 2");
dataset.addValue(-12.36, "Series 1", "Delta 3");
dataset.addValue(3.39, "Series 1", "Delta 4");
dataset.addValue(38.68, "Series 1", "Delta 5");
dataset.addValue(-43.31, "Series 1", "Delta 6");
dataset.addValue(-29.59, "Series 1", "Delta 7");
dataset.addValue(35.30, "Series 1", "Delta 8");
dataset.addValue(5.0, "Series 1", "Delta 9");
Range range = DatasetUtilities.findCumulativeRangeBounds(dataset);
assertEquals(-49.51, range.getLowerBound(), 0.00000001);
assertEquals(23.39, range.getUpperBound(), 0.00000001);
}
/**
* Test the creation of a dataset from an array.
*/
public void testCreateCategoryDataset1() {
String[] rowKeys = {"R1", "R2", "R3"};
String[] columnKeys = {"C1", "C2"};
double[][] data = new double[3][];
data[0] = new double[] {1.1, 1.2};
data[1] = new double[] {2.1, 2.2};
data[2] = new double[] {3.1, 3.2};
CategoryDataset dataset = DatasetUtilities.createCategoryDataset(
rowKeys, columnKeys, data);
assertTrue(dataset.getRowCount() == 3);
assertTrue(dataset.getColumnCount() == 2);
}
/**
* Test the creation of a dataset from an array. This time is should fail
* because the array dimensions are around the wrong way.
*/
public void testCreateCategoryDataset2() {
boolean pass = false;
String[] rowKeys = {"R1", "R2", "R3"};
String[] columnKeys = {"C1", "C2"};
double[][] data = new double[2][];
data[0] = new double[] {1.1, 1.2, 1.3};
data[1] = new double[] {2.1, 2.2, 2.3};
CategoryDataset dataset = null;
try {
dataset = DatasetUtilities.createCategoryDataset(rowKeys,
columnKeys, data);
}
catch (IllegalArgumentException e) {
pass = true; // got it!
}
assertTrue(pass);
assertTrue(dataset == null);
}
/**
* Test for a bug reported in the forum:
*
* http://www.jfree.org/phpBB2/viewtopic.php?t=7903
*/
public void testMaximumStackedRangeValue() {
double v1 = 24.3;
double v2 = 14.2;
double v3 = 33.2;
double v4 = 32.4;
double v5 = 26.3;
double v6 = 22.6;
Number answer = new Double(Math.max(v1 + v2 + v3, v4 + v5 + v6));
DefaultCategoryDataset d = new DefaultCategoryDataset();
d.addValue(v1, "Row 0", "Column 0");
d.addValue(v2, "Row 1", "Column 0");
d.addValue(v3, "Row 2", "Column 0");
d.addValue(v4, "Row 0", "Column 1");
d.addValue(v5, "Row 1", "Column 1");
d.addValue(v6, "Row 2", "Column 1");
Number max = DatasetUtilities.findMaximumStackedRangeValue(d);
assertTrue(max.equals(answer));
}
/**
* Some checks for the findStackedRangeBounds() method.
*/
public void testFindStackedRangeBoundsForCategoryDataset1() {
CategoryDataset d1 = createCategoryDataset1();
Range r = DatasetUtilities.findStackedRangeBounds(d1);
assertEquals(0.0, r.getLowerBound(), EPSILON);
assertEquals(15.0, r.getUpperBound(), EPSILON);
d1 = createCategoryDataset2();
r = DatasetUtilities.findStackedRangeBounds(d1);
assertEquals(-2.0, r.getLowerBound(), EPSILON);
assertEquals(2.0, r.getUpperBound(), EPSILON);
}
/**
* Some checks for the findStackedRangeBounds() method.
*/
public void testFindStackedRangeBoundsForCategoryDataset2() {
CategoryDataset d1 = new DefaultCategoryDataset();
Range r = DatasetUtilities.findStackedRangeBounds(d1);
assertTrue(r == null);
}
/**
* Some checks for the findStackedRangeBounds() method.
*/
public void testFindStackedRangeBoundsForTableXYDataset1() {
TableXYDataset d2 = createTableXYDataset1();
Range r = DatasetUtilities.findStackedRangeBounds(d2);
assertEquals(-2.0, r.getLowerBound(), EPSILON);
assertEquals(2.0, r.getUpperBound(), EPSILON);
}
/**
* Some checks for the findStackedRangeBounds() method.
*/
public void testFindStackedRangeBoundsForTableXYDataset2() {
DefaultTableXYDataset d = new DefaultTableXYDataset();
Range r = DatasetUtilities.findStackedRangeBounds(d);
assertEquals(r, new Range(0.0, 0.0));
}
/**
* Tests the stacked range extent calculation.
*/
public void testStackedRangeWithMap() {
CategoryDataset d = createCategoryDataset1();
KeyToGroupMap map = new KeyToGroupMap("G0");
map.mapKeyToGroup("R2", "G1");
Range r = DatasetUtilities.findStackedRangeBounds(d, map);
assertEquals(0.0, r.getLowerBound(), EPSILON);
assertEquals(9.0, r.getUpperBound(), EPSILON);
}
/**
* Some checks for the isEmptyOrNull(XYDataset) method.
*/
public void testIsEmptyOrNullXYDataset() {
XYSeriesCollection dataset = null;
assertTrue(DatasetUtilities.isEmptyOrNull(dataset));
dataset = new XYSeriesCollection();
assertTrue(DatasetUtilities.isEmptyOrNull(dataset));
XYSeries s1 = new XYSeries("S1");
dataset.addSeries(s1);
assertTrue(DatasetUtilities.isEmptyOrNull(dataset));
s1.add(1.0, 2.0);
assertFalse(DatasetUtilities.isEmptyOrNull(dataset));
s1.clear();
assertTrue(DatasetUtilities.isEmptyOrNull(dataset));
}
/**
* Some checks for the limitPieDataset() methods.
*/
public void testLimitPieDataset() {
// check that empty dataset is handled OK
DefaultPieDataset d1 = new DefaultPieDataset();
PieDataset d2 = DatasetUtilities.createConsolidatedPieDataset(d1,
"Other", 0.05);
assertEquals(0, d2.getItemCount());
// check that minItem limit is observed
d1.setValue("Item 1", 1.0);
d1.setValue("Item 2", 49.50);
d1.setValue("Item 3", 49.50);
d2 = DatasetUtilities.createConsolidatedPieDataset(d1, "Other", 0.05);
assertEquals(3, d2.getItemCount());
assertEquals("Item 1", d2.getKey(0));
assertEquals("Item 2", d2.getKey(1));
assertEquals("Item 3", d2.getKey(2));
// check that minItem limit is observed
d1.setValue("Item 4", 1.0);
d2 = DatasetUtilities.createConsolidatedPieDataset(d1, "Other", 0.05,
2);
// and that simple aggregation works
assertEquals(3, d2.getItemCount());
assertEquals("Item 2", d2.getKey(0));
assertEquals("Item 3", d2.getKey(1));
assertEquals("Other", d2.getKey(2));
assertEquals(new Double(2.0), d2.getValue("Other"));
}
/**
* Creates a dataset for testing.
*
* @return A dataset.
*/
private CategoryDataset createCategoryDataset1() {
DefaultCategoryDataset result = new DefaultCategoryDataset();
result.addValue(1.0, "R0", "C0");
result.addValue(1.0, "R1", "C0");
result.addValue(1.0, "R2", "C0");
result.addValue(4.0, "R0", "C1");
result.addValue(5.0, "R1", "C1");
result.addValue(6.0, "R2", "C1");
return result;
}
/**
* Creates a dataset for testing.
*
* @return A dataset.
*/
private CategoryDataset createCategoryDataset2() {
DefaultCategoryDataset result = new DefaultCategoryDataset();
result.addValue(1.0, "R0", "C0");
result.addValue(-2.0, "R1", "C0");
result.addValue(2.0, "R0", "C1");
result.addValue(-1.0, "R1", "C1");
return result;
}
/**
* Creates a dataset for testing.
*
* @return A dataset.
*/
private XYDataset createXYDataset1() {
XYSeries series1 = new XYSeries("S1");
series1.add(1.0, 100.0);
series1.add(2.0, 101.0);
series1.add(3.0, 102.0);
XYSeries series2 = new XYSeries("S2");
series2.add(1.0, 103.0);
series2.add(2.0, null);
series2.add(3.0, 105.0);
XYSeriesCollection result = new XYSeriesCollection();
result.addSeries(series1);
result.addSeries(series2);
result.setIntervalWidth(0.0);
return result;
}
/**
* Creates a sample dataset for testing purposes.
*
* @return A sample dataset.
*/
private TableXYDataset createTableXYDataset1() {
DefaultTableXYDataset dataset = new DefaultTableXYDataset();
XYSeries s1 = new XYSeries("Series 1", true, false);
s1.add(1.0, 1.0);
s1.add(2.0, 2.0);
dataset.addSeries(s1);
XYSeries s2 = new XYSeries("Series 2", true, false);
s2.add(1.0, -2.0);
s2.add(2.0, -1.0);
dataset.addSeries(s2);
return dataset;
}
}