net.sf.jasperreports.crosstabs.fill
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

Version:

$Id: JRFillCrosstabMeasure.java 5180 2012-03-29 13:23:12Z teodord $

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

Field Summary

protected JRExtendedIncrementerFactory	incrementerFactory
protected JRCrosstabMeasure	parentMeasure
protected JRPercentageCalculator	percentageCalculator
protected JRFillVariable	variable

Constructor Summary

JRFillCrosstabMeasure(JRCrosstabMeasure measure, JRFillCrosstabObjectFactory factory)

Method Summary

java.lang.Object	clone()
JRPercentageCalculator	createPercentageCalculator()
CalculationEnum	getCalculationValue() Returns the calculation type which will be performed on the measure values.
JRFillVariable	getFillVariable()
JRExtendedIncrementerFactory	getIncrementerFactory()
java.lang.Class<?>	getIncrementerFactoryClass() Returns the incrementer factory class.
java.lang.String	getIncrementerFactoryClassName() Returns the incrementer factory class name.
java.lang.String	getName() Returns the name of the measure.
JRPercentageCalculator	getPercentageCalculator()
java.lang.Class<?>	getPercentageCalculatorClass() Returns the percentage calculator class.
java.lang.String	getPercentageCalculatorClassName() Returns the percentage calculator class name.
CrosstabPercentageEnum	getPercentageType() Returns the percentage calculation type performed on this measure.
java.lang.Class<?>	getValueClass() Returns the value class of this measure.
java.lang.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 class java.lang.Object

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

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: JRCrosstabMeasure

Returns the name of the measure.

Specified by:

getName in interface JRCrosstabMeasure

Returns:

the name of the measure

See Also:

JRCrosstabMeasure.getVariable()

getValueClassName

public java.lang.String getValueClassName()

Description copied from interface: JRCrosstabMeasure

Returns the name of the value class for this measure.

Specified by:

getValueClassName in interface JRCrosstabMeasure

Returns:

the name of the value class for this measure

getValueClass

public java.lang.Class<?> getValueClass()

Description copied from interface: JRCrosstabMeasure

Returns the value class of this measure.

Specified by:

getValueClass in interface JRCrosstabMeasure

Returns:

the value class of this measure

getValueExpression

public JRExpression getValueExpression()

Description copied from interface: JRCrosstabMeasure

Returns the measure expression.

Specified by:

getValueExpression in interface JRCrosstabMeasure

Returns:

the measure expression

getCalculationValue

public CalculationEnum getCalculationValue()

Description copied from interface: JRCrosstabMeasure

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.getCalculationValue() with the exception of CalculationEnum.SYSTEM.

Specified by:

getCalculationValue in interface JRCrosstabMeasure

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: JRCrosstabMeasure

Returns the incrementer factory class name.

Crosstab measures require extended incrementers, therefore the incrementer class should implement JRExtendedIncrementerFactory.

Specified by:

getIncrementerFactoryClassName in interface JRCrosstabMeasure

Returns:

the incrementer factory class name

getIncrementerFactoryClass

public java.lang.Class<?> getIncrementerFactoryClass()

Description copied from interface: JRCrosstabMeasure

Returns the incrementer factory class.

Specified by:

getIncrementerFactoryClass in interface JRCrosstabMeasure

Returns:

the incrementer factory class

See Also:

JRCrosstabMeasure.getIncrementerFactoryClassName()

getPercentageType

public CrosstabPercentageEnum getPercentageType()

Description copied from interface: JRCrosstabMeasure

Returns the percentage calculation type performed on this measure.

Currently, only percentage out of grand total is supported.

The possible values are:

• CrosstabPercentageEnum.NONE
• CrosstabPercentageEnum.GRAND_TOTAL

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:

getPercentageType in interface JRCrosstabMeasure

Returns:

the percentage calculation type

See Also:

JRPercentageCalculatorFactory.hasBuiltInCalculator(Class), JRCrosstabMeasure.getPercentageCalculatorClassName()

getVariable

public JRVariable getVariable()

Description copied from interface: JRCrosstabMeasure

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.

Specified by:

getVariable in interface JRCrosstabMeasure

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: JRCrosstabMeasure

Returns the percentage calculator class name.

Specified by:

getPercentageCalculatorClassName in interface JRCrosstabMeasure

Returns:

the percentage calculator class name

getPercentageCalculatorClass

public java.lang.Class<?> getPercentageCalculatorClass()

Description copied from interface: JRCrosstabMeasure

Returns the percentage calculator class.

Specified by:

getPercentageCalculatorClass in interface JRCrosstabMeasure

Returns:

the percentage calculator class

clone

public java.lang.Object clone()

Specified by:

clone in interface JRCloneable

Overrides:

clone in class java.lang.Object