/* ===========================================================
* JFreeChart : a free chart library for the Java(tm) platform
* ===========================================================
*
* (C) Copyright 2000-2012, 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.
*
* [Oracle and Java are registered trademarks of Oracle and/or its affiliates.
* Other names may be trademarks of their respective owners.]
*
* ----------------------------
* DefaultKeyedValuesTests.java
* ----------------------------
* (C) Copyright 2003-2012, by Object Refinery Limited.
*
* Original Author: David Gilbert (for Object Refinery Limited);
* Contributor(s): -;
*
* Changes
* -------
* 05-Mar-2003 : Version 1 (DG);
* 27-Aug-2003 : Moved SortOrder from org.jfree.data --> org.jfree.util (DG);
* 31-Jul-2006 : Added test for new clear() method (DG);
* 01-Aug-2006 : Extended testGetIndex() method (DG);
* 30-Apr-2007 : Added some new tests (DG);
* 03-Oct-2007 : Updated testRemoveValue() (DG);
* 21-Nov-2007 : Added testGetIndex2() method (DG);
* 17-Jun-2012 : Removed JCommon dependencies (DG);
*
*/
package org.jfree.data;
import org.jfree.chart.util.SortOrder;
import org.junit.Test;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.ObjectInput;
import java.io.ObjectInputStream;
import java.io.ObjectOutput;
import java.io.ObjectOutputStream;
import java.util.List;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotSame;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertSame;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
/**
* Tests for the {@link DefaultKeyedValues} class.
*/
public class DefaultKeyedValuesTest {
/**
* Checks that a new instance is empty.
*/
@Test
public void testConstructor() {
DefaultKeyedValues d = new DefaultKeyedValues();
assertEquals(0, d.getItemCount());
}
/**
* Some checks for the getItemCount() method.
*/
@Test
public void testGetItemCount() {
DefaultKeyedValues d = new DefaultKeyedValues();
assertEquals(0, d.getItemCount());
d.addValue("A", 1.0);
assertEquals(1, d.getItemCount());
d.addValue("B", 2.0);
assertEquals(2, d.getItemCount());
d.clear();
assertEquals(0, d.getItemCount());
}
/**
* Some checks for the getKeys() method.
*/
@Test
public void testGetKeys() {
DefaultKeyedValues d = new DefaultKeyedValues();
List keys = d.getKeys();
assertTrue(keys.isEmpty());
d.addValue("A", 1.0);
keys = d.getKeys();
assertEquals(1, keys.size());
assertTrue(keys.contains("A"));
d.addValue("B", 2.0);
keys = d.getKeys();
assertEquals(2, keys.size());
assertTrue(keys.contains("A"));
assertTrue(keys.contains("B"));
d.clear();
keys = d.getKeys();
assertEquals(0, keys.size());
}
/**
* A simple test for the clear() method.
*/
@Test
public void testClear() {
DefaultKeyedValues v1 = new DefaultKeyedValues();
v1.addValue("A", 1.0);
v1.addValue("B", 2.0);
assertEquals(2, v1.getItemCount());
v1.clear();
assertEquals(0, v1.getItemCount());
}
/**
* Some checks for the getValue() methods.
*/
@Test
public void testGetValue() {
DefaultKeyedValues v1 = new DefaultKeyedValues();
try {
/* Number n = */ v1.getValue(-1);
fail("Should have thrown an IndexOutOfBoundsException");
}
catch (IndexOutOfBoundsException e) {
// expected
}
try {
/* Number n = */ v1.getValue(0);
fail("Should have thrown an IndexOutOfBoundsException");
}
catch (IndexOutOfBoundsException e) {
// expected
}
DefaultKeyedValues v2 = new DefaultKeyedValues();
v2.addValue("K1", new Integer(1));
v2.addValue("K2", new Integer(2));
v2.addValue("K3", new Integer(3));
assertEquals(3, v2.getValue(2));
try {
/* Number n = */ v2.getValue("KK");
fail("Should have thrown an UnknownKeyException");
}
catch (UnknownKeyException e) {
assertEquals("Key not found: KK", e.getMessage());
}
}
/**
* Some checks for the getKey() methods.
*/
@Test
public void testGetKey() {
DefaultKeyedValues v1 = new DefaultKeyedValues();
try {
/* Comparable k = */ v1.getKey(-1);
fail("Should have thrown an IndexOutOfBoundsException");
}
catch (IndexOutOfBoundsException e) {
// expected
}
try {
/* Comparable k = */ v1.getKey(0);
fail("Should have thrown an IndexOutOfBoundsException");
}
catch (IndexOutOfBoundsException e) {
// expected
}
DefaultKeyedValues v2 = new DefaultKeyedValues();
v2.addValue("K1", new Integer(1));
v2.addValue("K2", new Integer(2));
v2.addValue("K3", new Integer(3));
assertEquals("K2", v2.getKey(1));
}
/**
* Some checks for the getIndex() methods.
*/
@Test
public void testGetIndex() {
DefaultKeyedValues v1 = new DefaultKeyedValues();
assertEquals(-1, v1.getIndex("K1"));
DefaultKeyedValues v2 = new DefaultKeyedValues();
v2.addValue("K1", new Integer(1));
v2.addValue("K2", new Integer(2));
v2.addValue("K3", new Integer(3));
assertEquals(2, v2.getIndex("K3"));
// try null
try {
v2.getIndex(null);
fail("Should have thrown an IllegalArgumentException on null key");
}
catch (IllegalArgumentException e) {
assertEquals("Null 'key' argument.", e.getMessage());
}
}
/**
* Another check for the getIndex(Comparable) method.
*/
@Test
public void testGetIndex2() {
DefaultKeyedValues v = new DefaultKeyedValues();
assertEquals(-1, v.getIndex("K1"));
v.addValue("K1", 1.0);
assertEquals(0, v.getIndex("K1"));
v.removeValue("K1");
assertEquals(-1, v.getIndex("K1"));
}
/**
* Some checks for the addValue() method.
*/
@Test
public void testAddValue() {
DefaultKeyedValues v1 = new DefaultKeyedValues();
v1.addValue("A", 1.0);
assertEquals(1.0, v1.getValue("A"));
v1.addValue("B", 2.0);
assertEquals(2.0, v1.getValue("B"));
v1.addValue("B", 3.0);
assertEquals(3.0, v1.getValue("B"));
assertEquals(2, v1.getItemCount());
v1.addValue("A", null);
assertNull(v1.getValue("A"));
assertEquals(2, v1.getItemCount());
try {
v1.addValue(null, 99.9);
fail("Should have thrown IllegalArgumentException on null key");
}
catch (IllegalArgumentException e) {
assertEquals("Null 'key' argument.", e.getMessage());
}
}
/**
* Some checks for the insertValue() method.
*/
@Test
public void testInsertValue() {
DefaultKeyedValues v1 = new DefaultKeyedValues();
v1.insertValue(0, "A", 1.0);
assertEquals(1.0, v1.getValue(0));
v1.insertValue(0, "B", 2.0);
assertEquals(2.0, v1.getValue(0));
assertEquals(1.0, v1.getValue(1));
// it's OK to use an index equal to the size of the list
v1.insertValue(2, "C", 3.0);
assertEquals(2.0, v1.getValue(0));
assertEquals(1.0, v1.getValue(1));
assertEquals(3.0, v1.getValue(2));
// try replacing an existing value
v1.insertValue(2, "B", 4.0);
assertEquals(1.0, v1.getValue(0));
assertEquals(3.0, v1.getValue(1));
assertEquals(4.0, v1.getValue(2));
}
/**
* Some checks for the clone() method.
*/
@Test
public void testCloning() throws CloneNotSupportedException {
DefaultKeyedValues v1 = new DefaultKeyedValues();
v1.addValue("V1", new Integer(1));
v1.addValue("V2", null);
v1.addValue("V3", new Integer(3));
DefaultKeyedValues v2 = (DefaultKeyedValues) v1.clone();
assertNotSame(v1, v2);
assertSame(v1.getClass(), v2.getClass());
assertEquals(v1, v2);
// confirm that the clone is independent of the original
v2.setValue("V1", new Integer(44));
assertFalse(v1.equals(v2));
}
/**
* Check that inserting and retrieving values works as expected.
*/
@Test
public void testInsertAndRetrieve() {
DefaultKeyedValues data = new DefaultKeyedValues();
data.addValue("A", new Double(1.0));
data.addValue("B", new Double(2.0));
data.addValue("C", new Double(3.0));
data.addValue("D", null);
// check key order
assertEquals(data.getKey(0), "A");
assertEquals(data.getKey(1), "B");
assertEquals(data.getKey(2), "C");
assertEquals(data.getKey(3), "D");
// check retrieve value by key
assertEquals(data.getValue("A"), 1.0);
assertEquals(data.getValue("B"), 2.0);
assertEquals(data.getValue("C"), 3.0);
assertEquals(data.getValue("D"), null);
// check retrieve value by index
assertEquals(data.getValue(0), 1.0);
assertEquals(data.getValue(1), 2.0);
assertEquals(data.getValue(2), 3.0);
assertEquals(data.getValue(3), null);
}
/**
* Some tests for the removeValue() method.
*/
@Test
public void testRemoveValue() {
DefaultKeyedValues data = new DefaultKeyedValues();
data.addValue("A", new Double(1.0));
data.addValue("B", null);
data.addValue("C", new Double(3.0));
data.addValue("D", new Double(2.0));
assertEquals(1, data.getIndex("B"));
data.removeValue("B");
assertEquals(-1, data.getIndex("B"));
try {
data.removeValue("XXX");
fail("Should have thrown an UnknownKeyException");
}
catch (UnknownKeyException e) {
assertEquals("The key (XXX) is not recognised.", e.getMessage());
}
}
/**
* Tests sorting of data by key (ascending).
*/
@Test
public void testSortByKeyAscending() {
DefaultKeyedValues data = new DefaultKeyedValues();
data.addValue("C", new Double(1.0));
data.addValue("B", null);
data.addValue("D", new Double(3.0));
data.addValue("A", new Double(2.0));
data.sortByKeys(SortOrder.ASCENDING);
// check key order
assertEquals(data.getKey(0), "A");
assertEquals(data.getKey(1), "B");
assertEquals(data.getKey(2), "C");
assertEquals(data.getKey(3), "D");
// check retrieve value by key
assertEquals(data.getValue("A"), 2.0);
assertEquals(data.getValue("B"), null);
assertEquals(data.getValue("C"), 1.0);
assertEquals(data.getValue("D"), 3.0);
// check retrieve value by index
assertEquals(data.getValue(0), 2.0);
assertEquals(data.getValue(1), null);
assertEquals(data.getValue(2), 1.0);
assertEquals(data.getValue(3), 3.0);
}
/**
* Tests sorting of data by key (descending).
*/
@Test
public void testSortByKeyDescending() {
DefaultKeyedValues data = new DefaultKeyedValues();
data.addValue("C", new Double(1.0));
data.addValue("B", null);
data.addValue("D", new Double(3.0));
data.addValue("A", new Double(2.0));
data.sortByKeys(SortOrder.DESCENDING);
// check key order
assertEquals(data.getKey(0), "D");
assertEquals(data.getKey(1), "C");
assertEquals(data.getKey(2), "B");
assertEquals(data.getKey(3), "A");
// check retrieve value by key
assertEquals(data.getValue("A"), 2.0);
assertEquals(data.getValue("B"), null);
assertEquals(data.getValue("C"), 1.0);
assertEquals(data.getValue("D"), 3.0);
// check retrieve value by index
assertEquals(data.getValue(0), 3.0);
assertEquals(data.getValue(1), 1.0);
assertEquals(data.getValue(2), null);
assertEquals(data.getValue(3), 2.0);
}
/**
* Tests sorting of data by value (ascending).
*/
@Test
public void testSortByValueAscending() {
DefaultKeyedValues data = new DefaultKeyedValues();
data.addValue("C", new Double(1.0));
data.addValue("B", null);
data.addValue("D", new Double(3.0));
data.addValue("A", new Double(2.0));
data.sortByValues(SortOrder.ASCENDING);
// check key order
assertEquals(data.getKey(0), "C");
assertEquals(data.getKey(1), "A");
assertEquals(data.getKey(2), "D");
assertEquals(data.getKey(3), "B");
// check retrieve value by key
assertEquals(data.getValue("A"), 2.0);
assertEquals(data.getValue("B"), null);
assertEquals(data.getValue("C"), 1.0);
assertEquals(data.getValue("D"), 3.0);
// check retrieve value by index
assertEquals(data.getValue(0), 1.0);
assertEquals(data.getValue(1), 2.0);
assertEquals(data.getValue(2), 3.0);
assertEquals(data.getValue(3), null);
}
/**
* Tests sorting of data by key (descending).
*/
@Test
public void testSortByValueDescending() {
DefaultKeyedValues data = new DefaultKeyedValues();
data.addValue("C", new Double(1.0));
data.addValue("B", null);
data.addValue("D", new Double(3.0));
data.addValue("A", new Double(2.0));
data.sortByValues(SortOrder.DESCENDING);
// check key order
assertEquals(data.getKey(0), "D");
assertEquals(data.getKey(1), "A");
assertEquals(data.getKey(2), "C");
assertEquals(data.getKey(3), "B");
// check retrieve value by key
assertEquals(data.getValue("A"), 2.0);
assertEquals(data.getValue("B"), null);
assertEquals(data.getValue("C"), 1.0);
assertEquals(data.getValue("D"), 3.0);
// check retrieve value by index
assertEquals(data.getValue(0), 3.0);
assertEquals(data.getValue(1), 2.0);
assertEquals(data.getValue(2), 1.0);
assertEquals(data.getValue(3), null);
}
/**
* Serialize an instance, restore it, and check for equality.
*/
@Test
public void testSerialization() throws IOException, ClassNotFoundException {
DefaultKeyedValues v1 = new DefaultKeyedValues();
v1.addValue("Key 1", new Double(23));
v1.addValue("Key 2", null);
v1.addValue("Key 3", new Double(42));
ByteArrayOutputStream buffer = new ByteArrayOutputStream();
ObjectOutput out = new ObjectOutputStream(buffer);
out.writeObject(v1);
out.close();
ObjectInput in = new ObjectInputStream(
new ByteArrayInputStream(buffer.toByteArray())
);
DefaultKeyedValues v2 = (DefaultKeyedValues) in.readObject();
in.close();
assertEquals(v1, v2);
}
}