org.jfree.chart.entity

Class XYItemEntity

public class XYItemEntity extends ChartEntity

A chart entity that represents one item within an XYPlot.
Constructor Summary
XYItemEntity(Shape area, XYDataset dataset, int series, int item, String toolTipText, String urlText)
Creates a new entity.
Method Summary
booleanequals(Object obj)
Tests the entity for equality with an arbitrary object.
XYDatasetgetDataset()
Returns the dataset this entity refers to.
intgetItem()
Returns the item index.
intgetSeriesIndex()
Returns the series index.
voidsetDataset(XYDataset dataset)
Sets the dataset this entity refers to.
voidsetItem(int item)
Sets the item index.
voidsetSeriesIndex(int series)
Sets the series index.
StringtoString()
Returns a string representation of this instance, useful for debugging purposes.

Constructor Detail

XYItemEntity

public XYItemEntity(Shape area, XYDataset dataset, int series, int item, String toolTipText, String urlText)
Creates a new entity.

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

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.

getDataset

public XYDataset getDataset()
Returns the dataset this entity refers to.

Returns: The dataset.

getItem

public int getItem()
Returns the item index.

Returns: The item index.

getSeriesIndex

public int getSeriesIndex()
Returns the series index.

Returns: The series index.

setDataset

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

Parameters: dataset the dataset.

setItem

public void setItem(int item)
Sets the item index.

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

setSeriesIndex

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

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

toString

public String toString()
Returns a string representation of this instance, useful for debugging purposes.

Returns: A string.