/* ===========================================================
* 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.]
*
* ---------------------------
* SlidingCategoryDataset.java
* ---------------------------
* (C) Copyright 2008-2012, by Object Refinery Limited.
*
* Original Author: David Gilbert (for Object Refinery Limited);
* Contributor(s): -;
*
* Changes
* -------
* 08-May-2008 : Version 1 (DG);
* 15-Mar-2009 : Fixed bug in getColumnKeys() method (DG);
* 17-Jun-2012 : Removed JCommon dependencies (DG);
*
*/
package org.jfree.data.category;
import java.util.Collections;
import java.util.List;
import org.jfree.chart.util.PublicCloneable;
import org.jfree.data.UnknownKeyException;
import org.jfree.data.general.AbstractDataset;
import org.jfree.data.general.DatasetChangeEvent;
/**
* A {@link CategoryDataset} implementation that presents a subset of the
* categories in an underlying dataset. The index of the first "visible"
* category can be modified, which provides a means of "sliding" through
* the categories in the underlying dataset.
*
* @since 1.0.10
*/
public class SlidingCategoryDataset extends AbstractDataset
implements CategoryDataset {
/** The underlying dataset. */
private CategoryDataset underlying;
/** The index of the first category to present. */
private int firstCategoryIndex;
/** The maximum number of categories to present. */
private int maximumCategoryCount;
/**
* Creates a new instance.
*
* @param underlying the underlying dataset (<code>null</code> not
* permitted).
* @param firstColumn the index of the first visible column from the
* underlying dataset.
* @param maxColumns the maximumColumnCount.
*/
public SlidingCategoryDataset(CategoryDataset underlying, int firstColumn,
int maxColumns) {
this.underlying = underlying;
this.firstCategoryIndex = firstColumn;
this.maximumCategoryCount = maxColumns;
}
/**
* Returns the underlying dataset that was supplied to the constructor.
*
* @return The underlying dataset (never <code>null</code>).
*/
public CategoryDataset getUnderlyingDataset() {
return this.underlying;
}
/**
* Returns the index of the first visible category.
*
* @return The index.
*
* @see #setFirstCategoryIndex(int)
*/
public int getFirstCategoryIndex() {
return this.firstCategoryIndex;
}
/**
* Sets the index of the first category that should be used from the
* underlying dataset, and sends a {@link DatasetChangeEvent} to all
* registered listeners.
*
* @param first the index.
*
* @see #getFirstCategoryIndex()
*/
public void setFirstCategoryIndex(int first) {
if (first < 0 || first >= this.underlying.getColumnCount()) {
throw new IllegalArgumentException("Invalid index.");
}
this.firstCategoryIndex = first;
fireDatasetChanged();
}
/**
* Returns the maximum category count.
*
* @return The maximum category count.
*
* @see #setMaximumCategoryCount(int)
*/
public int getMaximumCategoryCount() {
return this.maximumCategoryCount;
}
/**
* Sets the maximum category count and sends a {@link DatasetChangeEvent}
* to all registered listeners.
*
* @param max the maximum.
*
* @see #getMaximumCategoryCount()
*/
public void setMaximumCategoryCount(int max) {
if (max < 0) {
throw new IllegalArgumentException("Requires 'max' >= 0.");
}
this.maximumCategoryCount = max;
fireDatasetChanged();
}
/**
* Returns the index of the last column for this dataset, or -1.
*
* @return The index.
*/
private int lastCategoryIndex() {
if (this.maximumCategoryCount == 0) {
return -1;
}
return Math.min(this.firstCategoryIndex + this.maximumCategoryCount,
this.underlying.getColumnCount()) - 1;
}
/**
* Returns the index for the specified column key.
*
* @param key the key.
*
* @return The column index, or -1 if the key is not recognised.
*/
@Override
public int getColumnIndex(Comparable key) {
int index = this.underlying.getColumnIndex(key);
if (index >= this.firstCategoryIndex && index <= lastCategoryIndex()) {
return index - this.firstCategoryIndex;
}
return -1; // we didn't find the key
}
/**
* Returns the column key for a given index.
*
* @param column the column index (zero-based).
*
* @return The column key.
*
* @throws IndexOutOfBoundsException if <code>row</code> is out of bounds.
*/
@Override
public Comparable getColumnKey(int column) {
return this.underlying.getColumnKey(column + this.firstCategoryIndex);
}
/**
* Returns the column keys.
*
* @return The keys.
*
* @see #getColumnKey(int)
*/
@Override
public List<Comparable> getColumnKeys() {
List<Comparable> result = new java.util.ArrayList<Comparable>();
int last = lastCategoryIndex();
for (int i = this.firstCategoryIndex; i <= last; i++) {
result.add(this.underlying.getColumnKey(i));
}
return Collections.unmodifiableList(result);
}
/**
* Returns the row index for a given key.
*
* @param key the row key.
*
* @return The row index, or <code>-1</code> if the key is unrecognised.
*/
@Override
public int getRowIndex(Comparable key) {
return this.underlying.getRowIndex(key);
}
/**
* Returns the row key for a given index.
*
* @param row the row index (zero-based).
*
* @return The row key.
*
* @throws IndexOutOfBoundsException if <code>row</code> is out of bounds.
*/
@Override
public Comparable getRowKey(int row) {
return this.underlying.getRowKey(row);
}
/**
* Returns the row keys.
*
* @return The keys.
*/
@Override
public List<Comparable> getRowKeys() {
return this.underlying.getRowKeys();
}
/**
* 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) {
int r = getRowIndex(rowKey);
int c = getColumnIndex(columnKey);
if (c != -1) {
return this.underlying.getValue(r, c + this.firstCategoryIndex);
}
else {
throw new UnknownKeyException("Unknown columnKey: " + columnKey);
}
}
/**
* Returns the number of columns in the table.
*
* @return The column count.
*/
@Override
public int getColumnCount() {
int last = lastCategoryIndex();
if (last == -1) {
return 0;
}
else {
return Math.max(last - this.firstCategoryIndex + 1, 0);
}
}
/**
* Returns the number of rows in the table.
*
* @return The row count.
*/
@Override
public int getRowCount() {
return this.underlying.getRowCount();
}
/**
* 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) {
return this.underlying.getValue(row, column + this.firstCategoryIndex);
}
/**
* Tests this <code>SlidingCategoryDataset</code> 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 SlidingCategoryDataset)) {
return false;
}
SlidingCategoryDataset that = (SlidingCategoryDataset) obj;
if (this.firstCategoryIndex != that.firstCategoryIndex) {
return false;
}
if (this.maximumCategoryCount != that.maximumCategoryCount) {
return false;
}
if (!this.underlying.equals(that.underlying)) {
return false;
}
return true;
}
/**
* Returns an independent copy of the dataset. Note that:
* <ul>
* <li>the underlying dataset is only cloned if it implements the
* {@link PublicCloneable} interface;</li>
* <li>the listeners registered with this dataset are not carried over to
* the cloned dataset.</li>
* </ul>
*
* @return An independent copy of the dataset.
*
* @throws CloneNotSupportedException if the dataset cannot be cloned for
* any reason.
*/
@Override
public Object clone() throws CloneNotSupportedException {
SlidingCategoryDataset clone = (SlidingCategoryDataset) super.clone();
if (this.underlying instanceof PublicCloneable) {
PublicCloneable pc = (PublicCloneable) this.underlying;
clone.underlying = (CategoryDataset) pc.clone();
}
return clone;
}
}