1. /* ===========================================================

  2.  * JFreeChart : a free chart library for the Java(tm) platform

  3.  * ===========================================================

  4.  *

  5.  * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.

  6.  *

  7.  * Project Info:  http://www.jfree.org/jfreechart/index.html

  8.  *

  9.  * This library is free software; you can redistribute it and/or modify it under the terms

  10.  * of the GNU Lesser General Public License as published by the Free Software Foundation;

  11.  * either version 2.1 of the License, or (at your option) any later version.

  12.  *

  13.  * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;

  14.  * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

  15.  * See the GNU Lesser General Public License for more details.

  16.  *

  17.  * You should have received a copy of the GNU Lesser General Public License along with this

  18.  * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,

  19.  * Boston, MA 02111-1307, USA.

  20.  *

  21.  * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 

  22.  * in the United States and other countries.]

  23.  *

  24.  * ------------------------------

  25.  * TimeSeriesCollectionTests.java

  26.  * ------------------------------

  27.  * (C) Copyright 2003-2005, by Object Refinery Limited.

  28.  *

  29.  * Original Author:  David Gilbert (for Object Refinery Limited);

  30.  * Contributor(s):   -;

  31.  *

  32.  * $Id: TimeSeriesCollectionTests.java,v 1.2 2005/01/14 17:28:37 mungady Exp $

  33.  *

  34.  * Changes

  35.  * -------

  36.  * 01-May-2003 : Version 1 (DG);

  37.  * 04-Dec-2003 : Added a test for the getSurroundingItems() method (DG);

  38.  *

  39.  */

  40. 

  41. package org.jfree.data.time.junit;

  42. 

  43. import java.io.ByteArrayInputStream;

  44. import java.io.ByteArrayOutputStream;

  45. import java.io.ObjectInput;

  46. import java.io.ObjectInputStream;

  47. import java.io.ObjectOutput;

  48. import java.io.ObjectOutputStream;

  49. 

  50. import junit.framework.Test;

  51. import junit.framework.TestCase;

  52. import junit.framework.TestSuite;

  53. 

  54. import org.jfree.data.time.Day;

  55. import org.jfree.data.time.RegularTimePeriod;

  56. import org.jfree.data.time.TimePeriodAnchor;

  57. import org.jfree.data.time.TimeSeries;

  58. import org.jfree.data.time.TimeSeriesCollection;

  59. 

  60. /**

  61.  * A collection of test cases for the {@link TimeSeriesCollection} class.

  62.  */

  63. public class TimeSeriesCollectionTests extends TestCase {

  64. 

  65.     /**

  66.      * Returns the tests as a test suite.

  67.      *

  68.      * @return The test suite.

  69.      */

  70.     public static Test suite() {

  71.         return new TestSuite(TimeSeriesCollectionTests.class);

  72.     }

  73. 

  74.     /**

  75.      * Constructs a new set of tests.

  76.      *

  77.      * @param name  the name of the tests.

  78.      */

  79.     public TimeSeriesCollectionTests(String name) {

  80.         super(name);

  81.     }

  82. 

  83.     /**

  84.      * Some tests for the equals() method.

  85.      */

  86.     public void testEquals() {

  87. 

  88.         TimeSeriesCollection c1 = new TimeSeriesCollection();

  89.         TimeSeriesCollection c2 = new TimeSeriesCollection();

  90. 

  91.         TimeSeries s1 = new TimeSeries("Series 1");

  92.         TimeSeries s2 = new TimeSeries("Series 2");

  93. 

  94.         // newly created collections should be equal

  95.         boolean b1 = c1.equals(c2);

  96.         assertTrue("b1", b1);

  97. 

  98.         // add series to collection 1, should be not equal

  99.         c1.addSeries(s1);

  100.         c1.addSeries(s2);

  101.         boolean b2 = c1.equals(c2);

  102.         assertFalse("b2", b2);

  103. 

  104.         // now add the same series to collection 2 to make them equal again...

  105.         c2.addSeries(s1);

  106.         c2.addSeries(s2);

  107.         boolean b3 = c1.equals(c2);

  108.         assertTrue("b3", b3);

  109. 

  110.         // now remove series 2 from collection 2

  111.         c2.removeSeries(s2);

  112.         boolean b4 = c1.equals(c2);

  113.         assertFalse("b4", b4);

  114. 

  115.         // now remove series 2 from collection 1 to make them equal again

  116.         c1.removeSeries(s2);

  117.         boolean b5 = c1.equals(c2);

  118.         assertTrue("b5", b5);

  119.     }

  120. 

  121.     /**

  122.      * Tests the remove series method.

  123.      */

  124.     public void testRemoveSeries() {

  125. 

  126.         TimeSeriesCollection c1 = new TimeSeriesCollection();

  127. 

  128.         TimeSeries s1 = new TimeSeries("Series 1");

  129.         TimeSeries s2 = new TimeSeries("Series 2");

  130.         TimeSeries s3 = new TimeSeries("Series 3");

  131.         TimeSeries s4 = new TimeSeries("Series 4");

  132. 

  133.         c1.addSeries(s1);

  134.         c1.addSeries(s2);

  135.         c1.addSeries(s3);

  136.         c1.addSeries(s4);

  137. 

  138.         c1.removeSeries(s3);

  139. 

  140.         TimeSeries s = c1.getSeries(2);

  141.         boolean b1 = s.equals(s4);

  142.         assertTrue(b1);

  143. 

  144.     }

  145.     

  146.     /**

  147.      * Test the getSurroundingItems() method to ensure it is returning the values we expect.

  148.      */

  149.     public void testGetSurroundingItems() {

  150.         

  151.         TimeSeries series = new TimeSeries("Series 1", Day.class);

  152.         TimeSeriesCollection collection = new TimeSeriesCollection(series);

  153.         collection.setXPosition(TimePeriodAnchor.MIDDLE);

  154.         

  155.         // for a series with no data, we expect {-1, -1}...

  156.         int[] result = collection.getSurroundingItems(0, 1000L);

  157.         assertTrue(result[0] == -1);

  158.         assertTrue(result[1] == -1);

  159.         

  160.         // now test with a single value in the series...

  161.         Day today = new Day();

  162.         long start1 = today.getFirstMillisecond();

  163.         long middle1 = today.getMiddleMillisecond();

  164.         long end1 = today.getLastMillisecond();

  165.         

  166.         series.add(today, 99.9);

  167.         result = collection.getSurroundingItems(0, start1);

  168.         assertTrue(result[0] == -1);

  169.         assertTrue(result[1] == 0);

  170.         

  171.         result = collection.getSurroundingItems(0, middle1);

  172.         assertTrue(result[0] == 0);

  173.         assertTrue(result[1] == 0);

  174.         

  175.         result = collection.getSurroundingItems(0, end1);

  176.         assertTrue(result[0] == 0);

  177.         assertTrue(result[1] == -1);

  178.         

  179.         // now add a second value to the series...

  180.         Day tomorrow = (Day) today.next();

  181.         long start2 = tomorrow.getFirstMillisecond();

  182.         long middle2 = tomorrow.getMiddleMillisecond();

  183.         long end2 = tomorrow.getLastMillisecond();

  184.         

  185.         series.add(tomorrow, 199.9);

  186.         result = collection.getSurroundingItems(0, start2);

  187.         assertTrue(result[0] == 0);

  188.         assertTrue(result[1] == 1);

  189.         

  190.         result = collection.getSurroundingItems(0, middle2);

  191.         assertTrue(result[0] == 1);

  192.         assertTrue(result[1] == 1);

  193.         

  194.         result = collection.getSurroundingItems(0, end2);

  195.         assertTrue(result[0] == 1);

  196.         assertTrue(result[1] == -1);

  197.         

  198.         // now add a third value to the series...

  199.         Day yesterday = (Day) today.previous();

  200.         long start3 = yesterday.getFirstMillisecond();

  201.         long middle3 = yesterday.getMiddleMillisecond();

  202.         long end3 = yesterday.getLastMillisecond();

  203.         

  204.         series.add(yesterday, 1.23);

  205.         result = collection.getSurroundingItems(0, start3);

  206.         assertTrue(result[0] == -1);

  207.         assertTrue(result[1] == 0);

  208.         

  209.         result = collection.getSurroundingItems(0, middle3);

  210.         assertTrue(result[0] == 0);

  211.         assertTrue(result[1] == 0);

  212.         

  213.         result = collection.getSurroundingItems(0, end3);

  214.         assertTrue(result[0] == 0);

  215.         assertTrue(result[1] == 1);

  216.         

  217.     }

  218.     

  219.     /**

  220.      * Serialize an instance, restore it, and check for equality.

  221.      */

  222.     public void testSerialization() {

  223. 

  224.         TimeSeriesCollection c1 = new TimeSeriesCollection(createSeries());

  225.         TimeSeriesCollection c2 = null;

  226. 

  227.         try {

  228.             ByteArrayOutputStream buffer = new ByteArrayOutputStream();

  229.             ObjectOutput out = new ObjectOutputStream(buffer);

  230.             out.writeObject(c1);

  231.             out.close();

  232. 

  233.             ObjectInput in = new ObjectInputStream(

  234.                 new ByteArrayInputStream(buffer.toByteArray())

  235.             );

  236.             c2 = (TimeSeriesCollection) in.readObject();

  237.             in.close();

  238.         }

  239.         catch (Exception e) {

  240.             System.out.println(e.toString());

  241.         }

  242.         assertEquals(c1, c2);

  243. 

  244.     }

  245. 

  246.     /**

  247.      * Creates a time series for testing.

  248.      * 

  249.      * @return A time series.

  250.      */

  251.     private TimeSeries createSeries() {

  252.         RegularTimePeriod t = new Day();

  253.         TimeSeries series = new TimeSeries("Test");

  254.         series.add(t, 1.0);

  255.         t = t.next();

  256.         series.add(t, 2.0);

  257.         t = t.next();

  258.         series.add(t, null);

  259.         t = t.next();

  260.         series.add(t, 4.0);

  261.         return series;

  262.     }

  263.     

  264. }