org.jfree.chart.entity

Class CategoryItemEntity

public class CategoryItemEntity extends ChartEntity implements Cloneable, Serializable

A chart entity that represents one item within a category plot.
Constructor Summary
CategoryItemEntity(Shape area, String toolTipText, String urlText, CategoryDataset dataset, int series, Object category, int categoryIndex)
Creates a new category item entity.
Method Summary
booleanequals(Object obj)
Tests the entity for equality with an arbitrary object.
ObjectgetCategory()
Returns the category.
intgetCategoryIndex()
Returns the category index.
CategoryDatasetgetDataset()
Returns the datset this entity refers to.
intgetSeries()
Returns the series index.
voidsetCategory(Object category)
Sets the category.
voidsetCategoryIndex(int index)
Sets the category index.
voidsetDataset(CategoryDataset dataset)
Sets the datset this entity refers to.
voidsetSeries(int series)
Sets the series index.
StringtoString()
Returns a string representing this object (useful for debugging purposes).

Constructor Detail

CategoryItemEntity

public CategoryItemEntity(Shape area, String toolTipText, String urlText, CategoryDataset dataset, int series, Object category, int categoryIndex)
Creates a new category item entity.

Parameters: area the area. toolTipText the tool tip text. urlText the URL text for HTML image maps. dataset the dataset. series the series (zero-based index). category the category. categoryIndex the category index.

Method Detail

equals

public boolean equals(Object obj)
Tests the entity for equality with an arbitrary object.

Parameters: obj the object (null permitted).

Returns: A boolean.

getCategory

public Object getCategory()
Returns the category.

Returns: The category (possibly null).

getCategoryIndex

public int getCategoryIndex()
Returns the category index.

Returns: The index.

getDataset

public CategoryDataset getDataset()
Returns the datset this entity refers to.

Returns: The dataset (possibly null).

getSeries

public int getSeries()
Returns the series index.

Returns: The series index.

setCategory

public void setCategory(Object category)
Sets the category.

Parameters: category the category (null permitted).

setCategoryIndex

public void setCategoryIndex(int index)
Sets the category index.

Parameters: index the category index.

setDataset

public void setDataset(CategoryDataset dataset)
Sets the datset this entity refers to.

Parameters: dataset the dataset (null permited).

setSeries

public void setSeries(int series)
Sets the series index.

Parameters: series the series index (zero-based).

toString

public String toString()
Returns a string representing this object (useful for debugging purposes).

Returns: A string.