org.jfree.chart.entity

Class PieSectionEntity

java.lang.Object

org.jfree.chart.entity.ChartEntity

org.jfree.chart.entity.PieSectionEntity

All Implemented Interfaces:

Serializable, Cloneable, org.jfree.util.PublicCloneable

public class PieSectionEntity
extends ChartEntity
implements Serializable

A chart entity that represents one section within a pie plot.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PieSectionEntity(Shape area, PieDataset dataset, int pieIndex, int sectionIndex, Comparable sectionKey, String toolTipText, String urlText) Creates a new pie section entity.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Tests this entity for equality with an arbitrary object.
PieDataset	getDataset() Returns the dataset this entity refers to.
int	getPieIndex() Returns the pie index.
int	getSectionIndex() Returns the section index.
Comparable	getSectionKey() Returns the section key.
int	hashCode() Returns a hash code for this instance.
void	setDataset(PieDataset dataset) Sets the dataset this entity refers to.
void	setPieIndex(int index) Sets the pie index.
void	setSectionIndex(int index) Sets the section index.
void	setSectionKey(Comparable key) Sets the section key.
String	toString() Returns a string representing the entity.

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, notify, notifyAll, wait, wait, wait

Constructor Detail

PieSectionEntity

public PieSectionEntity(Shape area,
                        PieDataset dataset,
                        int pieIndex,
                        int sectionIndex,
                        Comparable sectionKey,
                        String toolTipText,
                        String urlText)

Creates a new pie section entity.

Parameters:

area - the area.

dataset - the pie dataset.

pieIndex - the pie index (zero-based).

sectionIndex - the section index (zero-based).

sectionKey - the section key.

toolTipText - the tool tip text.

urlText - the URL text for HTML image maps.

Method Detail

getDataset

public PieDataset getDataset()

Returns the dataset this entity refers to.

Returns:

The dataset.

See Also:

setDataset(PieDataset)

setDataset

public void setDataset(PieDataset dataset)

Sets the dataset this entity refers to.

Parameters:

dataset - the dataset.

See Also:

getDataset()

getPieIndex

public int getPieIndex()

Returns the pie index. For a regular pie chart, the section index is 0. For a pie chart containing multiple pie plots, the pie index is the row or column index from which the pie data is extracted.

Returns:

The pie index.

See Also:

setPieIndex(int)

setPieIndex

public void setPieIndex(int index)

Sets the pie index.

Parameters:

index - the new index value.

See Also:

getPieIndex()

getSectionIndex

public int getSectionIndex()

Returns the section index.

Returns:

The section index.

See Also:

setSectionIndex(int)

setSectionIndex

public void setSectionIndex(int index)

Sets the section index.

Parameters:

index - the section index.

See Also:

getSectionIndex()

getSectionKey

public Comparable getSectionKey()

Returns the section key.

Returns:

The section key.

See Also:

setSectionKey(Comparable)

setSectionKey

public void setSectionKey(Comparable key)

Sets the section key.

Parameters:

key - the section key.

See Also:

getSectionKey()

equals

public boolean equals(Object obj)

Tests this entity for equality with an arbitrary object.

Overrides:

equals in class ChartEntity

Parameters:

obj - the object (null permitted).

Returns:

A boolean.

hashCode

public int hashCode()

Returns a hash code for this instance.

Overrides:

hashCode in class ChartEntity

Returns:

A hash code.

toString

public String toString()

Returns a string representing the entity.

Overrides:

toString in class ChartEntity

Returns:

A string representing the entity.