org.jfree.report.modules.misc.survey

Class SurveyScaleExpression

Implemented Interfaces:
Cloneable, Expression, Serializable

public class SurveyScaleExpression
extends ColumnAggregationExpression

An expression that takes values from one or more fields in the current row of the report, builds a SurveyScale instance that will present those values, and returns that instance as the expression result. The fields used by the expression are defined using properties named '0', '1', ... 'N', which need to be specified after the expression is created. These fields should contain Number instances.The SurveyScale class implements the Drawable interface, so it can be displayed using a DrawableElement.

Constructor Summary

SurveyScaleExpression()

Method Summary

Object
computeValue()
Returns a SurveyScale instance that is set up to display the values in the current row.
protected int
getFieldListParameterPosition()
int
getHighestValue()
int
getLowestValue()
Shape
getOverrideShape()
Returns the override shape.
Number
getRangeLowerBound()
Paint
getRangePaint()
Number
getRangeUpperBound()
boolean
isOverrideShapeFilled()
void
setHighestValue(int highestValue)
void
setLowestValue(int lowestValue)
void
setOverrideShape(Shape shape)
Sets the override shape.
void
setOverrideShapeFilled(boolean b)
Sets a flag that controls whether the override shape is filled or not.
void
setRangeLowerBound(Number rangeLowerBound)
void
setRangePaint(Paint rangePaint)
void
setRangeUpperBound(Number rangeUpperBound)

Methods inherited from class org.jfree.report.expressions.ColumnAggregationExpression

getFieldListParameterPosition, getFieldValues, getFieldValues

Methods inherited from class org.jfree.report.expressions.AbstractExpression

clone, getDataRow, getInstance, getName, getParentLocale, getReportConfiguration, getResourceBundleFactory, getRuntime, isDeepTraversing, isPrecompute, isPreserve, setDeepTraversing, setName, setPrecompute, setPreserve, setRuntime

Constructor Details

SurveyScaleExpression

public SurveyScaleExpression()

Method Details

computeValue

public Object computeValue()
            throws DataSourceException
Returns a SurveyScale instance that is set up to display the values in the current row.
Specified by:
computeValue in interface Expression
Returns:
a SurveyScale instance.

getFieldListParameterPosition

protected int getFieldListParameterPosition()
Overrides:
getFieldListParameterPosition in interface ColumnAggregationExpression

getHighestValue

public int getHighestValue()

getLowestValue

public int getLowestValue()

getOverrideShape

public Shape getOverrideShape()
Returns the override shape.
Returns:
The override shape (possibly null).

getRangeLowerBound

public Number getRangeLowerBound()

getRangePaint

public Paint getRangePaint()

getRangeUpperBound

public Number getRangeUpperBound()

isOverrideShapeFilled

public boolean isOverrideShapeFilled()

setHighestValue

public void setHighestValue(int highestValue)

setLowestValue

public void setLowestValue(int lowestValue)

setOverrideShape

public void setOverrideShape(Shape shape)
Sets the override shape. The SurveyScale is created with a set of default shapes, this method allows you to clearFromParent the *first* shape if you need to (leave it as null otherwise).
Parameters:
shape - the shape (null permitted).

setOverrideShapeFilled

public void setOverrideShapeFilled(boolean b)
Sets a flag that controls whether the override shape is filled or not.
Parameters:
b - the flag.

setRangeLowerBound

public void setRangeLowerBound(Number rangeLowerBound)

setRangePaint

public void setRangePaint(Paint rangePaint)

setRangeUpperBound

public void setRangeUpperBound(Number rangeUpperBound)