Package org.jfree.chart.entity

Class CategoryItemEntity

java.lang.Object

org.jfree.chart.entity.ChartEntity

org.jfree.chart.entity.CategoryItemEntity

All Implemented Interfaces:

Serializable, Cloneable

public class CategoryItemEntity
extends ChartEntity
implements Cloneable, Serializable

A chart entity that represents one item within a category plot.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
CategoryItemEntity(Shape area, String toolTipText, int series, Object category, int categoryIndex)	Deprecated. Use alternative constructor.
CategoryItemEntity(Shape area, String toolTipText, String urlText, int series, Object category, int categoryIndex)	Deprecated. Use alternative constructor.
CategoryItemEntity(Shape area, String toolTipText, String urlText, CategoryDataset dataset, int series, Object category, int categoryIndex)	Creates a new category item entity.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Tests the entity for equality with an arbitrary object.
Object	getCategory()	Returns the category.
int	getCategoryIndex()	Returns the category index.
CategoryDataset	getDataset()	Returns the datset this entity refers to.
int	getSeries()	Returns the series index.
void	setCategory(Object category)	Sets the category.
void	setCategoryIndex(int index)	Sets the category index.
void	setDataset(CategoryDataset dataset)	Sets the datset this entity refers to.
void	setSeries(int series)	Sets the series index.
String	toString()	Returns a string representing this object (useful for debugging purposes).

Methods inherited from class org.jfree.chart.entity.ChartEntity

clone, getArea, getImageMapAreaTag, getShapeCoords, getShapeType, getToolTipText, getURLText, setArea, setToolTipText, setURLText

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

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.

CategoryItemEntity

public CategoryItemEntity(Shape area,
String toolTipText,
int series,
Object category,
int categoryIndex)

Deprecated.

Use alternative constructor.

Creates a new category item entity.

Parameters:

area - the area.

toolTipText - the tool tip text.

series - the series (zero-based index).

category - the category.

categoryIndex - the index of the category.

CategoryItemEntity

public CategoryItemEntity(Shape area,
String toolTipText,
String urlText,
int series,
Object category,
int categoryIndex)

Deprecated.

Use alternative constructor.

Creates a new category item entity.

Parameters:

area - the area.

toolTipText - the tool tip text.

urlText - the URL text for HTML image maps.

series - the series (zero-based index).

category - the category.

categoryIndex - the category index.

Method Details

getDataset

public CategoryDataset getDataset()

Returns the datset this entity refers to.

Returns:

The dataset (possibly null).

setDataset

public void setDataset(CategoryDataset dataset)

Sets the datset this entity refers to.

Parameters:

dataset - the dataset (null permited).

getSeries

public int getSeries()

Returns the series index.

Returns:

The series index.

setSeries

public void setSeries(int series)

Sets the series index.

Parameters:

series - the series index (zero-based).

getCategory

public Object getCategory()

Returns the category.

Returns:

The category (possibly null).

setCategory

public void setCategory(Object category)

Sets the category.

Parameters:

category - the category (null permitted).

getCategoryIndex

public int getCategoryIndex()

Returns the category index.

Returns:

The index.

setCategoryIndex

public void setCategoryIndex(int index)

Sets the category index.

Parameters:

index - the category index.

toString

public String toString()

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

Overrides:

toString in class Object

Returns:

A string.

equals

public boolean equals(Object obj)

Tests the entity for equality with an arbitrary object.

Overrides:

equals in class ChartEntity

Parameters:

obj - the object (null permitted).

Returns:

A boolean.