Package net.sf.jasperreports.crosstabs.fill.calculation

Class MeasureDefinition.MeasureValue

java.lang.Object

net.sf.jasperreports.crosstabs.fill.calculation.MeasureDefinition.MeasureValue

All Implemented Interfaces:

JRCalculable

Enclosing class:

MeasureDefinition

public class MeasureDefinition.MeasureValue
extends Object
implements JRCalculable

An accumulated value of a crosstab measure.

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

Field Summary

Fields inherited from interface net.sf.jasperreports.engine.fill.JRCalculable

HELPER_COUNT, HELPER_SIZE, HELPER_SUM, HELPER_VARIANCE

Constructor Summary

Constructors

Constructor	Description
MeasureValue()	Initializes the value.

Method Summary

Modifier and Type	Method	Description
void	addValue(Object addValue)	Accumulates a value.
void	addValue(MeasureDefinition.MeasureValue measureValue)	Accumulates another measure value.
JRCalculable	getHelperVariable(byte helperType)	Returns a helper variable.
Object	getIncrementedValue()	Returns the incremented value of the calculable object.
Object	getValue()	Returns the value of the calculable object.
protected void	init()
boolean	isInitialized()	Returns true if and only if the calculable object was only initialized and not incremented.
MeasureDefinition.MeasureValue	setHelper(MeasureDefinition.MeasureValue helperVariable, byte type)	Sets a helper variable.
void	setInitialized(boolean isInitialized)	Sets the initialized flag for this calculable object.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MeasureValue

public MeasureValue()

Initializes the value.

Method Detail

init

protected void init()

addValue

public void addValue(Object addValue)
              throws JRException

Accumulates a value.

Parameters:

addValue - the value

Throws:

JRException

addValue

public void addValue(MeasureDefinition.MeasureValue measureValue)
              throws JRException

Accumulates another measure value.

This is used for total calculations, when two accumulated values are combined into a total.

Parameters:

measureValue - the measure value

Throws:

JRException

getValue

public Object getValue()

Description copied from interface: JRCalculable

Returns the value of the calculable object.

Specified by:

getValue in interface JRCalculable

Returns:

the value

toString

public String toString()

Overrides:

toString in class Object

setHelper

public MeasureDefinition.MeasureValue setHelper(MeasureDefinition.MeasureValue helperVariable,
                                                byte type)

Sets a helper variable.

Parameters:

helperVariable - the helper variable

type - the helper type

Returns:

the previous helper variable for the type

isInitialized

public boolean isInitialized()

Description copied from interface: JRCalculable

Returns true if and only if the calculable object was only initialized and not incremented.

Specified by:

isInitialized in interface JRCalculable

Returns:

true if and only if the calculable object was only initialized and not incremented

getIncrementedValue

public Object getIncrementedValue()

Description copied from interface: JRCalculable

Returns the incremented value of the calculable object.

Specified by:

getIncrementedValue in interface JRCalculable

Returns:

the incremented value

getHelperVariable

public JRCalculable getHelperVariable(byte helperType)

Description copied from interface: JRCalculable

Returns a helper variable.

Specified by:

getHelperVariable in interface JRCalculable

Parameters:

helperType - the desired helper variable type

Returns:

the helper variable

setInitialized

public void setInitialized(boolean isInitialized)

Description copied from interface: JRCalculable

Sets the initialized flag for this calculable object.

Specified by:

setInitialized in interface JRCalculable

Parameters:

isInitialized - the initialized flag

See Also:

JRCalculable.isInitialized()