com.goldencode.p2j.util

Class TotalAccumulator.Data

java.lang.Object

com.goldencode.p2j.util.TotalAccumulator.Data

All Implemented Interfaces:

Accumulator.DataBundle, Undoable

Enclosing class:

TotalAccumulator

private class TotalAccumulator.Data
extends java.lang.Object
implements Accumulator.DataBundle

A DataBundle implementation which calculates a running total, and returns it upon request.

Field Summary

Fields

Modifier and Type	Field and Description
private decimal	total Running total

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Data() Construct an instance of this class, setting the starting total to either unknown value or 0, depending upon whether the enclosing accumulator is initialized for use.

Method Summary

Modifier and Type	Method and Description
void	accumulate(BaseDataType datum) Add the numeric value of datum to the running total.
void	assign(Undoable value) Sets the state of this instance based on the state of the passed instance.
BaseDataType	calculate() Return the current, running total.
Undoable	deepCopy() This is a form of a copy constructor that makes a deep copy of the current instance and returns this copy as a new instance of the same class.
void	reset() Reset (to zero) the total variable, in preparation for beginning a new break group.

Methods inherited from class java.lang.Object

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

Field Detail

total

private decimal total

Running total

Constructor Detail

Data

private Data()

Construct an instance of this class, setting the starting total to either unknown value or 0, depending upon whether the enclosing accumulator is initialized for use.

Method Detail

reset

public void reset()

Reset (to zero) the total variable, in preparation for beginning a new break group.

Specified by:

reset in interface Accumulator.DataBundle

accumulate

public void accumulate(BaseDataType datum)

Add the numeric value of datum to the running total.

Specified by:

accumulate in interface Accumulator.DataBundle

Parameters:

datum - Datum to be accumulated; it is expected that this is a numeric type. If this is unknown then the accumulated total will be unknown.

Throws:

java.lang.ClassCastException - if datum cannot be cast to NumberType.

calculate

public BaseDataType calculate()

Return the current, running total.

Specified by:

calculate in interface Accumulator.DataBundle

Returns:

Current total value (zero if no accumulate(com.goldencode.p2j.util.BaseDataType) ever occurred).

deepCopy

public Undoable deepCopy()

This is a form of a copy constructor that makes a deep copy of the current instance and returns this copy as a new instance of the same class.

Specified by:

deepCopy in interface Undoable

Returns:

An instance of the same class whose data is identical to that of this instance.

assign

public void assign(Undoable value)

Sets the state of this instance based on the state of the passed instance.

Specified by:

assign in interface Undoable

Parameters:

value - The instance from which to copy state.