Package org.jfree.data.category
Class CategoryToPieDataset
- java.lang.Object
-
- org.jfree.data.general.AbstractDataset
-
- org.jfree.data.category.CategoryToPieDataset
-
- All Implemented Interfaces:
java.io.ObjectInputValidation
,java.io.Serializable
,java.lang.Cloneable
,java.util.EventListener
,Dataset
,DatasetChangeListener
,PieDataset
,KeyedValues
,Values
public class CategoryToPieDataset extends AbstractDataset implements PieDataset, DatasetChangeListener
APieDataset
implementation that obtains its data from one row or column of aCategoryDataset
.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private TableOrder
extract
The extract type.private int
index
The row or column index.(package private) static long
serialVersionUID
For serialization.private CategoryDataset
source
The source.
-
Constructor Summary
Constructors Constructor Description CategoryToPieDataset(CategoryDataset source, TableOrder extract, int index)
An adaptor class that converts anyCategoryDataset
into aPieDataset
, by taking the values from a single row or column.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
datasetChanged(DatasetChangeEvent event)
Sends aDatasetChangeEvent
to all registered listeners, with this (not the underlying) dataset as the source.boolean
equals(java.lang.Object obj)
Tests this dataset for equality with an arbitrary object, returningtrue
ifobj
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(java.lang.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.java.lang.Comparable
getKey(int index)
Returns the key at the specified index.java.util.List
getKeys()
Returns the keys for the dataset.CategoryDataset
getUnderlyingDataset()
Returns the underlying dataset.java.lang.Number
getValue(int item)
Returns a value from the dataset.java.lang.Number
getValue(java.lang.Comparable key)
Returns the value for a given key.-
Methods inherited from class org.jfree.data.general.AbstractDataset
addChangeListener, canEqual, clone, fireDatasetChanged, getGroup, getNotify, hashCode, hasListener, notifyListeners, removeChangeListener, setGroup, setNotify, validateObject
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.jfree.data.general.Dataset
addChangeListener, getGroup, removeChangeListener, setGroup
-
-
-
-
Field Detail
-
serialVersionUID
static final long serialVersionUID
For serialization.- See Also:
- Constant Field Values
-
source
private final CategoryDataset source
The source.
-
extract
private final TableOrder extract
The extract type.
-
index
private final int index
The row or column index.
-
-
Constructor Detail
-
CategoryToPieDataset
public CategoryToPieDataset(CategoryDataset source, TableOrder extract, int index)
An adaptor class that converts anyCategoryDataset
into aPieDataset
, by taking the values from a single row or column.If
source
isnull
, 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.
-
-
Method Detail
-
getUnderlyingDataset
public CategoryDataset getUnderlyingDataset()
Returns the underlying dataset.- Returns:
- The underlying dataset (possibly
null
).
-
getExtractType
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.
-
getExtractIndex
public int getExtractIndex()
Returns the index of the row or column from which to extract the data.- Returns:
- The extract index.
-
getItemCount
public int getItemCount()
Returns the number of items (values) in the collection. If the underlying dataset isnull
, this method returns zero.- Specified by:
getItemCount
in interfaceValues
- Returns:
- The item count.
-
getValue
public java.lang.Number getValue(int item)
Returns a value from the dataset.
-
getKey
public java.lang.Comparable getKey(int index)
Returns the key at the specified index.- Specified by:
getKey
in interfaceKeyedValues
- Parameters:
index
- the item index (in the range0
togetItemCount() -1
).- Returns:
- The key.
- Throws:
java.lang.IndexOutOfBoundsException
- ifindex
is not in the specified range.
-
getIndex
public int getIndex(java.lang.Comparable key)
Returns the index for a given key, or-1
if there is no such key.- Specified by:
getIndex
in interfaceKeyedValues
- Parameters:
key
- the key.- Returns:
- The index for the key, or
-1
.
-
getKeys
public java.util.List getKeys()
Returns the keys for the dataset.If the underlying dataset is
null
, this method returns an empty list.- Specified by:
getKeys
in interfaceKeyedValues
- Returns:
- The keys.
-
getValue
public java.lang.Number getValue(java.lang.Comparable key)
Returns the value for a given key. If the key is not recognised, the method should returnnull
(but note thatnull
can be associated with a valid key also).- Specified by:
getValue
in interfaceKeyedValues
- Parameters:
key
- the key.- Returns:
- The value (possibly
null
).
-
datasetChanged
public void datasetChanged(DatasetChangeEvent event)
Sends aDatasetChangeEvent
to all registered listeners, with this (not the underlying) dataset as the source.- Specified by:
datasetChanged
in interfaceDatasetChangeListener
- Parameters:
event
- the event (ignored, a new event with this dataset as the source is sent to the listeners).
-
equals
public boolean equals(java.lang.Object obj)
Tests this dataset for equality with an arbitrary object, returningtrue
ifobj
is a dataset containing the same keys and values in the same order as this dataset.- Overrides:
equals
in classAbstractDataset
- Parameters:
obj
- the object to test (null
permitted).- Returns:
- A boolean.
-
-