org.teiid.query.function.aggregate
Class StatsFunction

java.lang.Object
  org.teiid.query.function.aggregate.AggregateFunction
      org.teiid.query.function.aggregate.StatsFunction

public class StatsFunction
extends AggregateFunction

Constructor Summary

StatsFunction(AggregateSymbol.Type function)

Method Summary

void	addInputDirect(java.lang.Object input, java.util.List<?> tuple) Called for the element value in every row of a group.
java.lang.Object	getResult() Called after all values have been processed to get the result.
void	reset() Called to reset the state of the function.

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

addInput, initialize, setExpressionIndex

Methods inherited from class java.lang.Object

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

Constructor Detail

StatsFunction

public StatsFunction(AggregateSymbol.Type function)

Method Detail

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(java.lang.Object input,
                           java.util.List<?> tuple)
                    throws FunctionExecutionException,
                           ExpressionEvaluationException,
                           TeiidComponentException

Description copied from class: AggregateFunction

Called for the element value in every row of a group.

Specified by:

addInputDirect in class AggregateFunction

Parameters:

input - Input value, may be null

Throws:

FunctionExecutionException

ExpressionEvaluationException

TeiidComponentException

getResult

public java.lang.Object getResult()
                           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