org.pentaho.plugin.jfreereport.reportcharts
Class BarLineChartExpression

java.lang.Object
  extended by org.pentaho.reporting.engine.classic.core.function.AbstractExpression
      extended by org.pentaho.plugin.jfreereport.reportcharts.AbstractChartExpression
          extended by org.pentaho.plugin.jfreereport.reportcharts.CategoricalChartExpression
              extended by org.pentaho.plugin.jfreereport.reportcharts.StackedCategoricalChartExpression
                  extended by org.pentaho.plugin.jfreereport.reportcharts.BarChartExpression
                      extended by org.pentaho.plugin.jfreereport.reportcharts.BarLineChartExpression
All Implemented Interfaces:
Serializable, Cloneable, ChartExpression, MultiPlotChartExpression, org.pentaho.reporting.engine.classic.core.function.Expression, org.pentaho.reporting.engine.classic.core.LegacyUpdateHandler

public class BarLineChartExpression
extends BarChartExpression
implements MultiPlotChartExpression

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.pentaho.plugin.jfreereport.reportcharts.AbstractChartExpression
LINE_STYLE_DASH_STR, LINE_STYLE_DASHDOT_STR, LINE_STYLE_DASHDOTDOT_STR, LINE_STYLE_DOT_STR, LINE_STYLE_SOLID_STR
 
Constructor Summary
BarLineChartExpression()
           
 
Method Summary
 org.jfree.chart.JFreeChart computeCategoryChart(org.jfree.data.category.CategoryDataset barsDataset)
           
 String getBarsLabelFont()
          Deprecated.  
 String getBarsTickLabelFont()
          Deprecated.  
 String getBarTicksLabelFormat()
          Deprecated. duplicate property.
 String getCategoryTickLabelFont()
          Deprecated.  
 org.pentaho.reporting.engine.classic.core.function.Expression getInstance()
          Return a completly separated copy of this function.
 double getLinePeriodCount()
           
 double getLineRangeMaximum()
           
 double getLineRangeMinimum()
           
 String getLinesDataSource()
           
 String[] getLineSeriesColor()
           
 String getLineSeriesColor(int index)
           
 int getLineSeriesColorCount()
           
 String getLinesLabelFont()
           
 String getLinesTickLabelFont()
           
 String getLineStyle()
           
 Font getLineTickFont()
           
 String getLineTicksLabelFormat()
           
 Class getLineTimePeriod()
           
 Font getLineTitleFont()
           
 float getLineWidth()
           
 String getSecondaryDataSet()
           
 String getSecondValueAxisLabel()
           
 boolean isLineAxisAutoRange()
           
 boolean isLineAxisIncludesZero()
           
 boolean isLineAxisStickyZero()
           
 boolean isMarkersVisible()
           
 boolean isSharedRangeAxis()
           
 void reconfigureForCompatibility(int versionTag)
           
 void setBarsLabelFont(String barsLabelFont)
          Deprecated.  
 void setBarsTickLabelFont(String barsTickLabelFont)
          Deprecated.  
 void setBarTicksLabelFormat(String lineTicksLabelDateFormat)
          Deprecated. duplicate property.
 void setCategoryTickLabelFont(String categoryTickLabelFont)
          Deprecated.  
 void setLineAxisAutoRange(boolean lineAxisAutoRange)
           
 void setLineAxisIncludesZero(boolean lineAxisIncludesZero)
           
 void setLineAxisStickyZero(boolean lineAxisStickyZero)
           
 void setLinePeriodCount(double linePeriodCount)
           
 void setLineRangeMaximum(double lineRangeMaximum)
           
 void setLineRangeMinimum(double lineRangeMinimum)
           
 void setLinesDataSource(String linesDataSource)
           
 void setLineSeriesColor(int index, String field)
           
 void setLineSeriesColor(String[] fields)
           
 void setLinesLabelFont(String linesLabelFont)
           
 void setLinesTickLabelFont(String linesTickLabelFont)
           
 void setLineStyle(String value)
           
 void setLineTickFont(Font lineTickFont)
           
 void setLineTicksLabelFormat(String lineTicksLabelFormat)
           
 void setLineTimePeriod(Class lineTimePeriod)
           
 void setLineTitleFont(Font lineTitleFont)
           
 void setLineWidth(float value)
           
 void setMarkersVisible(boolean markersVisible)
           
 void setSecondaryDataSet(String dataset)
           
 void setSecondValueAxisLabel(String secondValueAxisLabel)
           
 void setSharedRangeAxis(boolean sharedRangeAxis)
           
 
Methods inherited from class org.pentaho.plugin.jfreereport.reportcharts.BarChartExpression
getItemMargin, getMaxBarWidth, isDrawBarOutline, isStackedBarRenderPercentages, setDrawBarOutline, setItemMargin, setMaxBarWidth, setStackedBarRenderPercentages
 
Methods inherited from class org.pentaho.plugin.jfreereport.reportcharts.StackedCategoricalChartExpression
isStacked, setStacked
 
Methods inherited from class org.pentaho.plugin.jfreereport.reportcharts.CategoricalChartExpression
getCategoricalAxisMessageFormat, getCategoricalItemLabelRotation, getCategoricalItemLabelRotationDeg, getCategoricalLabelDateFormat, getCategoricalLabelDecimalFormat, getCategoricalLabelFormat, getCategoryAxisLabel, getCategoryMargin, getCategoryTickFont, getCategoryTitleFont, getChart, getLabelRotation, getLabelRotationDeg, getLowerMargin, getMaxCategoryLabelWidthRatio, getRangeMaximum, getRangeMinimum, getRangePeriodCount, getRangeTickFont, getRangeTickFormat, getRangeTickFormatString, getRangeTimePeriod, getRangeTitleFont, getUpperMargin, getValueAxisLabel, isAutoRange, isHorizontal, isHumanReadableLogarithmicFormat, isLogarithmicAxis, isRangeIncludesZero, isRangeStickyZero, isShowGridlines, setAutoRange, setCategoricalAxisMessageFormat, setCategoricalItemLabelRotation, setCategoricalItemLabelRotationDeg, setCategoricalLabelDateFormat, setCategoricalLabelDecimalFormat, setCategoricalLabelFormat, setCategoryAxisLabel, setCategoryMargin, setCategoryTickFont, setCategoryTitleFont, setHorizontal, setHumanReadableLogarithmicFormat, setLabelRotation, setLabelRotationDeg, setLogarithmicAxis, setLowerMargin, setMaxCategoryLabelWidthRatio, setRangeIncludesZero, setRangeMaximum, setRangeMinimum, setRangePeriodCount, setRangeStickyZero, setRangeTickFont, setRangeTickFormat, setRangeTickFormatString, setRangeTimePeriod, setRangeTitleFont, setShowGridlines, setUpperMargin, setValueAxisLabel
 
Methods inherited from class org.pentaho.plugin.jfreereport.reportcharts.AbstractChartExpression
getBackgroundColor, getBackgroundImage, getBorderColor, getChartDirectory, getChartFile, getChartFromCache, getChartHeight, getChartUrlMask, getChartWidth, getDataSource, getDependencyLevel, getItemLabelFont, getItemsLabelVisible, getLabelFont, getLegendBackgroundColor, getLegendFont, getLegendLocation, getLegendTextColor, getNoDataMessage, getPlotBackgroundAlpha, getPlotBackgroundColor, getPlotForegroundAlpha, getPossibleExpressionStringValue, getPostProcessingLanguage, getPostProcessingScript, getSeriesColor, getSeriesColor, getSeriesColorCount, getSeriesColors, getTitle, getTitleField, getTitleFont, getTitleText, getTooltipFormula, getUrlFormula, getValue, isAntiAlias, isChartSectionOutline, isDrawLegendBorder, isReturnFileNameOnly, isReturnImageReference, isShowBorder, isShowLegend, isThreeD, isUseDrawable, putChartInCache, setAntiAlias, setBackgroundColor, setBackgroundImage, setBorderColor, setChartDirectory, setChartFile, setChartHeight, setChartSectionOutline, setChartUrlMask, setChartWidth, setDataSource, setDependencyLevel, setDrawLegendBorder, setItemLabelFont, setItemsLabelVisible, setLabelFont, setLegendBackgroundColor, setLegendFont, setLegendLocation, setLegendTextColor, setNoDataMessage, setPlotBackgroundAlpha, setPlotBackgroundColor, setPlotForegroundAlpha, setPostProcessingLanguage, setPostProcessingScript, setReturnFileNameOnly, setReturnImageReference, setSeriesColor, setSeriesColor, setShowBorder, setShowLegend, setThreeD, setTitle, setTitleField, setTitleFont, setTitleText, setTooltipFormula, setUrlFormula, setUseDrawable, translateLineStyle
 
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.plugin.jfreereport.reportcharts.ChartExpression
getDataSource, setDataSource
 
Methods inherited from interface org.pentaho.reporting.engine.classic.core.function.Expression
clone, getDataRow, getDependencyLevel, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, getValue, isActive, isDeepTraversing, isPreserve, setDependencyLevel, setName, setRuntime
 

Constructor Detail

BarLineChartExpression

public BarLineChartExpression()
Method Detail

isLineAxisIncludesZero

public boolean isLineAxisIncludesZero()

setLineAxisIncludesZero

public void setLineAxisIncludesZero(boolean lineAxisIncludesZero)

isLineAxisStickyZero

public boolean isLineAxisStickyZero()

setLineAxisStickyZero

public void setLineAxisStickyZero(boolean lineAxisStickyZero)

getLineTitleFont

public Font getLineTitleFont()

setLineTitleFont

public void setLineTitleFont(Font lineTitleFont)

getLineTickFont

public Font getLineTickFont()

setLineTickFont

public void setLineTickFont(Font lineTickFont)

getLineRangeMinimum

public double getLineRangeMinimum()

setLineRangeMinimum

public void setLineRangeMinimum(double lineRangeMinimum)

getLineRangeMaximum

public double getLineRangeMaximum()

setLineRangeMaximum

public void setLineRangeMaximum(double lineRangeMaximum)

getLinePeriodCount

public double getLinePeriodCount()

setLinePeriodCount

public void setLinePeriodCount(double linePeriodCount)

getLineTimePeriod

public Class getLineTimePeriod()

setLineTimePeriod

public void setLineTimePeriod(Class lineTimePeriod)

isSharedRangeAxis

public boolean isSharedRangeAxis()

setSharedRangeAxis

public void setSharedRangeAxis(boolean sharedRangeAxis)

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 CategoricalChartExpression
Returns:
a copy of this function.

getLinesDataSource

public String getLinesDataSource()

setLinesDataSource

public void setLinesDataSource(String linesDataSource)

getSecondaryDataSet

public String getSecondaryDataSet()
Specified by:
getSecondaryDataSet in interface MultiPlotChartExpression

setSecondaryDataSet

public void setSecondaryDataSet(String dataset)
Specified by:
setSecondaryDataSet in interface MultiPlotChartExpression

getLinesLabelFont

public String getLinesLabelFont()

setLinesLabelFont

public void setLinesLabelFont(String linesLabelFont)

getLinesTickLabelFont

public String getLinesTickLabelFont()

setLinesTickLabelFont

public void setLinesTickLabelFont(String linesTickLabelFont)

getSecondValueAxisLabel

public String getSecondValueAxisLabel()

setSecondValueAxisLabel

public void setSecondValueAxisLabel(String secondValueAxisLabel)

getLineTicksLabelFormat

public String getLineTicksLabelFormat()

setLineTicksLabelFormat

public void setLineTicksLabelFormat(String lineTicksLabelFormat)

setLineSeriesColor

public void setLineSeriesColor(int index,
                               String field)

getLineSeriesColor

public String getLineSeriesColor(int index)

getLineSeriesColorCount

public int getLineSeriesColorCount()

getLineSeriesColor

public String[] getLineSeriesColor()

setLineSeriesColor

public void setLineSeriesColor(String[] fields)

getLineStyle

public String getLineStyle()
Returns:
returns the style set for the lines

setLineStyle

public void setLineStyle(String value)
Parameters:
value - set the style for all line series

getLineWidth

public float getLineWidth()
Returns:
the width of all line series Valid values are float numbers zero or greater

setLineWidth

public void setLineWidth(float value)
Parameters:
value - set the width of all line series Valid values are float numbers zero or greater

isMarkersVisible

public boolean isMarkersVisible()
Returns:
boolean whether the markers (data points) for all series are displayed

setMarkersVisible

public void setMarkersVisible(boolean markersVisible)
Parameters:
markersVisible - set whether the markers (data points) for all series should be displayed

getBarsTickLabelFont

public String getBarsTickLabelFont()
Deprecated. 


setBarsTickLabelFont

public void setBarsTickLabelFont(String barsTickLabelFont)
Deprecated. 


getCategoryTickLabelFont

public String getCategoryTickLabelFont()
Deprecated. 


setCategoryTickLabelFont

public void setCategoryTickLabelFont(String categoryTickLabelFont)
Deprecated. 


getBarTicksLabelFormat

public String getBarTicksLabelFormat()
Deprecated. duplicate property.

Returns:

setBarTicksLabelFormat

public void setBarTicksLabelFormat(String lineTicksLabelDateFormat)
Deprecated. duplicate property.

Parameters:
lineTicksLabelDateFormat -

getBarsLabelFont

public String getBarsLabelFont()
Deprecated. 


setBarsLabelFont

public void setBarsLabelFont(String barsLabelFont)
Deprecated. 


isLineAxisAutoRange

public boolean isLineAxisAutoRange()

setLineAxisAutoRange

public void setLineAxisAutoRange(boolean lineAxisAutoRange)

computeCategoryChart

public org.jfree.chart.JFreeChart computeCategoryChart(org.jfree.data.category.CategoryDataset barsDataset)
Overrides:
computeCategoryChart in class BarChartExpression

reconfigureForCompatibility

public void reconfigureForCompatibility(int versionTag)
Specified by:
reconfigureForCompatibility in interface org.pentaho.reporting.engine.classic.core.LegacyUpdateHandler
Overrides:
reconfigureForCompatibility in class CategoricalChartExpression