SlidingGanttCategoryDataset (JFreeChart Class Library (version 1.0.13))

java.lang.Object
- org.jfree.data.general.AbstractDataset
- - org.jfree.data.gantt.SlidingGanttCategoryDataset

All Implemented Interfaces:

ObjectInputValidation, Serializable, Cloneable, CategoryDataset, IntervalCategoryDataset, GanttCategoryDataset, Dataset, KeyedValues2D, Values2D
```
public class SlidingGanttCategoryDataset
extends AbstractDataset
implements GanttCategoryDataset
```
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.

Since:

1.0.10

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`SlidingGanttCategoryDataset(GanttCategoryDataset underlying, int firstColumn, int maxColumns)` Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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)` Returns the end value for the interval for a given series and category.
`Number`	`getEndValue(Comparable rowKey, Comparable columnKey, 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(int row, int column, int subinterval)` Returns the end value of a sub-interval for a given item.
`int`	`getFirstCategoryIndex()` Returns the index of the first visible category.
`int`	`getMaximumCategoryCount()` Returns the maximum category count.
`Number`	`getPercentComplete(Comparable rowKey, Comparable columnKey)` Returns the percent complete for a given item.
`Number`	`getPercentComplete(Comparable rowKey, Comparable columnKey, 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(int row, int column, int subinterval)` Returns the percentage complete value of a sub-interval 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)` Returns the start value for the interval for a given series and category.
`Number`	`getStartValue(Comparable rowKey, Comparable columnKey, 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.
`Number`	`getStartValue(int row, int column, int subinterval)` Returns the start value of a sub-interval for a given item.
`int`	`getSubIntervalCount(Comparable rowKey, Comparable columnKey)` Returns the number of sub-intervals for a given item.
`int`	`getSubIntervalCount(int row, int column)` Returns the number of sub-intervals for a given item.
`GanttCategoryDataset`	`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.

Methods inherited from class org.jfree.data.general.AbstractDataset
addChangeListener, fireDatasetChanged, getGroup, hasListener, notifyListeners, removeChangeListener, setGroup, validateObject

Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jfree.data.general.Dataset
addChangeListener, getGroup, removeChangeListener, setGroup

- Constructor Detail
  - SlidingGanttCategoryDataset
```
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.
- Method Detail
  - getUnderlyingDataset
```
public GanttCategoryDataset getUnderlyingDataset()
```
    Returns the underlying dataset that was supplied to the constructor.
    
    Returns:
    
    The underlying dataset (never null).
  - getFirstCategoryIndex
```
public int getFirstCategoryIndex()
```
    Returns the index of the first visible category.
    
    Returns:
    
    The index.
    
    See Also:
    
    setFirstCategoryIndex(int)
  - setFirstCategoryIndex
```
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:
    
    getFirstCategoryIndex()
  - getMaximumCategoryCount
```
public int getMaximumCategoryCount()
```
    Returns the maximum category count.
    
    Returns:
    
    The maximum category count.
    
    See Also:
    
    setMaximumCategoryCount(int)
  - setMaximumCategoryCount
```
public void setMaximumCategoryCount(int max)
```
    Sets the maximum category count and sends a DatasetChangeEvent to all registered listeners.
    
    Parameters:
    
    max - the maximum.
    
    See Also:
    
    getMaximumCategoryCount()
  - getColumnIndex
```
public int getColumnIndex(Comparable key)
```
    Returns the index for the specified column key.
    
    Specified by:
    
    getColumnIndex in interface KeyedValues2D
    
    Parameters:
    
    key - the key.
    
    Returns:
    
    The column index, or -1 if the key is not recognised.
  - getColumnKey
```
public Comparable getColumnKey(int column)
```
    Returns the column key for a given index.
    
    Specified by:
    
    getColumnKey in interface KeyedValues2D
    
    Parameters:
    
    column - the column index (zero-based).
    
    Returns:
    
    The column key.
    
    Throws:
    
    IndexOutOfBoundsException - if row is out of bounds.
  - getColumnKeys
```
public List getColumnKeys()
```
    Returns the column keys.
    
    Specified by:
    
    getColumnKeys in interface KeyedValues2D
    
    Returns:
    
    The keys.
    
    See Also:
    
    getColumnKey(int)
  - getRowIndex
```
public int getRowIndex(Comparable key)
```
    Returns the row index for a given key.
    
    Specified by:
    
    getRowIndex in interface KeyedValues2D
    
    Parameters:
    
    key - the row key.
    
    Returns:
    
    The row index, or -1 if the key is unrecognised.
  - getRowKey
```
public Comparable getRowKey(int row)
```
    Returns the row key for a given index.
    
    Specified by:
    
    getRowKey in interface KeyedValues2D
    
    Parameters:
    
    row - the row index (zero-based).
    
    Returns:
    
    The row key.
    
    Throws:
    
    IndexOutOfBoundsException - if row is out of bounds.
  - getRowKeys
```
public List getRowKeys()
```
    Returns the row keys.
    
    Specified by:
    
    getRowKeys in interface KeyedValues2D
    
    Returns:
    
    The keys.
  - getValue
```
public Number getValue(Comparable rowKey,
                       Comparable columnKey)
```
    Returns the value for a pair of keys.
    
    Specified by:
    
    getValue in interface KeyedValues2D
    
    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.
  - getColumnCount
```
public int getColumnCount()
```
    Returns the number of columns in the table.
    
    Specified by:
    
    getColumnCount in interface Values2D
    
    Returns:
    
    The column count.
  - getRowCount
```
public int getRowCount()
```
    Returns the number of rows in the table.
    
    Specified by:
    
    getRowCount in interface Values2D
    
    Returns:
    
    The row count.
  - getValue
```
public Number getValue(int row,
                       int column)
```
    Returns a value from the table.
    
    Specified by:
    
    getValue in interface Values2D
    
    Parameters:
    
    row - the row index (zero-based).
    
    column - the column index (zero-based).
    
    Returns:
    
    The value (possibly null).
  - getPercentComplete
```
public Number getPercentComplete(Comparable rowKey,
                                 Comparable columnKey)
```
    Returns the percent complete for a given item.
    
    Specified by:
    
    getPercentComplete in interface GanttCategoryDataset
    
    Parameters:
    
    rowKey - the row key.
    
    columnKey - the column key.
    
    Returns:
    
    The percent complete.
    
    See Also:
    
    GanttCategoryDataset.getPercentComplete(int, int)
  - getPercentComplete
```
public Number getPercentComplete(Comparable rowKey,
                                 Comparable columnKey,
                                 int subinterval)
```
    Returns the percentage complete value of a sub-interval for a given item.
    
    Specified by:
    
    getPercentComplete in interface GanttCategoryDataset
    
    Parameters:
    
    rowKey - the row key.
    
    columnKey - the column key.
    
    subinterval - the sub-interval.
    
    Returns:
    
    The percent complete value (possibly null).
    
    See Also:
    
    getPercentComplete(int, int, int)
  - getEndValue
```
public Number getEndValue(Comparable rowKey,
                          Comparable columnKey,
                          int subinterval)
```
    Returns the end value of a sub-interval for a given item.
    
    Specified by:
    
    getEndValue in interface GanttCategoryDataset
    
    Parameters:
    
    rowKey - the row key.
    
    columnKey - the column key.
    
    subinterval - the sub-interval.
    
    Returns:
    
    The end value (possibly null).
    
    See Also:
    
    getStartValue(Comparable, Comparable, int)
  - getEndValue
```
public Number getEndValue(int row,
                          int column,
                          int subinterval)
```
    Returns the end value of a sub-interval for a given item.
    
    Specified by:
    
    getEndValue in interface GanttCategoryDataset
    
    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:
    
    getStartValue(int, int, int)
  - getPercentComplete
```
public Number getPercentComplete(int series,
                                 int category)
```
    Returns the percent complete for a given item.
    
    Specified by:
    
    getPercentComplete in interface GanttCategoryDataset
    
    Parameters:
    
    series - the row index (zero-based).
    
    category - the column index (zero-based).
    
    Returns:
    
    The percent complete.
    
    See Also:
    
    GanttCategoryDataset.getPercentComplete(Comparable, Comparable)
  - getPercentComplete
```
public Number getPercentComplete(int row,
                                 int column,
                                 int subinterval)
```
    Returns the percentage complete value of a sub-interval for a given item.
    
    Specified by:
    
    getPercentComplete in interface GanttCategoryDataset
    
    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:
    
    getPercentComplete(Comparable, Comparable, int)
  - getStartValue
```
public Number getStartValue(Comparable rowKey,
                            Comparable columnKey,
                            int subinterval)
```
    Returns the start value of a sub-interval for a given item.
    
    Specified by:
    
    getStartValue in interface GanttCategoryDataset
    
    Parameters:
    
    rowKey - the row key.
    
    columnKey - the column key.
    
    subinterval - the sub-interval.
    
    Returns:
    
    The start value (possibly null).
    
    See Also:
    
    getEndValue(Comparable, Comparable, int)
  - getStartValue
```
public Number getStartValue(int row,
                            int column,
                            int subinterval)
```
    Returns the start value of a sub-interval for a given item.
    
    Specified by:
    
    getStartValue in interface GanttCategoryDataset
    
    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:
    
    getEndValue(int, int, int)
  - getSubIntervalCount
```
public int getSubIntervalCount(Comparable rowKey,
                               Comparable columnKey)
```
    Returns the number of sub-intervals for a given item.
    
    Specified by:
    
    getSubIntervalCount in interface GanttCategoryDataset
    
    Parameters:
    
    rowKey - the row key.
    
    columnKey - the column key.
    
    Returns:
    
    The sub-interval count.
    
    See Also:
    
    getSubIntervalCount(int, int)
  - getSubIntervalCount
```
public int getSubIntervalCount(int row,
                               int column)
```
    Returns the number of sub-intervals for a given item.
    
    Specified by:
    
    getSubIntervalCount in interface GanttCategoryDataset
    
    Parameters:
    
    row - the row index (zero-based).
    
    column - the column index (zero-based).
    
    Returns:
    
    The sub-interval count.
    
    See Also:
    
    getSubIntervalCount(Comparable, Comparable)
  - getStartValue
```
public Number getStartValue(Comparable rowKey,
                            Comparable columnKey)
```
    Returns the start value for the interval for a given series and category.
    
    Specified by:
    
    getStartValue in interface IntervalCategoryDataset
    
    Parameters:
    
    rowKey - the series key.
    
    columnKey - the category key.
    
    Returns:
    
    The start value (possibly null).
    
    See Also:
    
    getEndValue(Comparable, Comparable)
  - getStartValue
```
public Number getStartValue(int row,
                            int column)
```
    Returns the start value for the interval for a given series and category.
    
    Specified by:
    
    getStartValue in interface IntervalCategoryDataset
    
    Parameters:
    
    row - the series (zero-based index).
    
    column - the category (zero-based index).
    
    Returns:
    
    The start value (possibly null).
    
    See Also:
    
    getEndValue(int, int)
  - getEndValue
```
public Number getEndValue(Comparable rowKey,
                          Comparable columnKey)
```
    Returns the end value for the interval for a given series and category.
    
    Specified by:
    
    getEndValue in interface IntervalCategoryDataset
    
    Parameters:
    
    rowKey - the series key.
    
    columnKey - the category key.
    
    Returns:
    
    The end value (possibly null).
    
    See Also:
    
    getStartValue(Comparable, Comparable)
  - getEndValue
```
public Number getEndValue(int series,
                          int category)
```
    Returns the end value for the interval for a given series and category.
    
    Specified by:
    
    getEndValue in interface IntervalCategoryDataset
    
    Parameters:
    
    series - the series (zero-based index).
    
    category - the category (zero-based index).
    
    Returns:
    
    The end value (possibly null).
    
    See Also:
    
    IntervalCategoryDataset.getStartValue(int, int)
  - equals
```
public boolean equals(Object obj)
```
    Tests this SlidingCategoryDataset for equality with an arbitrary object.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - the object (null permitted).
    
    Returns:
    
    A boolean.
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    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.
    Overrides:
    
    clone in class AbstractDataset
    
    Returns:
    
    An independent copy of the dataset.
    
    Throws:
    
    CloneNotSupportedException - if the dataset cannot be cloned for any reason.

HeaderAnd More

Class SlidingGanttCategoryDataset

Constructor Summary

Method Summary

Methods inherited from class org.jfree.data.general.AbstractDataset

Methods inherited from class java.lang.Object

Methods inherited from interface org.jfree.data.general.Dataset

Constructor Detail

SlidingGanttCategoryDataset

Method Detail

getUnderlyingDataset

getFirstCategoryIndex

setFirstCategoryIndex

getMaximumCategoryCount

setMaximumCategoryCount

getColumnIndex

getColumnKey

getColumnKeys

getRowIndex

getRowKey

getRowKeys

getValue

getColumnCount

getRowCount

getValue

getPercentComplete

getPercentComplete

getEndValue

getEndValue

getPercentComplete

getPercentComplete

getStartValue

getStartValue

getSubIntervalCount

getSubIntervalCount

getStartValue

getStartValue

getEndValue

getEndValue

equals

clone

FooterAnd More

Header
And More

Footer
And More