/* ===========================================================
* 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.]
*
* --------------------------------
* TestIntervalCategoryDataset.java
* --------------------------------
* (C) Copyright 2009, by Object Refinery Limited.
*
* Original Author: David Gilbert (for Object Refinery Limited);
* Contributor(s): -;
*
* Changes
* -------
* 10-Sep-2009 : Version 1, based on DefaultCategoryDataset (DG);
*
*/
package org.jfree.data.general;
import org.jfree.chart.util.PublicCloneable;
import org.jfree.data.KeyedObjects2D;
import org.jfree.data.UnknownKeyException;
import org.jfree.data.category.IntervalCategoryDataset;
import java.io.Serializable;
import java.util.List;
/**
* A test implementation of the {@link IntervalCategoryDataset} interface.
*/
public class TestIntervalCategoryDataset extends AbstractDataset
implements IntervalCategoryDataset, PublicCloneable, Serializable {
/** For serialization. */
private static final long serialVersionUID = -8168173757291644622L;
/** A storage structure for the data. */
private KeyedObjects2D data;
/**
* Creates a new (empty) dataset.
*/
public TestIntervalCategoryDataset() {
this.data = new KeyedObjects2D();
}
/**
* Returns the number of rows in the table.
*
* @return The row count.
*
* @see #getColumnCount()
*/
@Override
public int getRowCount() {
return this.data.getRowCount();
}
/**
* Returns the number of columns in the table.
*
* @return The column count.
*
* @see #getRowCount()
*/
@Override
public int getColumnCount() {
return this.data.getColumnCount();
}
/**
* Returns a value from the table.
*
* @param row the row index (zero-based).
* @param column the column index (zero-based).
*
* @return The value (possibly <code>null</code>).
*
*/
@Override
public Number getValue(int row, int column) {
IntervalDataItem item = (IntervalDataItem) this.data.getObject(row,
column);
if (item == null) {
return null;
}
return item.getValue();
}
/**
* Returns the key for the specified row.
*
* @param row the row index (zero-based).
*
* @return The row key.
*
* @see #getRowIndex(Comparable)
* @see #getRowKeys()
* @see #getColumnKey(int)
*/
@Override
public Comparable getRowKey(int row) {
return this.data.getRowKey(row);
}
/**
* Returns the row index for a given key.
*
* @param key the row key (<code>null</code> not permitted).
*
* @return The row index.
*
* @see #getRowKey(int)
*/
@Override
public int getRowIndex(Comparable key) {
// defer null argument check
return this.data.getRowIndex(key);
}
/**
* Returns the row keys.
*
* @return The keys.
*
* @see #getRowKey(int)
*/
@Override
public List getRowKeys() {
return this.data.getRowKeys();
}
/**
* Returns a column key.
*
* @param column the column index (zero-based).
*
* @return The column key.
*
* @see #getColumnIndex(Comparable)
*/
@Override
public Comparable getColumnKey(int column) {
return this.data.getColumnKey(column);
}
/**
* Returns the column index for a given key.
*
* @param key the column key (<code>null</code> not permitted).
*
* @return The column index.
*
* @see #getColumnKey(int)
*/
@Override
public int getColumnIndex(Comparable key) {
// defer null argument check
return this.data.getColumnIndex(key);
}
/**
* Returns the column keys.
*
* @return The keys.
*
* @see #getColumnKey(int)
*/
@Override
public List getColumnKeys() {
return this.data.getColumnKeys();
}
/**
* Returns the value for a pair of keys.
*
* @param rowKey the row key (<code>null</code> not permitted).
* @param columnKey the column key (<code>null</code> not permitted).
*
* @return The value (possibly <code>null</code>).
*
* @throws UnknownKeyException if either key is not defined in the dataset.
*
*/
@Override
public Number getValue(Comparable rowKey, Comparable columnKey) {
IntervalDataItem item = (IntervalDataItem) this.data.getObject(rowKey,
columnKey);
if (item == null) {
return null;
}
return item.getValue();
}
/**
* Adds a value to the table. Performs the same function as setValue().
*
* @param value the value.
* @param rowKey the row key.
* @param columnKey the column key.
*
* @see #getValue(Comparable, Comparable)
*/
public void addItem(Number value, Number lower, Number upper,
Comparable rowKey, Comparable columnKey) {
IntervalDataItem item = new IntervalDataItem(value, lower, upper);
this.data.addObject(item, rowKey, columnKey);
fireDatasetChanged();
}
/**
* Adds a value to the table.
*
* @param value the value.
* @param rowKey the row key.
* @param columnKey the column key.
*
* @see #getValue(Comparable, Comparable)
*/
public void addItem(double value, double lower, double upper,
Comparable rowKey, Comparable columnKey) {
addItem(new Double(value), new Double(lower), new Double(upper),
rowKey, columnKey);
}
/**
* Adds or updates a value in the table and sends a
* {@link DatasetChangeEvent} to all registered listeners.
*
* @param value the value (<code>null</code> permitted).
* @param rowKey the row key (<code>null</code> not permitted).
* @param columnKey the column key (<code>null</code> not permitted).
*
* @see #getValue(Comparable, Comparable)
*/
public void setItem(Number value, Number lower, Number upper,
Comparable rowKey, Comparable columnKey) {
IntervalDataItem item = new IntervalDataItem(value, lower, upper);
this.data.addObject(item, rowKey, columnKey);
fireDatasetChanged();
}
/**
* Adds or updates a value in the table and sends a
* {@link DatasetChangeEvent} to all registered listeners.
*
* @param value the value.
* @param rowKey the row key (<code>null</code> not permitted).
* @param columnKey the column key (<code>null</code> not permitted).
*
* @see #getValue(Comparable, Comparable)
*/
public void setItem(double value, double lower, double upper,
Comparable rowKey, Comparable columnKey) {
setItem(new Double(value), new Double(lower), new Double(upper),
rowKey, columnKey);
}
/**
* Removes a value from the dataset and sends a {@link DatasetChangeEvent}
* to all registered listeners.
*
* @param rowKey the row key.
* @param columnKey the column key.
*
*/
public void removeItem(Comparable rowKey, Comparable columnKey) {
this.data.removeObject(rowKey, columnKey);
fireDatasetChanged();
}
/**
* Removes a row from the dataset and sends a {@link DatasetChangeEvent}
* to all registered listeners.
*
* @param rowIndex the row index.
*
* @see #removeColumn(int)
*/
public void removeRow(int rowIndex) {
this.data.removeRow(rowIndex);
fireDatasetChanged();
}
/**
* Removes a row from the dataset and sends a {@link DatasetChangeEvent}
* to all registered listeners.
*
* @param rowKey the row key.
*
* @see #removeColumn(Comparable)
*/
public void removeRow(Comparable rowKey) {
this.data.removeRow(rowKey);
fireDatasetChanged();
}
/**
* Removes a column from the dataset and sends a {@link DatasetChangeEvent}
* to all registered listeners.
*
* @param columnIndex the column index.
*
* @see #removeRow(int)
*/
public void removeColumn(int columnIndex) {
this.data.removeColumn(columnIndex);
fireDatasetChanged();
}
/**
* Removes a column from the dataset and sends a {@link DatasetChangeEvent}
* to all registered listeners.
*
* @param columnKey the column key (<code>null</code> not permitted).
*
* @see #removeRow(Comparable)
*
* @throws UnknownKeyException if <code>columnKey</code> is not defined
* in the dataset.
*/
public void removeColumn(Comparable columnKey) {
this.data.removeColumn(columnKey);
fireDatasetChanged();
}
/**
* Clears all data from the dataset and sends a {@link DatasetChangeEvent}
* to all registered listeners.
*/
public void clear() {
this.data.clear();
fireDatasetChanged();
}
/**
* Tests this dataset for equality with an arbitrary object.
*
* @param obj the object (<code>null</code> permitted).
*
* @return A boolean.
*/
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof TestIntervalCategoryDataset)) {
return false;
}
TestIntervalCategoryDataset that = (TestIntervalCategoryDataset) obj;
if (!getRowKeys().equals(that.getRowKeys())) {
return false;
}
if (!getColumnKeys().equals(that.getColumnKeys())) {
return false;
}
int rowCount = getRowCount();
int colCount = getColumnCount();
for (int r = 0; r < rowCount; r++) {
for (int c = 0; c < colCount; c++) {
Number v1 = getValue(r, c);
Number v2 = that.getValue(r, c);
if (v1 == null) {
if (v2 != null) {
return false;
}
}
else if (!v1.equals(v2)) {
return false;
}
}
}
return true;
}
/**
* Returns a hash code for the dataset.
*
* @return A hash code.
*/
@Override
public int hashCode() {
return this.data.hashCode();
}
/**
* Returns a clone of the dataset.
*
* @return A clone.
*
* @throws CloneNotSupportedException if there is a problem cloning the
* dataset.
*/
@Override
public Object clone() throws CloneNotSupportedException {
TestIntervalCategoryDataset clone = (TestIntervalCategoryDataset)
super.clone();
clone.data = (KeyedObjects2D) this.data.clone();
return clone;
}
@Override
public Number getStartValue(int series, int category) {
IntervalDataItem item = (IntervalDataItem) this.data.getObject(series,
category);
if (item == null) {
return null;
}
return item.getLowerBound();
}
@Override
public Number getStartValue(Comparable series, Comparable category) {
IntervalDataItem item = (IntervalDataItem) this.data.getObject(series,
category);
if (item == null) {
return null;
}
return item.getLowerBound();
}
@Override
public Number getEndValue(int series, int category) {
IntervalDataItem item = (IntervalDataItem) this.data.getObject(series,
category);
if (item == null) {
return null;
}
return item.getUpperBound();
}
@Override
public Number getEndValue(Comparable series, Comparable category) {
IntervalDataItem item = (IntervalDataItem) this.data.getObject(series,
category);
if (item == null) {
return null;
}
return item.getUpperBound();
}
}