Package org.teiid.query.function.aggregate

Class UserDefined

java.lang.Object

org.teiid.query.function.aggregate.AggregateFunction

org.teiid.query.function.aggregate.UserDefined

public class UserDefined
extends AggregateFunction

Field Summary

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

argIndexes

Constructor Summary

Constructors

Constructor	Description
UserDefined(FunctionDescriptor functionDescriptor)

Method Summary

Modifier and Type	Method	Description
void	addInputDirect(List<?> tuple, CommandContext commandContext)	Called for the element value in every row of a group.
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	reset()	Called to reset the state of the function.
boolean	respectsNull()
int	setState(List<?> state, int index)

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

addInput, filter, getArgIndexes, getOutputType, initialize, setArgIndexes, setConditionIndex

Methods inherited from class java.lang.Object

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

Constructor Detail

UserDefined

public UserDefined(FunctionDescriptor functionDescriptor)
            throws FunctionExecutionException

Throws:

FunctionExecutionException

Method Detail

addInputDirect

public void addInputDirect(List<?> tuple,
                           CommandContext commandContext)
                    throws TeiidComponentException,
                           TeiidProcessingException

Description copied from class: AggregateFunction

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

Specified by:

addInputDirect in class AggregateFunction

Throws:

TeiidProcessingException

TeiidComponentException

reset

public void reset()

Description copied from class: AggregateFunction

Called to reset the state of the function.

Specified by:

reset in class AggregateFunction

getResult

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

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:

TeiidProcessingException

FunctionExecutionException

ExpressionEvaluationException

TeiidComponentException

respectsNull

public boolean respectsNull()

Overrides:

respectsNull in class AggregateFunction

getStateTypes

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

Overrides:

getStateTypes in class AggregateFunction

getState

public void getState(List<Object> state)

Overrides:

getState in class AggregateFunction

setState

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

Overrides:

setState in class AggregateFunction