public class

SlidingCategoryDataset

extends AbstractDataset
implements CategoryDataset
java.lang.Object
   ↳ org.jfree.data.general.AbstractDataset
     ↳ org.jfree.data.category.SlidingCategoryDataset

Class Overview

A 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.

Summary

Public Constructors
SlidingCategoryDataset(CategoryDataset underlying, int firstColumn, int maxColumns)
Creates a new instance.
Public Methods
Object clone()
Returns an independent copy of the dataset.
boolean equals(Object obj)
Tests this SlidingCategoryDataset for equality with an arbitrary object.
int getColumnCount()
Returns the number of columns in the table.
int getColumnIndex(Comparable key)
Returns the index for the specified column key.
Comparable getColumnKey(int column)
Returns the column key for a given index.
List getColumnKeys()
Returns the column keys.
int getFirstCategoryIndex()
Returns the index of the first visible category.
int getMaximumCategoryCount()
Returns the maximum category count.
int getRowCount()
Returns the number of rows in the table.
int getRowIndex(Comparable key)
Returns the row index for a given key.
Comparable getRowKey(int row)
Returns the row key for a given index.
List getRowKeys()
Returns the row keys.
CategoryDataset getUnderlyingDataset()
Returns the underlying dataset that was supplied to the constructor.
Number getValue(Comparable rowKey, Comparable columnKey)
Returns the value for a pair of keys.
Number getValue(int row, int column)
Returns a value from the table.
void setFirstCategoryIndex(int first)
Sets the index of the first category that should be used from the underlying dataset, and sends a DatasetChangeEvent to all registered listeners.
void setMaximumCategoryCount(int max)
Sets the maximum category count and sends a DatasetChangeEvent to all registered listeners.
[Expand]
Inherited Methods
From class org.jfree.data.general.AbstractDataset
From class java.lang.Object
From interface java.io.ObjectInputValidation
From interface org.jfree.data.KeyedValues2D
From interface org.jfree.data.Values2D
From interface org.jfree.data.general.Dataset

Public Constructors

public SlidingCategoryDataset (CategoryDataset underlying, int firstColumn, int maxColumns)

Creates a new instance.

Parameters
underlying the underlying dataset (null not permitted).
firstColumn the index of the first visible column from the underlying dataset.
maxColumns the maximumColumnCount.

Public Methods

public Object clone ()

Returns an independent copy of the dataset. Note that:

  • the underlying dataset is only cloned if it implements the PublicCloneable interface;
  • the listeners registered with this dataset are not carried over to the cloned dataset.

Returns
  • An independent copy of the dataset.
Throws
CloneNotSupportedException if the dataset cannot be cloned for any reason.

public boolean equals (Object obj)

Tests this SlidingCategoryDataset for equality with an arbitrary object.

Parameters
obj the object (null permitted).
Returns
  • A boolean.

public int getColumnCount ()

Returns the number of columns in the table.

Returns
  • The column count.

public int getColumnIndex (Comparable key)

Returns the index for the specified column key.

Parameters
key the key.
Returns
  • The column index, or -1 if the key is not recognised.

public Comparable getColumnKey (int column)

Returns the column key for a given index.

Parameters
column the column index (zero-based).
Returns
  • The column key.
Throws
IndexOutOfBoundsException if row is out of bounds.

public List getColumnKeys ()

Returns the column keys.

Returns
  • The keys.
See Also

public int getFirstCategoryIndex ()

Returns the index of the first visible category.

Returns
  • The index.
See Also

public int getMaximumCategoryCount ()

Returns the maximum category count.

Returns
  • The maximum category count.
See Also

public int getRowCount ()

Returns the number of rows in the table.

Returns
  • The row count.

public int getRowIndex (Comparable key)

Returns the row index for a given key.

Parameters
key the row key.
Returns
  • The row index, or -1 if the key is unrecognised.

public Comparable getRowKey (int row)

Returns the row key for a given index.

Parameters
row the row index (zero-based).
Returns
  • The row key.
Throws
IndexOutOfBoundsException if row is out of bounds.

public List getRowKeys ()

Returns the row keys.

Returns
  • The keys.

public CategoryDataset getUnderlyingDataset ()

Returns the underlying dataset that was supplied to the constructor.

Returns
  • The underlying dataset (never null).

public Number getValue (Comparable rowKey, Comparable columnKey)

Returns the value for a pair of keys.

Parameters
rowKey the row key (null not permitted).
columnKey the column key (null not permitted).
Returns
  • The value (possibly null).
Throws
UnknownKeyException if either key is not defined in the dataset.

public Number getValue (int row, int column)

Returns a value from the table.

Parameters
row the row index (zero-based).
column the column index (zero-based).
Returns
  • The value (possibly null).

public void setFirstCategoryIndex (int first)

Sets the index of the first category that should be used from the underlying dataset, and sends a DatasetChangeEvent to all registered listeners.

Parameters
first the index.
See Also

public void setMaximumCategoryCount (int max)

Sets the maximum category count and sends a DatasetChangeEvent to all registered listeners.

Parameters
max the maximum.
See Also