org.teiid.query.function.aggregate

Class Sum

java.lang.Object

org.teiid.query.function.aggregate.AggregateFunction

org.teiid.query.function.aggregate.SingleArgumentAggregateFunction

org.teiid.query.function.aggregate.Sum

Direct Known Subclasses:

Avg

public class Sum
extends SingleArgumentAggregateFunction

Accumulates (per tuple) and calculates the sum of the values of a column. The type of the result varies depending on the type of the input AggregateSymbol

Field Summary

Fields

Modifier and Type	Field and Description
protected int	accumulatorType
protected static int	BIG_DECIMAL
protected static int	BIG_INTEGER
protected static int	DOUBLE
protected static int	LONG

Fields inherited from class org.teiid.query.function.aggregate.AggregateFunction

argIndexes

Constructor Summary

Constructors

Constructor and Description
Sum()

Method Summary

Modifier and Type	Method and Description
void	addInputDirect(Object input, List<?> tuple, CommandContext commandContext)
protected int	getAccumulatorType() Allows subclasses to determine type of accumulator for the SUM.
Object	getResult(CommandContext commandContext) Called after all values have been processed to get the result.
void	getState(List<Object> state)
List<? extends Class<?>>	getStateTypes()
void	initialize(Class<?> dataType, Class<?> inputType)
void	reset() Called to reset the state of the function.
int	setState(List<?> state, int index)

Methods inherited from class org.teiid.query.function.aggregate.SingleArgumentAggregateFunction

addInputDirect, initialize

Methods inherited from class org.teiid.query.function.aggregate.AggregateFunction

addInput, filter, getArgIndexes, respectsNull, setArgIndexes, setConditionIndex

Methods inherited from class java.lang.Object

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

Field Detail

LONG

protected static final int LONG

See Also:

Constant Field Values

DOUBLE

protected static final int DOUBLE

See Also:

Constant Field Values

BIG_INTEGER

protected static final int BIG_INTEGER

See Also:

Constant Field Values

BIG_DECIMAL

protected static final int BIG_DECIMAL

See Also:

Constant Field Values

accumulatorType

protected int accumulatorType

Constructor Detail

Sum

public Sum()

Method Detail

getAccumulatorType

protected int getAccumulatorType()

Allows subclasses to determine type of accumulator for the SUM.

Returns:

Type, as defined in constants

initialize

public void initialize(Class<?> dataType,
                       Class<?> inputType)

Overrides:

initialize in class SingleArgumentAggregateFunction

See Also:

org.teiid.query.function.aggregate.AggregateFunction#initialize(boolean, String)

reset

public void reset()

Description copied from class: AggregateFunction

Called to reset the state of the function.

Specified by:

reset in class AggregateFunction

addInputDirect

public void addInputDirect(Object input,
                           List<?> tuple,
                           CommandContext commandContext)
                    throws FunctionExecutionException,
                           ExpressionEvaluationException,
                           TeiidComponentException

Specified by:

addInputDirect in class SingleArgumentAggregateFunction

Throws:

FunctionExecutionException

ExpressionEvaluationException

TeiidComponentException

See Also:

org.teiid.query.function.aggregate.AggregateFunction#addInputDirect(List, CommandContext, CommandContext)

getResult

public Object getResult(CommandContext commandContext)
                 throws FunctionExecutionException,
                        ExpressionEvaluationException,
                        TeiidComponentException

Description copied from class: AggregateFunction

Called after all values have been processed to get the result.

Specified by:

getResult in class AggregateFunction

Returns:

Result value

Throws:

FunctionExecutionException

ExpressionEvaluationException

TeiidComponentException

See Also:

AggregateFunction.getResult(CommandContext)

getState

public void getState(List<Object> state)

Overrides:

getState in class AggregateFunction

getStateTypes

public List<? extends Class<?>> getStateTypes()

Overrides:

getStateTypes in class AggregateFunction

setState

public int setState(List<?> state,
                    int index)

Overrides:

setState in class AggregateFunction