Class JRFillCrosstabMeasure
- java.lang.Object
-
- net.sf.jasperreports.crosstabs.fill.JRFillCrosstabMeasure
-
- All Implemented Interfaces:
java.lang.Cloneable,JRCrosstabMeasure,JRCloneable
public class JRFillCrosstabMeasure extends java.lang.Object implements JRCrosstabMeasure
- Author:
- Lucian Chirita (lucianc@users.sourceforge.net)
-
-
Field Summary
Fields Modifier and Type Field Description protected JRExtendedIncrementerFactoryincrementerFactoryprotected JRCrosstabMeasureparentMeasureprotected JRPercentageCalculatorpercentageCalculatorprotected JRFillVariablevariable
-
Constructor Summary
Constructors Constructor Description JRFillCrosstabMeasure(JRCrosstabMeasure measure, JRFillCrosstabObjectFactory factory)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Objectclone()JRPercentageCalculatorcreatePercentageCalculator()CalculationEnumgetCalculationValue()Returns the calculation type which will be performed on the measure values.JRFillVariablegetFillVariable()JRExtendedIncrementerFactorygetIncrementerFactory()java.lang.Class<?>getIncrementerFactoryClass()Returns the incrementer factory class.java.lang.StringgetIncrementerFactoryClassName()Returns the incrementer factory class name.java.lang.StringgetName()Returns the name of the measure.JRPercentageCalculatorgetPercentageCalculator()java.lang.Class<?>getPercentageCalculatorClass()Returns the percentage calculator class.java.lang.StringgetPercentageCalculatorClassName()Returns the percentage calculator class name.CrosstabPercentageEnumgetPercentageType()Returns the percentage calculation type performed on this measure.java.lang.Class<?>getValueClass()Returns the value class of this measure.java.lang.StringgetValueClassName()Returns the name of the value class for this measure.JRExpressiongetValueExpression()Returns the measure expression.JRVariablegetVariable()Returns the variable associated with this measure.
-
-
-
Field Detail
-
parentMeasure
protected JRCrosstabMeasure parentMeasure
-
variable
protected JRFillVariable variable
-
incrementerFactory
protected JRExtendedIncrementerFactory incrementerFactory
-
percentageCalculator
protected JRPercentageCalculator percentageCalculator
-
-
Constructor Detail
-
JRFillCrosstabMeasure
public JRFillCrosstabMeasure(JRCrosstabMeasure measure, JRFillCrosstabObjectFactory factory)
-
-
Method Detail
-
getName
public java.lang.String getName()
Description copied from interface:JRCrosstabMeasureReturns the name of the measure.- Specified by:
getNamein interfaceJRCrosstabMeasure- Returns:
- the name of the measure
- See Also:
JRCrosstabMeasure.getVariable()
-
getValueClassName
public java.lang.String getValueClassName()
Description copied from interface:JRCrosstabMeasureReturns the name of the value class for this measure.- Specified by:
getValueClassNamein interfaceJRCrosstabMeasure- Returns:
- the name of the value class for this measure
-
getValueClass
public java.lang.Class<?> getValueClass()
Description copied from interface:JRCrosstabMeasureReturns the value class of this measure.- Specified by:
getValueClassin interfaceJRCrosstabMeasure- Returns:
- the value class of this measure
-
getValueExpression
public JRExpression getValueExpression()
Description copied from interface:JRCrosstabMeasureReturns the measure expression.- Specified by:
getValueExpressionin interfaceJRCrosstabMeasure- Returns:
- the measure expression
-
getCalculationValue
public CalculationEnum getCalculationValue()
Description copied from interface:JRCrosstabMeasureReturns 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.getCalculationValue()with the exception ofCalculationEnum.SYSTEM.- Specified by:
getCalculationValuein interfaceJRCrosstabMeasure- Returns:
- the calculation type which will be performed on the measure values
- See Also:
JRCrosstabMeasure.getIncrementerFactoryClassName(),JRExtendedIncrementerFactory,JRExtendedIncrementer
-
getIncrementerFactoryClassName
public java.lang.String getIncrementerFactoryClassName()
Description copied from interface:JRCrosstabMeasureReturns the incrementer factory class name.Crosstab measures require extended incrementers, therefore the incrementer class should implement
JRExtendedIncrementerFactory.- Specified by:
getIncrementerFactoryClassNamein interfaceJRCrosstabMeasure- Returns:
- the incrementer factory class name
-
getIncrementerFactoryClass
public java.lang.Class<?> getIncrementerFactoryClass()
Description copied from interface:JRCrosstabMeasureReturns the incrementer factory class.- Specified by:
getIncrementerFactoryClassin interfaceJRCrosstabMeasure- Returns:
- the incrementer factory class
- See Also:
JRCrosstabMeasure.getIncrementerFactoryClassName()
-
getPercentageType
public CrosstabPercentageEnum getPercentageType()
Description copied from interface:JRCrosstabMeasureReturns 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.
- Specified by:
getPercentageTypein interfaceJRCrosstabMeasure- Returns:
- the percentage calculation type
- See Also:
JRPercentageCalculatorFactory.hasBuiltInCalculator(Class),JRCrosstabMeasure.getPercentageCalculatorClassName()
-
getVariable
public JRVariable getVariable()
Description copied from interface:JRCrosstabMeasureReturns 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.
- Specified by:
getVariablein interfaceJRCrosstabMeasure- Returns:
- the variable associated with this measure
-
getFillVariable
public JRFillVariable getFillVariable()
-
getIncrementerFactory
public JRExtendedIncrementerFactory getIncrementerFactory()
-
getPercentageCalculator
public JRPercentageCalculator getPercentageCalculator()
-
createPercentageCalculator
public JRPercentageCalculator createPercentageCalculator()
-
getPercentageCalculatorClassName
public java.lang.String getPercentageCalculatorClassName()
Description copied from interface:JRCrosstabMeasureReturns the percentage calculator class name.- Specified by:
getPercentageCalculatorClassNamein interfaceJRCrosstabMeasure- Returns:
- the percentage calculator class name
-
getPercentageCalculatorClass
public java.lang.Class<?> getPercentageCalculatorClass()
Description copied from interface:JRCrosstabMeasureReturns the percentage calculator class.- Specified by:
getPercentageCalculatorClassin interfaceJRCrosstabMeasure- Returns:
- the percentage calculator class
-
clone
public java.lang.Object clone()
- Specified by:
clonein interfaceJRCloneable- Overrides:
clonein classjava.lang.Object
-
-