public class

CategoryToPieDataset

extends AbstractDataset
implements DatasetChangeListener PieDataset
java.lang.Object
   ↳ org.jfree.data.general.AbstractDataset
     ↳ org.jfree.data.category.CategoryToPieDataset

Class Overview

A PieDataset implementation that obtains its data from one row or column of a CategoryDataset.

Summary

Public Constructors
CategoryToPieDataset(CategoryDataset source, TableOrder extract, int index)
An adaptor class that converts any CategoryDataset into a PieDataset, by taking the values from a single row or column.
Public Methods
void datasetChanged(DatasetChangeEvent event)
Sends a DatasetChangeEvent to all registered listeners, with this (not the underlying) dataset as the source.
boolean equals(Object obj)
Tests this dataset for equality with an arbitrary object, returning true if obj is a dataset containing the same keys and values in the same order as this dataset.
int getExtractIndex()
Returns the index of the row or column from which to extract the data.
TableOrder getExtractType()
Returns the extract type, which determines whether data is read from one row or one column of the underlying dataset.
int getIndex(Comparable key)
Returns the index for a given key, or -1 if there is no such key.
int getItemCount()
Returns the number of items (values) in the collection.
Comparable getKey(int index)
Returns the key at the specified index.
List getKeys()
Returns the keys for the dataset.
CategoryDataset getUnderlyingDataset()
Returns the underlying dataset.
Number getValue(Comparable key)
Returns the value for a given key.
Number getValue(int item)
Returns a value from the dataset.
[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.KeyedValues
From interface org.jfree.data.Values
From interface org.jfree.data.general.Dataset
From interface org.jfree.data.general.DatasetChangeListener

Public Constructors

public CategoryToPieDataset (CategoryDataset source, TableOrder extract, int index)

An adaptor class that converts any CategoryDataset into a PieDataset, by taking the values from a single row or column.

If source is null, the created dataset will be empty.

Parameters
source the source dataset (null permitted).
extract extract data from rows or columns? (null not permitted).
index the row or column index.

Public Methods

public void datasetChanged (DatasetChangeEvent event)

Sends a DatasetChangeEvent to all registered listeners, with this (not the underlying) dataset as the source.

Parameters
event the event (ignored, a new event with this dataset as the source is sent to the listeners).

public boolean equals (Object obj)

Tests this dataset for equality with an arbitrary object, returning true if obj is a dataset containing the same keys and values in the same order as this dataset.

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

public int getExtractIndex ()

Returns the index of the row or column from which to extract the data.

Returns
  • The extract index.

public TableOrder getExtractType ()

Returns the extract type, which determines whether data is read from one row or one column of the underlying dataset.

Returns
  • The extract type.

public int getIndex (Comparable key)

Returns the index for a given key, or -1 if there is no such key.

Parameters
key the key.
Returns
  • The index for the key, or -1.

public int getItemCount ()

Returns the number of items (values) in the collection. If the underlying dataset is null, this method returns zero.

Returns
  • The item count.

public Comparable getKey (int index)

Returns the key at the specified index.

Parameters
index the item index (in the range 0 to getItemCount() - 1).
Returns
  • The key.
Throws
IndexOutOfBoundsException if index is not in the specified range.

public List getKeys ()

Returns the keys for the dataset.

If the underlying dataset is null, this method returns an empty list.

Returns
  • The keys.

public CategoryDataset getUnderlyingDataset ()

Returns the underlying dataset.

Returns
  • The underlying dataset (possibly null).

public Number getValue (Comparable key)

Returns the value for a given key. If the key is not recognised, the method should return null (but note that null can be associated with a valid key also).

Parameters
key the key.
Returns
  • The value (possibly null).

public Number getValue (int item)

Returns a value from the dataset.

Parameters
item the item index (zero-based).
Returns
  • The value (possibly null).
Throws
IndexOutOfBoundsException if item is not in the range 0 to getItemCount() - 1.