org.pentaho.plugin.jfreereport.reportcharts
Class AbstractChartExpression

java.lang.Object
  org.pentaho.reporting.engine.classic.core.function.AbstractExpression
      org.pentaho.plugin.jfreereport.reportcharts.AbstractChartExpression

All Implemented Interfaces:

Serializable, Cloneable, ChartExpression, org.pentaho.reporting.engine.classic.core.function.Expression

Direct Known Subclasses:

CategoricalChartExpression, MultiPieChartExpression, PieChartExpression, RadarChartExpression, XYChartExpression

public abstract class AbstractChartExpression
extends org.pentaho.reporting.engine.classic.core.function.AbstractExpression
implements ChartExpression

See Also:

Serialized Form

Field Summary

static String	LINE_STYLE_DASH_STR
static String	LINE_STYLE_DASHDOT_STR
static String	LINE_STYLE_DASHDOTDOT_STR
static String	LINE_STYLE_DOT_STR
static String	LINE_STYLE_SOLID_STR

Method Summary

String	getBackgroundColor()
String	getBackgroundImage()
String	getBorderColor()
String	getChartDirectory() Deprecated. This property is no longer used.
String	getChartFile() Deprecated. This property is no longer used.
org.jfree.chart.JFreeChart	getChartFromCache(Object key) Deprecated. This method should not be public and should check for null-values. Use #storeChartInCache now.
int	getChartHeight() Deprecated. This property is no longer used.
String	getChartUrlMask() Deprecated. This property is no longer used.
int	getChartWidth() Deprecated. This property is no longer used.
String	getDataSource()
int	getDependencyLevel() Overrides the dependency level to only execute this function on the pagination and content-generation level.
org.pentaho.reporting.engine.classic.core.function.Expression	getInstance() Return a completly separated copy of this function.
Font	getItemLabelFont()
Boolean	getItemsLabelVisible()
String	getLabelFont()
Color	getLegendBackgroundColor()
String	getLegendFont()
String	getLegendLocation()
Color	getLegendTextColor()
String	getNoDataMessage()
float	getPlotBackgroundAlpha()
Color	getPlotBackgroundColor()
float	getPlotForegroundAlpha()
String	getPossibleExpressionStringValue(String lookupValue) Deprecated. This method should not be public and is part of a messed up title-semantic. Will be removed later.
String	getPostProcessingLanguage()
String	getPostProcessingScript()
String[]	getSeriesColor()
String	getSeriesColor(int index)
int	getSeriesColorCount()
List	getSeriesColors() Deprecated. use bean accessors instead: getSeriesColor(), getSeriesColor(int index)
String	getTitle() Deprecated. The semantics of this property is all messed up and thus we can only deprecate it.
String	getTitleField()
String	getTitleFont()
String	getTitleText()
String	getTooltipFormula()
String	getUrlFormula()
Object	getValue()
boolean	isAntiAlias()
boolean	isChartSectionOutline()
boolean	isDrawLegendBorder()
boolean	isReturnFileNameOnly() Deprecated. This property is no longer used.
boolean	isReturnImageReference() Deprecated. This property is no longer used.
boolean	isShowBorder()
boolean	isShowLegend()
boolean	isThreeD()
boolean	isUseDrawable() Deprecated. This property should no longer be defined manually. The only sensible value it can take is "true" now.
void	putChartInCache(org.jfree.chart.JFreeChart chart, Object key) Deprecated. This method should not be public and should check for null-values. Use #storeChartInCache now.
void	setAntiAlias(boolean value)
void	setBackgroundColor(String value)
void	setBackgroundImage(String value)
void	setBorderColor(String value)
void	setChartDirectory(String value) Deprecated. This property is no longer used.
void	setChartFile(String value) Deprecated. This property is no longer used.
void	setChartHeight(int value) Deprecated. This property is no longer used.
void	setChartSectionOutline(boolean value)
void	setChartUrlMask(String value) Deprecated. This property is no longer used.
void	setChartWidth(int value) Deprecated. This property is no longer used.
void	setDataSource(String dataSource)
void	setDependencyLevel(int ignored)
void	setDrawLegendBorder(boolean value)
void	setItemLabelFont(Font itemLabelFont)
void	setItemsLabelVisible(Boolean itemsLabelVisible)
void	setLabelFont(String value)
void	setLegendBackgroundColor(Color legendBackgroundColor)
void	setLegendFont(String value)
void	setLegendLocation(String value)
void	setLegendTextColor(Color legendTextColor)
void	setNoDataMessage(String noDataMessage)
void	setPlotBackgroundAlpha(float plotBackgroundAlpha)
void	setPlotBackgroundColor(Color plotBackgroundColor)
void	setPlotForegroundAlpha(float plotForegroundAlpha)
void	setPostProcessingLanguage(String postProcessingLanguage)
void	setPostProcessingScript(String postProcessingScript)
void	setReturnFileNameOnly(boolean value) Deprecated. This property is no longer used.
void	setReturnImageReference(boolean value) Deprecated. This property is no longer used.
void	setSeriesColor(int index, String field)
void	setSeriesColor(String[] fields)
void	setShowBorder(boolean value)
void	setShowLegend(boolean value)
void	setThreeD(boolean value)
void	setTitle(String title) Deprecated. The semantics of this property is all messed up and thus we can only deprecate it.
void	setTitleField(String titleField)
void	setTitleFont(String value)
void	setTitleText(String titleText)
void	setTooltipFormula(String tooltipFormula)
void	setUrlFormula(String urlFormula)
void	setUseDrawable(boolean value) Deprecated. This property should no longer be defined manually. The only sensible value it can take is "true" now.
static Stroke	translateLineStyle(float lineWidth, String lineStyle)

Methods inherited from class org.pentaho.reporting.engine.classic.core.function.AbstractExpression

clone, getDataRow, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setActive, setName, setPreserve, setRuntime

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.pentaho.reporting.engine.classic.core.function.Expression

clone, getDataRow, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setName, setRuntime

Field Detail

LINE_STYLE_SOLID_STR

public static final String LINE_STYLE_SOLID_STR

See Also:

Constant Field Values

LINE_STYLE_DASH_STR

public static final String LINE_STYLE_DASH_STR

See Also:

Constant Field Values

LINE_STYLE_DOT_STR

public static final String LINE_STYLE_DOT_STR

See Also:

Constant Field Values

LINE_STYLE_DASHDOT_STR

public static final String LINE_STYLE_DASHDOT_STR

See Also:

Constant Field Values

LINE_STYLE_DASHDOTDOT_STR

public static final String LINE_STYLE_DASHDOTDOT_STR

See Also:

Constant Field Values

Method Detail

getItemLabelFont

public Font getItemLabelFont()

setItemLabelFont

public void setItemLabelFont(Font itemLabelFont)

getTooltipFormula

public String getTooltipFormula()

setTooltipFormula

public void setTooltipFormula(String tooltipFormula)

getUrlFormula

public String getUrlFormula()

setUrlFormula

public void setUrlFormula(String urlFormula)

getPostProcessingLanguage

public String getPostProcessingLanguage()

setPostProcessingLanguage

public void setPostProcessingLanguage(String postProcessingLanguage)

getPostProcessingScript

public String getPostProcessingScript()

setPostProcessingScript

public void setPostProcessingScript(String postProcessingScript)

getLegendBackgroundColor

public Color getLegendBackgroundColor()

setLegendBackgroundColor

public void setLegendBackgroundColor(Color legendBackgroundColor)

getLegendTextColor

public Color getLegendTextColor()

setLegendTextColor

public void setLegendTextColor(Color legendTextColor)

getPlotForegroundAlpha

public float getPlotForegroundAlpha()

setPlotForegroundAlpha

public void setPlotForegroundAlpha(float plotForegroundAlpha)

getPlotBackgroundAlpha

public float getPlotBackgroundAlpha()

setPlotBackgroundAlpha

public void setPlotBackgroundAlpha(float plotBackgroundAlpha)

getPlotBackgroundColor

public Color getPlotBackgroundColor()

setPlotBackgroundColor

public void setPlotBackgroundColor(Color plotBackgroundColor)

getTitleFont

public String getTitleFont()

setTitleFont

public void setTitleFont(String value)

getLegendFont

public String getLegendFont()

setLegendFont

public void setLegendFont(String value)

getLabelFont

public String getLabelFont()

setLabelFont

public void setLabelFont(String value)

getDataSource

public String getDataSource()

Specified by:

getDataSource in interface ChartExpression

setDataSource

public void setDataSource(String dataSource)

Specified by:

setDataSource in interface ChartExpression

getTitleField

public String getTitleField()

setTitleField

public void setTitleField(String titleField)

getTitleText

public String getTitleText()

setTitleText

public void setTitleText(String titleText)

isAntiAlias

public boolean isAntiAlias()

setAntiAlias

public void setAntiAlias(boolean value)

getBorderColor

public String getBorderColor()

setBorderColor

public void setBorderColor(String value)

getBackgroundColor

public String getBackgroundColor()

setBackgroundColor

public void setBackgroundColor(String value)

isShowBorder

public boolean isShowBorder()

setShowBorder

public void setShowBorder(boolean value)

getLegendLocation

public String getLegendLocation()

setLegendLocation

public void setLegendLocation(String value)

isDrawLegendBorder

public boolean isDrawLegendBorder()

setDrawLegendBorder

public void setDrawLegendBorder(boolean value)

isShowLegend

public boolean isShowLegend()

setShowLegend

public void setShowLegend(boolean value)

isThreeD

public boolean isThreeD()

setThreeD

public void setThreeD(boolean value)

isChartSectionOutline

public boolean isChartSectionOutline()

setChartSectionOutline

public void setChartSectionOutline(boolean value)

getNoDataMessage

public String getNoDataMessage()

setNoDataMessage

public void setNoDataMessage(String noDataMessage)

setBackgroundImage

public void setBackgroundImage(String value)

getBackgroundImage

public String getBackgroundImage()

getItemsLabelVisible

public Boolean getItemsLabelVisible()

setItemsLabelVisible

public void setItemsLabelVisible(Boolean itemsLabelVisible)

setSeriesColor

public void setSeriesColor(int index,
                           String field)

getSeriesColor

public String getSeriesColor(int index)

getSeriesColorCount

public int getSeriesColorCount()

getSeriesColor

public String[] getSeriesColor()

setSeriesColor

public void setSeriesColor(String[] fields)

getInstance

public org.pentaho.reporting.engine.classic.core.function.Expression getInstance()

Return a completly separated copy of this function. The copy does no longer share any changeable objects with the original function.

Specified by:

getInstance in interface org.pentaho.reporting.engine.classic.core.function.Expression

Overrides:

getInstance in class org.pentaho.reporting.engine.classic.core.function.AbstractExpression

Returns:

a copy of this function.

getValue

public Object getValue()

Specified by:

getValue in interface org.pentaho.reporting.engine.classic.core.function.Expression

getDependencyLevel

public int getDependencyLevel()

Overrides the dependency level to only execute this function on the pagination and content-generation level.

Specified by:

getDependencyLevel in interface org.pentaho.reporting.engine.classic.core.function.Expression

Overrides:

getDependencyLevel in class org.pentaho.reporting.engine.classic.core.function.AbstractExpression

Returns:

LayoutProcess.LEVEL_PAGINATE.

setDependencyLevel

public void setDependencyLevel(int ignored)

Specified by:

setDependencyLevel in interface org.pentaho.reporting.engine.classic.core.function.Expression

Overrides:

setDependencyLevel in class org.pentaho.reporting.engine.classic.core.function.AbstractExpression

translateLineStyle

public static Stroke translateLineStyle(float lineWidth,
                                        String lineStyle)

Returns:

java.awt.Stroke for JFreeChart renderer to draw lines

setChartWidth

public void setChartWidth(int value)

Deprecated. This property is no longer used.

Parameters:

value - ignored.

getChartWidth

public int getChartWidth()

Deprecated. This property is no longer used.

Returns:

always zero.

setChartHeight

public void setChartHeight(int value)

Deprecated. This property is no longer used.

Parameters:

value - ignored.

getChartHeight

public int getChartHeight()

Deprecated. This property is no longer used.

Returns:

always zero.

setChartDirectory

public void setChartDirectory(String value)

Deprecated. This property is no longer used.

Parameters:

value - ignored.

setChartFile

public void setChartFile(String value)

Deprecated. This property is no longer used.

Parameters:

value - ignored.

setChartUrlMask

public void setChartUrlMask(String value)

Deprecated. This property is no longer used.

Parameters:

value - ignored.

getChartDirectory

public String getChartDirectory()

Deprecated. This property is no longer used.

Returns:

always null.

getChartFile

public String getChartFile()

Deprecated. This property is no longer used.

Returns:

always null.

getChartUrlMask

public String getChartUrlMask()

Deprecated. This property is no longer used.

Returns:

always null.

isReturnFileNameOnly

public boolean isReturnFileNameOnly()

Deprecated. This property is no longer used.

Returns:

always false.

setReturnFileNameOnly

public void setReturnFileNameOnly(boolean value)

Deprecated. This property is no longer used.

Parameters:

value - ignored.

isReturnImageReference

public boolean isReturnImageReference()

Deprecated. This property is no longer used.

Returns:

always false.

setReturnImageReference

public void setReturnImageReference(boolean value)

Deprecated. This property is no longer used.

Parameters:

value - ignored.

getChartFromCache

public org.jfree.chart.JFreeChart getChartFromCache(Object key)

Deprecated. This method should not be public and should check for null-values. Use #storeChartInCache now.

Parameters:

key -

putChartInCache

public void putChartInCache(org.jfree.chart.JFreeChart chart,
                            Object key)

Deprecated. This method should not be public and should check for null-values. Use #storeChartInCache now.

Parameters:

chart -

key -

isUseDrawable

public boolean isUseDrawable()

Deprecated. This property should no longer be defined manually. The only sensible value it can take is "true" now.

Returns:

setUseDrawable

public void setUseDrawable(boolean value)

Deprecated. This property should no longer be defined manually. The only sensible value it can take is "true" now.

getPossibleExpressionStringValue

public String getPossibleExpressionStringValue(String lookupValue)

Deprecated. This method should not be public and is part of a messed up title-semantic. Will be removed later.

Parameters:

lookupValue -

Returns:

getTitle

public String getTitle()

Deprecated. The semantics of this property is all messed up and thus we can only deprecate it.

Returns:

setTitle

public void setTitle(String title)

Deprecated. The semantics of this property is all messed up and thus we can only deprecate it.

getSeriesColors

public List getSeriesColors()

Deprecated. use bean accessors instead: getSeriesColor(), getSeriesColor(int index)