org.apache.flink.table.runtime.generated

Interface AggsHandleFunction

All Superinterfaces:

org.apache.flink.api.common.functions.Function, Serializable

public interface AggsHandleFunction
extends org.apache.flink.api.common.functions.Function

The base class for handling aggregate functions.

It is code generated to handle all AggregateFunctions together in an aggregation.

It is the entry point for aggregate operators to operate all AggregateFunctions.

Method Summary

Modifier and Type	Method and Description
void	accumulate(BaseRow input) Accumulates the input values to the accumulators.
void	cleanup() Cleanup for the retired accumulators state.
void	close() Tear-down method for this function.
BaseRow	createAccumulators() Initializes the accumulators and save them to a accumulators row.
BaseRow	getAccumulators() Gets the current accumulators (saved in a row) which contains the current aggregated results.
BaseRow	getValue() Gets the result of the aggregation from the current accumulators.
void	merge(BaseRow accumulators) Merges the other accumulators into current accumulators.
void	open(StateDataViewStore store) Initialization method for the function.
void	resetAccumulators() Resets all the accumulators.
void	retract(BaseRow input) Retracts the input values from the accumulators.
void	setAccumulators(BaseRow accumulators) Set the current accumulators (saved in a row) which contains the current aggregated results.

Method Detail

open

void open(StateDataViewStore store)
   throws Exception

Initialization method for the function. It is called before the actual working methods.

Throws:

Exception

accumulate

void accumulate(BaseRow input)
         throws Exception

Accumulates the input values to the accumulators.

Parameters:

input - input values bundled in a row

Throws:

Exception

retract

void retract(BaseRow input)
      throws Exception

Retracts the input values from the accumulators.

Parameters:

input - input values bundled in a row

Throws:

Exception

merge

void merge(BaseRow accumulators)
    throws Exception

Merges the other accumulators into current accumulators.

Parameters:

accumulators - The other row of accumulators

Throws:

Exception

setAccumulators

void setAccumulators(BaseRow accumulators)
              throws Exception

Set the current accumulators (saved in a row) which contains the current aggregated results. In streaming: accumulators are store in the state, we need to restore aggregate buffers from state. In batch: accumulators are store in the hashMap, we need to restore aggregate buffers from hashMap.

Parameters:

accumulators - current accumulators

Throws:

Exception

resetAccumulators

void resetAccumulators()
                throws Exception

Resets all the accumulators.

Throws:

Exception

getAccumulators

BaseRow getAccumulators()
                 throws Exception

Gets the current accumulators (saved in a row) which contains the current aggregated results.

Returns:

the current accumulators

Throws:

Exception

createAccumulators

BaseRow createAccumulators()
                    throws Exception

Initializes the accumulators and save them to a accumulators row.

Returns:

a row of accumulators which contains the aggregated results

Throws:

Exception

getValue

BaseRow getValue()
          throws Exception

Gets the result of the aggregation from the current accumulators.

Returns:

the final result (saved in a row) of the current accumulators.

Throws:

Exception

cleanup

void cleanup()
      throws Exception

Cleanup for the retired accumulators state.

Throws:

Exception

close

void close()
    throws Exception

Tear-down method for this function. It can be used for clean up work. By default, this method does nothing.

Throws:

Exception