Interface JRCrosstabMeasure
-
- All Superinterfaces:
Cloneable
,JRCloneable
- All Known Implementing Classes:
JRBaseCrosstabMeasure
,JRDesignCrosstabMeasure
,JRFillCrosstabMeasure
public interface JRCrosstabMeasure extends JRCloneable
Crosstab measure interface.A measure is a value that is accumulated by the crosstab and is displayed in the crosstab cells.
- Author:
- Lucian Chirita (lucianc@users.sourceforge.net)
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CalculationEnum
getCalculation()
Returns the calculation type which will be performed on the measure values.Class<?>
getIncrementerFactoryClass()
Returns the incrementer factory class.String
getIncrementerFactoryClassName()
Returns the incrementer factory class name.String
getName()
Returns the name of the measure.Class<?>
getPercentageCalculatorClass()
Returns the percentage calculator class.String
getPercentageCalculatorClassName()
Returns the percentage calculator class name.CrosstabPercentageEnum
getPercentageType()
Returns the percentage calculation type performed on this measure.Class<?>
getValueClass()
Returns the value class of this measure.String
getValueClassName()
Returns the name of the value class for this measure.JRExpression
getValueExpression()
Returns the measure expression.JRVariable
getVariable()
Returns the variable associated with this measure.-
Methods inherited from interface net.sf.jasperreports.engine.JRCloneable
clone
-
-
-
-
Method Detail
-
getName
String getName()
Returns the name of the measure.- Returns:
- the name of the measure
- See Also:
getVariable()
-
getValueClassName
String getValueClassName()
Returns the name of the value class for this measure.- Returns:
- the name of the value class for this measure
-
getValueClass
Class<?> getValueClass()
Returns the value class of this measure.- Returns:
- the value class of this measure
-
getValueExpression
JRExpression getValueExpression()
Returns the measure expression.- Returns:
- the measure expression
-
getCalculation
CalculationEnum getCalculation()
Returns the calculation type which will be performed on the measure values.The incrementer factory associated with this measure will create an incrementer which will sum the measure values.
The possible calculation type are the same as the ones used for variables (see
JRVariable.getCalculation()
with the exception ofCalculationEnum.SYSTEM
.- Returns:
- the calculation type which will be performed on the measure values
- See Also:
getIncrementerFactoryClassName()
,JRExtendedIncrementerFactory
,JRExtendedIncrementer
-
getIncrementerFactoryClassName
String getIncrementerFactoryClassName()
Returns the incrementer factory class name.Crosstab measures require extended incrementers, therefore the incrementer class should implement
JRExtendedIncrementerFactory
.- Returns:
- the incrementer factory class name
-
getIncrementerFactoryClass
Class<?> getIncrementerFactoryClass()
Returns the incrementer factory class.- Returns:
- the incrementer factory class
- See Also:
getIncrementerFactoryClassName()
-
getPercentageType
CrosstabPercentageEnum getPercentageType()
Returns the percentage calculation type performed on this measure.Currently, only percentage out of grand total is supported.
The possible values are:
If percentage calculation is required, the value class should be one of the built-in supported percentage types or the percentage calculator class should be specified.
- Returns:
- the percentage calculation type
- See Also:
JRPercentageCalculatorFactory.hasBuiltInCalculator(Class)
,getPercentageCalculatorClassName()
-
getPercentageCalculatorClassName
String getPercentageCalculatorClassName()
Returns the percentage calculator class name.- Returns:
- the percentage calculator class name
-
getPercentageCalculatorClass
Class<?> getPercentageCalculatorClass()
Returns the percentage calculator class.- Returns:
- the percentage calculator class
-
getVariable
JRVariable getVariable()
Returns the variable associated with this measure.The variable can be used inside the crosstab data cells as the measure value. The variable has the same name and value class as the measure.
- Returns:
- the variable associated with this measure
-
-