Package org.pentaho.platform.uifoundation.chart

Class PieDatasetChartDefinition

java.lang.Object

org.jfree.data.general.AbstractDataset

org.jfree.data.general.DefaultPieDataset

org.pentaho.platform.uifoundation.chart.PieDatasetChartDefinition

All Implemented Interfaces:

ObjectInputValidation, Serializable, Cloneable, org.jfree.data.general.Dataset, org.jfree.data.general.PieDataset, org.jfree.data.KeyedValues, org.jfree.data.Values, org.jfree.util.PublicCloneable, ChartDefinition

public class PieDatasetChartDefinition
extends org.jfree.data.general.DefaultPieDataset
implements ChartDefinition

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.apache.commons.logging.Log	logger

Fields inherited from interface org.pentaho.platform.uifoundation.chart.ChartDefinition

AREA_CHART_STR, BACKGROUND_ALPHA_NODE_NAME, BACKGROUND_TYPE_ATTRIBUTE_NAME, BAR_CHART_STR, BAR_LINE_CHART_STR, BUBBLE_CHART_STR, CATEGORY_DATASET_STR, CHART_BACKGROUND_NODE_NAME, CHART_BORDER_PAINT_NODE_NAME, CHART_BORDER_VISIBLE_NODE_NAME, COLOR_NODE_NAME, COLOR_TYPE_NAME, DATASET_TYPE_NODE_NAME, DAY_PERIOD_TYPE_STR, DIAL_CHART_STR, DIFFERENCE_CHART_STR, DISPLAY_LABELS_NODE_NAME, DISPLAY_LEGEND_BORDER_NODE_NAME, DOT_CHART_STR, DOT_HEIGHT_NODE_NAME, DOT_WIDTH_NODE_NAME, FIXEDMILLISECOND_PERIOD_TYPE_STR, FOREGROUND_ALPHA_NODE_NAME, GRADIENT_TYPE_NAME, HEIGHT_NODE_NAME, HORIZONTAL_ORIENTATION, HOUR_PERIOD_TYPE_STR, IMAGE_TYPE_NAME, INCLUDE_LEGEND_NODE_NAME, LEGEND_FONT_NODE_NAME, LEGEND_POSITION_NODE_NAME, LINE_CHART_STR, LINE_STYLE_DASH_STR, LINE_STYLE_DASHDOT_STR, LINE_STYLE_DASHDOTDOT_STR, LINE_STYLE_DOT_STR, LINE_STYLE_NODE_NAME, LINE_STYLE_SOLID_STR, LINE_WIDTH_NODE_NAME, MARKER_VISIBLE_NODE_NAME, MILLISECOND_PERIOD_TYPE_STR, MINUTE_PERIOD_TYPE_STR, MONTH_PERIOD_TYPE_STR, PALETTE_NODE_NAME, PIE_CHART_STR, PIE_GRID_CHART_STR, PLOT_BACKGROUND_NODE_NAME, QUARTER_PERIOD_TYPE_STR, SECOND_PERIOD_TYPE_STR, STACKED_NODE_NAME, STEP_AREA_CHART_STR, STEP_CHART_STR, SUBTITLE_NODE_NAME, SUBTITLES_NODE_NAME, TEXTURE_TYPE_NAME, THREED_NODE_NAME, TIME_SERIES_COLLECTION_STR, TITLE_FONT_NODE_NAME, TITLE_NODE_NAME, TITLE_POSITION_NODE_NAME, TYPE_NODE_NAME, VERTICAL_ORIENTATION, WEEK_PERIOD_TYPE_STR, WIDTH_NODE_NAME, XY_SERIES_COLLECTION_STR, XYZ_SERIES_COLLECTION_STR, YEAR_PERIOD_TYPE_STR

Constructor Summary

Constructors

Constructor	Description
PieDatasetChartDefinition(org.pentaho.commons.connection.IPentahoResultSet data, boolean byRow, org.dom4j.Node chartAttributes, org.pentaho.platform.api.engine.IPentahoSession session)
PieDatasetChartDefinition(org.pentaho.commons.connection.IPentahoResultSet data, boolean byRow, org.pentaho.platform.api.engine.IPentahoSession session)
PieDatasetChartDefinition(org.pentaho.platform.api.engine.IPentahoSession session)

Method Summary

Modifier and Type	Method	Description
void	addExplodedSlice(String slice)
void	addExplodedSlices(List nodes)
void	addSubTitle(String subTitle)
void	addSubTitles(List subTitleNodes)
Float	getBackgroundAlpha()
Paint	getBorderPaint()
Image	getChartBackgroundImage()
Paint	getChartBackgroundPaint()
List	getExplodedSlices()
Float	getForegroundAlpha()
int	getHeight()
double	getInteriorGap()
Paint	getLabelBackgroundPaint()
Font	getLabelFont()
double	getLabelGap()
Paint	getLabelPaint()
Font	getLegendFont()	Return the java.awt.Font to be used to display the legend items
org.jfree.ui.RectangleEdge	getLegendPosition()
static org.apache.commons.logging.Log	getLogger()
String	getNoDataMessage()
Paint[]	getPaintSequence()
Image	getPlotBackgroundImage()
Paint	getPlotBackgroundPaint()
org.pentaho.platform.api.engine.IPentahoSession	getSession()
double	getStartAngle()
List	getSubtitles()
String	getTitle()
Font	getTitleFont()
org.jfree.ui.RectangleEdge	getTitlePosition()
int	getWidth()
boolean	isBorderVisible()
boolean	isDisplayLabels()
boolean	isLegendBorderVisible()	Return the boolen that states if the legend border is visible
boolean	isLegendIncluded()
boolean	isThreeD()
void	setBackgroundAlpha(org.dom4j.Node backgroundAlphaNode)
void	setBorderPaint(Paint borderPaint)
void	setBorderVisible(boolean borderVisible)
void	setBorderVisible(org.dom4j.Node borderVisibleNode)
void	setChartBackground(org.dom4j.Node chartBackgroundNode)
void	setChartBackgroundImage(Image chartBackgroundImage)
void	setChartBackgroundImage(org.dom4j.Node chartBackgroundImageNode)
void	setChartBackgroundPaint(Paint chartBackgroundPaint)
void	setDisplayLabels(boolean displayLabels)
void	setDisplayLabels(org.dom4j.Node threeDNode)
void	setForegroundAlpha(org.dom4j.Node foregroundAlphaNode)
void	setHeight(int height)
void	setHeight(org.dom4j.Node heightNode)
void	setInteriorGap(double interiorGap)
void	setLabelBackgroundPaint(Paint labelBackgroundPaint)
void	setLabelFont(Font font)
void	setLabelGap(double labelGap)
void	setLabelGap(org.dom4j.Node labelGapNode)
void	setLabelPaint(Paint labelPaint)
void	setLegendBorderVisible(boolean legendBorderVisible)
void	setLegendBorderVisible(org.dom4j.Node legendBorderVisibleNode)
void	setLegendFont(Font legendFont)	Set java.awt.Font to be used to display the legend items
void	setLegendFont(org.dom4j.Node legendFontNode)
void	setLegendIncluded(boolean legendIncluded)
void	setLegendIncluded(org.dom4j.Node legendNode)
void	setLegendPosition(org.dom4j.Node legendPositionNode)
void	setLegendPosition(org.jfree.ui.RectangleEdge legendPosition)
void	setPaintSequence(Paint[] paintSequence)
void	setPaintSequence(org.dom4j.Node paletteNode)
void	setPlotBackground(org.dom4j.Node plotBackgroundNode)
void	setPlotBackgroundImage(Image plotBackgroundImage)
void	setPlotBackgroundImage(org.dom4j.Node plotBackgroundImageNode)
void	setPlotBackgroundPaint(Paint plotBackgroundPaint)
void	setSession(org.pentaho.platform.api.engine.IPentahoSession session)
void	setStartAngle(double startAngle)
void	setThreeD(boolean threeD)
void	setThreeD(org.dom4j.Node threeDNode)
void	setTitle(String title)
void	setTitle(org.dom4j.Node chartTitleNode)
void	setTitleFont(Font titleFont)
void	setTitleFont(org.dom4j.Node titleFontNode)
void	setTitlePosition(org.dom4j.Node titlePositionNode)
void	setTitlePosition(org.jfree.ui.RectangleEdge titlePosition)
void	setWidth(int width)
void	setWidth(org.dom4j.Node widthNode)

Methods inherited from class org.jfree.data.general.DefaultPieDataset

clear, clone, equals, getIndex, getItemCount, getKey, getKeys, getValue, getValue, hashCode, insertValue, insertValue, remove, setValue, setValue, sortByKeys, sortByValues

Methods inherited from class org.jfree.data.general.AbstractDataset

addChangeListener, fireDatasetChanged, getGroup, hasListener, notifyListeners, removeChangeListener, setGroup, validateObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jfree.data.general.Dataset

addChangeListener, getGroup, removeChangeListener, setGroup

Field Detail

logger

protected static final org.apache.commons.logging.Log logger

Constructor Detail

PieDatasetChartDefinition

public PieDatasetChartDefinition(org.pentaho.platform.api.engine.IPentahoSession session)

PieDatasetChartDefinition

public PieDatasetChartDefinition(org.pentaho.commons.connection.IPentahoResultSet data,
                                 boolean byRow,
                                 org.pentaho.platform.api.engine.IPentahoSession session)

Parameters:

data -

PieDatasetChartDefinition

public PieDatasetChartDefinition(org.pentaho.commons.connection.IPentahoResultSet data,
                                 boolean byRow,
                                 org.dom4j.Node chartAttributes,
                                 org.pentaho.platform.api.engine.IPentahoSession session)

Method Detail

getLogger

public static org.apache.commons.logging.Log getLogger()

setHeight

public void setHeight(org.dom4j.Node heightNode)

setHeight

public void setHeight(int height)

Parameters:

height - The height to set.

getHeight

public int getHeight()

Specified by:

getHeight in interface ChartDefinition

setWidth

public void setWidth(org.dom4j.Node widthNode)

setWidth

public void setWidth(int width)

Parameters:

width - The width to set.

getWidth

public int getWidth()

Specified by:

getWidth in interface ChartDefinition

setTitle

public void setTitle(org.dom4j.Node chartTitleNode)

setTitle

public void setTitle(String title)

Parameters:

title - The title to set.

getTitle

public String getTitle()

Specified by:

getTitle in interface ChartDefinition

setTitleFont

public void setTitleFont(Font titleFont)

setTitleFont

public void setTitleFont(org.dom4j.Node titleFontNode)

getTitleFont

public Font getTitleFont()

Specified by:

getTitleFont in interface ChartDefinition

addSubTitles

public void addSubTitles(List subTitleNodes)

addSubTitle

public void addSubTitle(String subTitle)

getSubtitles

public List getSubtitles()

Specified by:

getSubtitles in interface ChartDefinition

addExplodedSlices

public void addExplodedSlices(List nodes)

addExplodedSlice

public void addExplodedSlice(String slice)

getExplodedSlices

public List getExplodedSlices()

setChartBackground

public void setChartBackground(org.dom4j.Node chartBackgroundNode)

setChartBackgroundPaint

public void setChartBackgroundPaint(Paint chartBackgroundPaint)

Parameters:

backgroundPaint - The backgroundPaint to set.

getChartBackgroundPaint

public Paint getChartBackgroundPaint()

Specified by:

getChartBackgroundPaint in interface ChartDefinition

setChartBackgroundImage

public void setChartBackgroundImage(org.dom4j.Node chartBackgroundImageNode)

setChartBackgroundImage

public void setChartBackgroundImage(Image chartBackgroundImage)

Parameters:

chartBackgroundImage - The chartBackgroundImage to set.

getChartBackgroundImage

public Image getChartBackgroundImage()

Specified by:

getChartBackgroundImage in interface ChartDefinition

setBorderVisible

public void setBorderVisible(org.dom4j.Node borderVisibleNode)

setBorderVisible

public void setBorderVisible(boolean borderVisible)

Parameters:

borderVisible - The borderVisible to set.

isBorderVisible

public boolean isBorderVisible()

Specified by:

isBorderVisible in interface ChartDefinition

getBorderPaint

public Paint getBorderPaint()

Specified by:

getBorderPaint in interface ChartDefinition

setBorderPaint

public void setBorderPaint(Paint borderPaint)

Parameters:

borderPaint - The borderPaint to set.

setTitlePosition

public void setTitlePosition(org.dom4j.Node titlePositionNode)

getTitlePosition

public org.jfree.ui.RectangleEdge getTitlePosition()

Specified by:

getTitlePosition in interface ChartDefinition

Returns:

Returns the titlePosition.

setTitlePosition

public void setTitlePosition(org.jfree.ui.RectangleEdge titlePosition)

Parameters:

titlePosition - The titlePosition to set.

setLegendPosition

public void setLegendPosition(org.dom4j.Node legendPositionNode)

getLegendPosition

public org.jfree.ui.RectangleEdge getLegendPosition()

Specified by:

getLegendPosition in interface ChartDefinition

setLegendPosition

public void setLegendPosition(org.jfree.ui.RectangleEdge legendPosition)

setPaintSequence

public void setPaintSequence(org.dom4j.Node paletteNode)

setPaintSequence

public void setPaintSequence(Paint[] paintSequence)

Parameters:

paintSequence - The paintSequence to set.

getPaintSequence

public Paint[] getPaintSequence()

Specified by:

getPaintSequence in interface ChartDefinition

setPlotBackground

public void setPlotBackground(org.dom4j.Node plotBackgroundNode)

setPlotBackgroundPaint

public void setPlotBackgroundPaint(Paint plotBackgroundPaint)

getPlotBackgroundPaint

public Paint getPlotBackgroundPaint()

Specified by:

getPlotBackgroundPaint in interface ChartDefinition

setPlotBackgroundImage

public void setPlotBackgroundImage(Image plotBackgroundImage)

Parameters:

plotBackgroundImage - The plotBackgroundImage to set.

setPlotBackgroundImage

public void setPlotBackgroundImage(org.dom4j.Node plotBackgroundImageNode)

getPlotBackgroundImage

public Image getPlotBackgroundImage()

Specified by:

getPlotBackgroundImage in interface ChartDefinition

setLegendIncluded

public void setLegendIncluded(org.dom4j.Node legendNode)

setLegendIncluded

public void setLegendIncluded(boolean legendIncluded)

Parameters:

legendIncluded - The legendIncluded to set.

isLegendIncluded

public boolean isLegendIncluded()

Specified by:

isLegendIncluded in interface ChartDefinition

setThreeD

public void setThreeD(org.dom4j.Node threeDNode)

setThreeD

public void setThreeD(boolean threeD)

Parameters:

threeD - The threeD to set.

isThreeD

public boolean isThreeD()

Specified by:

isThreeD in interface ChartDefinition

setInteriorGap

public void setInteriorGap(double interiorGap)

Parameters:

interiorGap - The interiorGap to set.

getInteriorGap

public double getInteriorGap()

setStartAngle

public void setStartAngle(double startAngle)

Parameters:

startAngle - The startAngle to set.

getStartAngle

public double getStartAngle()

setLabelFont

public void setLabelFont(Font font)

getLabelFont

public Font getLabelFont()

setLabelPaint

public void setLabelPaint(Paint labelPaint)

Parameters:

labelPaint - The labelPaint to set.

getLabelPaint

public Paint getLabelPaint()

Returns:

Returns the labelPaint.

getLabelBackgroundPaint

public Paint getLabelBackgroundPaint()

setLabelBackgroundPaint

public void setLabelBackgroundPaint(Paint labelBackgroundPaint)

Parameters:

labelBackgroundPaint - The labelBackgroundPaint to set.

getLabelGap

public double getLabelGap()

setLabelGap

public void setLabelGap(org.dom4j.Node labelGapNode)

Parameters:

node - The labelGap to set.

setLabelGap

public void setLabelGap(double labelGap)

isDisplayLabels

public boolean isDisplayLabels()

Specified by:

isDisplayLabels in interface ChartDefinition

setDisplayLabels

public void setDisplayLabels(org.dom4j.Node threeDNode)

setDisplayLabels

public void setDisplayLabels(boolean displayLabels)

getSession

public org.pentaho.platform.api.engine.IPentahoSession getSession()

setSession

public void setSession(org.pentaho.platform.api.engine.IPentahoSession session)

getLegendFont

public Font getLegendFont()

Return the java.awt.Font to be used to display the legend items

Specified by:

getLegendFont in interface ChartDefinition

Returns:

Font The font for the legend items

setLegendFont

public void setLegendFont(Font legendFont)

Set java.awt.Font to be used to display the legend items

Parameters:

Font - The java.awt.Font for the legend items

setLegendFont

public void setLegendFont(org.dom4j.Node legendFontNode)

setLegendBorderVisible

public void setLegendBorderVisible(org.dom4j.Node legendBorderVisibleNode)

setLegendBorderVisible

public void setLegendBorderVisible(boolean legendBorderVisible)

Parameters:

boolean - legendBorderVisible Set the visibility of the legend border.

isLegendBorderVisible

public boolean isLegendBorderVisible()

Return the boolen that states if the legend border is visible

Specified by:

isLegendBorderVisible in interface ChartDefinition

Returns:

boolean Is the legend border visible

getNoDataMessage

public String getNoDataMessage()

Specified by:

getNoDataMessage in interface ChartDefinition

getBackgroundAlpha

public Float getBackgroundAlpha()

Specified by:

getBackgroundAlpha in interface ChartDefinition

setBackgroundAlpha

public void setBackgroundAlpha(org.dom4j.Node backgroundAlphaNode)

getForegroundAlpha

public Float getForegroundAlpha()

Specified by:

getForegroundAlpha in interface ChartDefinition

setForegroundAlpha

public void setForegroundAlpha(org.dom4j.Node foregroundAlphaNode)