Module org.jfree.chart

Package org.jfree.chart.entity

Class CategoryItemEntity<R extends Comparable<R>,C extends Comparable<C>>

java.lang.Object

org.jfree.chart.entity.ChartEntity

org.jfree.chart.entity.CategoryItemEntity<R,C>

All Implemented Interfaces:

Serializable, Cloneable, PublicCloneable

public class CategoryItemEntity<R extends Comparable<R>,C extends Comparable<C>>
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, String urlText, CategoryDataset dataset, R rowKey, C columnKey)	Creates a new entity instance for an item in the specified dataset.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Tests the entity for equality with an arbitrary object.
C	getColumnKey()	Returns the column key.
CategoryDataset<R,C>	getDataset()	Returns the dataset this entity refers to.
R	getRowKey()	Returns the row key.
void	setColumnKey(C columnKey)	Sets the column key.
void	setDataset(CategoryDataset<R,C> dataset)	Sets the dataset this entity refers to.
void	setRowKey(R rowKey)	Sets the row key.
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, hashCode, setArea, setToolTipText, setURLText

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CategoryItemEntity

public CategoryItemEntity(Shape area,
                          String toolTipText,
                          String urlText,
                          CategoryDataset dataset,
                          R rowKey,
                          C columnKey)

Creates a new entity instance for an item in the specified dataset.

Parameters:

area - the 'hotspot' area (null not permitted).

toolTipText - the tool tip text.

urlText - the URL text.

dataset - the dataset (null not permitted).

rowKey - the row key (null not permitted).

columnKey - the column key (null not permitted).

Method Detail

getDataset

public CategoryDataset<R,C> getDataset()

Returns the dataset this entity refers to. This can be used to differentiate between items in a chart that displays more than one dataset.

Returns:

The dataset (never null).

See Also:

setDataset(CategoryDataset)

setDataset

public void setDataset(CategoryDataset<R,C> dataset)

Sets the dataset this entity refers to.

Parameters:

dataset - the dataset (null not permitted).

See Also:

getDataset()

getRowKey

public R getRowKey()

Returns the row key.

Returns:

The row key (never null).

See Also:

setRowKey(Comparable)

setRowKey

public void setRowKey(R rowKey)

Sets the row key.

Parameters:

rowKey - the row key (null not permitted).

See Also:

getRowKey()

getColumnKey

public C getColumnKey()

Returns the column key.

Returns:

The column key (never null).

See Also:

setColumnKey(Comparable)

setColumnKey

public void setColumnKey(C columnKey)

Sets the column key.

Parameters:

columnKey - the column key (null not permitted).

See Also:

getColumnKey()

toString

public String toString()

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

Overrides:

toString in class ChartEntity

Returns:

A string (never null).

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.