org.apache.flink.table.runtime.functions.aggregate

Class FirstValueWithRetractAggFunction<T>

java.lang.Object

org.apache.flink.table.functions.UserDefinedFunction

org.apache.flink.table.functions.ImperativeAggregateFunction<T,ACC>

org.apache.flink.table.functions.AggregateFunction<T,ACC>

org.apache.flink.table.runtime.functions.aggregate.BuiltInAggregateFunction<T,FirstValueWithRetractAggFunction.FirstValueWithRetractAccumulator<T>>

org.apache.flink.table.runtime.functions.aggregate.FirstValueWithRetractAggFunction<T>

All Implemented Interfaces:

Serializable, FunctionDefinition

@Internal
public final class FirstValueWithRetractAggFunction<T>
extends BuiltInAggregateFunction<T,FirstValueWithRetractAggFunction.FirstValueWithRetractAccumulator<T>>

Built-in FIRST_VALUE with retraction aggregate function.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FirstValueWithRetractAggFunction.FirstValueWithRetractAccumulator<T> Accumulator for FIRST_VALUE.

Constructor Summary

Constructors

Constructor and Description
FirstValueWithRetractAggFunction(LogicalType valueType)

Method Summary

Modifier and Type	Method and Description
void	accumulate(FirstValueWithRetractAggFunction.FirstValueWithRetractAccumulator<T> acc, Object value)
void	accumulate(FirstValueWithRetractAggFunction.FirstValueWithRetractAccumulator<T> acc, Object value, Long order)
void	accumulate(FirstValueWithRetractAggFunction.FirstValueWithRetractAccumulator<T> acc, StringData value)
void	accumulate(FirstValueWithRetractAggFunction.FirstValueWithRetractAccumulator<T> acc, StringData value, Long order)
FirstValueWithRetractAggFunction.FirstValueWithRetractAccumulator<T>	createAccumulator() Creates and initializes the accumulator for this ImperativeAggregateFunction.
DataType	getAccumulatorDataType()
List<DataType>	getArgumentDataTypes()
DataType	getOutputDataType()
T	getValue(FirstValueWithRetractAggFunction.FirstValueWithRetractAccumulator<T> acc) Called every time when an aggregation result should be materialized.
void	resetAccumulator(FirstValueWithRetractAggFunction.FirstValueWithRetractAccumulator<T> acc)
void	retract(FirstValueWithRetractAggFunction.FirstValueWithRetractAccumulator<T> acc, Object value)
void	retract(FirstValueWithRetractAggFunction.FirstValueWithRetractAccumulator<T> acc, Object value, Long order)

Methods inherited from class org.apache.flink.table.runtime.functions.aggregate.BuiltInAggregateFunction

getRequirements, getTypeInference, isDeterministic

Methods inherited from class org.apache.flink.table.functions.AggregateFunction

getKind

Methods inherited from class org.apache.flink.table.functions.ImperativeAggregateFunction

getAccumulatorType, getResultType

Methods inherited from class org.apache.flink.table.functions.UserDefinedFunction

close, functionIdentifier, open, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.table.functions.FunctionDefinition

supportsConstantFolding

Constructor Detail

FirstValueWithRetractAggFunction

public FirstValueWithRetractAggFunction(LogicalType valueType)

Method Detail

getArgumentDataTypes

public List<DataType> getArgumentDataTypes()

Overrides:

getArgumentDataTypes in class BuiltInAggregateFunction<T,FirstValueWithRetractAggFunction.FirstValueWithRetractAccumulator<T>>

getAccumulatorDataType

public DataType getAccumulatorDataType()

Overrides:

getAccumulatorDataType in class BuiltInAggregateFunction<T,FirstValueWithRetractAggFunction.FirstValueWithRetractAccumulator<T>>

getOutputDataType

public DataType getOutputDataType()

Overrides:

getOutputDataType in class BuiltInAggregateFunction<T,FirstValueWithRetractAggFunction.FirstValueWithRetractAccumulator<T>>

createAccumulator

public FirstValueWithRetractAggFunction.FirstValueWithRetractAccumulator<T> createAccumulator()

Description copied from class: ImperativeAggregateFunction

Creates and initializes the accumulator for this ImperativeAggregateFunction.

The accumulator is an intermediate data structure that stores the aggregated values until a final aggregation result is computed.

Specified by:

createAccumulator in class ImperativeAggregateFunction<T,FirstValueWithRetractAggFunction.FirstValueWithRetractAccumulator<T>>

Returns:

the accumulator with the initial value

accumulate

public void accumulate(FirstValueWithRetractAggFunction.FirstValueWithRetractAccumulator<T> acc,
                       Object value)
                throws Exception

Throws:

Exception

accumulate

public void accumulate(FirstValueWithRetractAggFunction.FirstValueWithRetractAccumulator<T> acc,
                       Object value,
                       Long order)
                throws Exception

Throws:

Exception

accumulate

public void accumulate(FirstValueWithRetractAggFunction.FirstValueWithRetractAccumulator<T> acc,
                       StringData value)
                throws Exception

Throws:

Exception

accumulate

public void accumulate(FirstValueWithRetractAggFunction.FirstValueWithRetractAccumulator<T> acc,
                       StringData value,
                       Long order)
                throws Exception

Throws:

Exception

retract

public void retract(FirstValueWithRetractAggFunction.FirstValueWithRetractAccumulator<T> acc,
                    Object value)
             throws Exception

Throws:

Exception

retract

public void retract(FirstValueWithRetractAggFunction.FirstValueWithRetractAccumulator<T> acc,
                    Object value,
                    Long order)
             throws Exception

Throws:

Exception

resetAccumulator

public void resetAccumulator(FirstValueWithRetractAggFunction.FirstValueWithRetractAccumulator<T> acc)

getValue

public T getValue(FirstValueWithRetractAggFunction.FirstValueWithRetractAccumulator<T> acc)

Description copied from class: AggregateFunction

Called every time when an aggregation result should be materialized. The returned value could be either an early and incomplete result (periodically emitted as data arrives) or the final result of the aggregation.

Specified by:

getValue in class AggregateFunction<T,FirstValueWithRetractAggFunction.FirstValueWithRetractAccumulator<T>>

Parameters:

acc - the accumulator which contains the current intermediate results

Returns:

the aggregation result