public class

SlidingGanttCategoryDataset

extends AbstractDataset
implements GanttCategoryDataset
java.lang.Object
   ↳ org.jfree.data.general.AbstractDataset
     ↳ org.jfree.data.gantt.SlidingGanttCategoryDataset

Class Overview

A GanttCategoryDataset 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
SlidingGanttCategoryDataset(GanttCategoryDataset 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.
Number getEndValue(Comparable rowKey, Comparable columnKey, int subinterval)
Returns the end value of a sub-interval for a given item.
Number getEndValue(int row, int column, int subinterval)
Returns the end value of a sub-interval for a given item.
Number getEndValue(int series, int category)
Returns the end value for the interval for a given series and category.
Number getEndValue(Comparable rowKey, Comparable columnKey)
Returns the end value for the interval for a given series and category.
int getFirstCategoryIndex()
Returns the index of the first visible category.
int getMaximumCategoryCount()
Returns the maximum category count.
Number getPercentComplete(Comparable rowKey, Comparable columnKey, int subinterval)
Returns the percentage complete value of a sub-interval for a given item.
Number getPercentComplete(int row, int column, int subinterval)
Returns the percentage complete value of a sub-interval for a given item.
Number getPercentComplete(int series, int category)
Returns the percent complete for a given item.
Number getPercentComplete(Comparable rowKey, Comparable columnKey)
Returns the percent complete for a given item.
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.
Number getStartValue(Comparable rowKey, Comparable columnKey, int subinterval)
Returns the start value of a sub-interval for a given item.
Number getStartValue(Comparable rowKey, Comparable columnKey)
Returns the start value for the interval for a given series and category.
Number getStartValue(int row, int column, int subinterval)
Returns the start value of a sub-interval for a given item.
Number getStartValue(int row, int column)
Returns the start value for the interval for a given series and category.
int getSubIntervalCount(int row, int column)
Returns the number of sub-intervals for a given item.
int getSubIntervalCount(Comparable rowKey, Comparable columnKey)
Returns the number of sub-intervals for a given item.
GanttCategoryDataset getUnderlyingDataset()
Returns the underlying dataset that was supplied to the constructor.
Number getValue(int row, int column)
Returns a value from the table.
Number getValue(Comparable rowKey, Comparable columnKey)
Returns the value for a pair of keys.
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.category.IntervalCategoryDataset
From interface org.jfree.data.gantt.GanttCategoryDataset
From interface org.jfree.data.general.Dataset

Public Constructors

public SlidingGanttCategoryDataset (GanttCategoryDataset 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 Number getEndValue (Comparable rowKey, Comparable columnKey, int subinterval)

Returns the end value of a sub-interval for a given item.

Parameters
rowKey the row key.
columnKey the column key.
subinterval the sub-interval.
Returns
  • The end value (possibly null).
See Also

public Number getEndValue (int row, int column, int subinterval)

Returns the end value of a sub-interval for a given item.

Parameters
row the row index (zero-based).
column the column index (zero-based).
subinterval the sub-interval.
Returns
  • The end value (possibly null).
See Also

public Number getEndValue (int series, int category)

Returns the end value for the interval for a given series and category.

Parameters
series the series (zero-based index).
category the category (zero-based index).
Returns
  • The end value (possibly null).

public Number getEndValue (Comparable rowKey, Comparable columnKey)

Returns the end value for the interval for a given series and category.

Parameters
rowKey the series key.
columnKey the category key.
Returns
  • The end value (possibly null).
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 Number getPercentComplete (Comparable rowKey, Comparable columnKey, int subinterval)

Returns the percentage complete value of a sub-interval for a given item.

Parameters
rowKey the row key.
columnKey the column key.
subinterval the sub-interval.
Returns
  • The percent complete value (possibly null).
See Also

public Number getPercentComplete (int row, int column, int subinterval)

Returns the percentage complete value of a sub-interval for a given item.

Parameters
row the row index (zero-based).
column the column index (zero-based).
subinterval the sub-interval.
Returns
  • The percent complete value (possibly null).
See Also

public Number getPercentComplete (int series, int category)

Returns the percent complete for a given item.

Parameters
series the row index (zero-based).
category the column index (zero-based).
Returns
  • The percent complete.

public Number getPercentComplete (Comparable rowKey, Comparable columnKey)

Returns the percent complete for a given item.

Parameters
rowKey the row key.
columnKey the column key.
Returns
  • The percent complete.

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 Number getStartValue (Comparable rowKey, Comparable columnKey, int subinterval)

Returns the start value of a sub-interval for a given item.

Parameters
rowKey the row key.
columnKey the column key.
subinterval the sub-interval.
Returns
  • The start value (possibly null).
See Also

public Number getStartValue (Comparable rowKey, Comparable columnKey)

Returns the start value for the interval for a given series and category.

Parameters
rowKey the series key.
columnKey the category key.
Returns
  • The start value (possibly null).
See Also

public Number getStartValue (int row, int column, int subinterval)

Returns the start value of a sub-interval for a given item.

Parameters
row the row index (zero-based).
column the column index (zero-based).
subinterval the sub-interval index (zero-based).
Returns
  • The start value (possibly null).
See Also

public Number getStartValue (int row, int column)

Returns the start value for the interval for a given series and category.

Parameters
row the series (zero-based index).
column the category (zero-based index).
Returns
  • The start value (possibly null).
See Also

public int getSubIntervalCount (int row, int column)

Returns the number of sub-intervals for a given item.

Parameters
row the row index (zero-based).
column the column index (zero-based).
Returns
  • The sub-interval count.
See Also

public int getSubIntervalCount (Comparable rowKey, Comparable columnKey)

Returns the number of sub-intervals for a given item.

Parameters
rowKey the row key.
columnKey the column key.
Returns
  • The sub-interval count.
See Also

public GanttCategoryDataset getUnderlyingDataset ()

Returns the underlying dataset that was supplied to the constructor.

Returns
  • The underlying dataset (never null).

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