planetj.database.report
Class ColumnAverage

java.lang.Object
  planetj.database.report.ColumnFunction
      planetj.database.report.ColumnAverage

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class ColumnAverage

extends ColumnFunction

The column averaging function

See Also:

Serialized Form

Constructor Summary

protected	ColumnAverage() ColumnAverage constructor
protected	ColumnAverage(java.lang.String pFunctionToken) ColumnAverage constructor comment.

Method Summary

void	clear() Clears all the previously processed values from the column function
java.lang.Object	getValue() Gets the current value of the column function
void	processValue(java.lang.Object pValue) Inputs a new value to the column function
void	set(ColumnFunction cf) Sets the internal state of this ColumnFunction to be the same as the state of another ColumnFunction.

Methods inherited from class planetj.database.report.ColumnFunction

clone, cloneColumnFunction, getColumnFunction, getFieldName, getFunctionToken, getPrecision, processRow, setFieldName, setFunctionToken, setPrecision

Methods inherited from class java.lang.Object

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

Constructor Detail

ColumnAverage

protected ColumnAverage()

ColumnAverage constructor

ColumnAverage

protected ColumnAverage(java.lang.String pFunctionToken)

ColumnAverage constructor comment.

Parameters:

pFunctionToken - java.lang.String

Method Detail

clear

public void clear()

Clears all the previously processed values from the column function

Specified by:

clear in class ColumnFunction

getValue

public java.lang.Object getValue()

Gets the current value of the column function

Specified by:

getValue in class ColumnFunction

processValue

public void processValue(java.lang.Object pValue)
                  throws DataEngineException

Inputs a new value to the column function

Specified by:

processValue in class ColumnFunction

Throws:

DataEngineException

set

public void set(ColumnFunction cf)

Sets the internal state of this ColumnFunction to be the same as the state of another ColumnFunction. Only this ColumnFunction is altered, the ColumnFunction passed in as an argument is not changed.

Specified by:

set in class ColumnFunction

Parameters:

cf - A ColumnFunction, which must be compatible with this column function and which will be used to set the internal state of this ColumnFunction